post/channels/{channel_id}/voice-presence/heartbeat

Heartbeat voice presence

Refreshes the current user voice presence marker for v2 voice reconciliation. Clients call this while connected to voice.

heartbeat_voice_presence

Parameters

Name	In	Type	Description
channel_id*	path	SnowflakeType	The ID of the channel

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "connection_id": {
      "type": "string",
      "description": "Client voice connection id"
    }
  },
  "required": [
    "connection_id"
  ]
}

Responses

200

Success

json

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the heartbeat was accepted"
    },
    "heartbeat_interval_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647,
      "format": "int32",
      "description": "Recommended client heartbeat interval in milliseconds"
    },
    "heartbeat_ttl_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647,
      "format": "int32",
      "description": "Server-side heartbeat expiration window in milliseconds"
    },
    "expires_at_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991,
      "format": "int53",
      "description": "Unix timestamp in milliseconds when this heartbeat expires"
    }
  },
  "required": [
    "ok",
    "heartbeat_interval_ms",
    "heartbeat_ttl_ms",
    "expires_at_ms"
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

401

Unauthorized - Authentication is required or the token is invalid

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

403

Forbidden - You do not have permission to perform this action

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "RATE_LIMITED"
      ]
    },
    "message": {
      "type": "string"
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message",
    "retry_after"
  ]
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "$ref": "#/components/schemas/APIErrorCode"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "type": "array",
      "description": "Field-specific validation errors",
      "items": {
        "$ref": "#/components/schemas/ValidationErrorItem"
      }
    }
  },
  "required": [
    "code",
    "message"
  ]
}