put
/channels/{channel_id}/voice-debug-logging/sessionToggle voice debug logging
Allows staff to start or stop a channel-scoped voice debug logging session. Non-staff users cannot activate or stop sessions.
set_voice_debug_logging_status
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| channel_id* | path | SnowflakeType | The ID of the channel |
Request body
application/json
json
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether voice debug logging should be active for this channel"
},
"duration_ms": {
"type": "integer",
"minimum": 60000,
"maximum": 14400000,
"format": "int32",
"description": "Optional activation duration in milliseconds. Defaults to one hour and is capped at four hours."
}
},
"required": [
"enabled"
]
}Responses
200
Success
json
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"description": "Whether clients in this channel should currently send voice diagnostics"
},
"session_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Current debug logging session id, if active"
},
"activated_by_user_id": {
"anyOf": [
{
"$ref": "#/components/schemas/SnowflakeType"
},
{
"type": "null"
}
],
"description": "Staff user that activated the session, if active"
},
"started_at_ms": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"format": "int53"
},
{
"type": "null"
}
],
"description": "Session start Unix timestamp in milliseconds"
},
"expires_at_ms": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"format": "int53"
},
{
"type": "null"
}
],
"description": "Session expiration Unix timestamp in milliseconds"
},
"poll_interval_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
"format": "int32",
"description": "Recommended client polling interval in milliseconds"
},
"upload_interval_ms": {
"type": "integer",
"minimum": 0,
"maximum": 2147483647,
"format": "int32",
"description": "Recommended client telemetry batch upload interval in milliseconds"
}
},
"required": [
"active",
"session_id",
"activated_by_user_id",
"started_at_ms",
"expires_at_ms",
"poll_interval_ms",
"upload_interval_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"
]
}