Skip to main content

index/interfaces/ChatStatusResponse.md

Chat status response from GET /live/:tokenName/chat/status

Since​

5.1.0 - Added reason field based on backend review

Since​

5.4.0 - Added status field for detailed feature status

Properties​

PropertyTypeDescription
enabledbooleanWhether chat is enabled (computed from status)
reason?ChatDisabledReasonReason why chat is disabled (only present when enabled=false) - 'global': Chat is disabled globally for all tokens - 'token': Chat is disabled specifically for this token
slowModeSeconds?numberSlow-mode interval in seconds (0 when off), from GET /live/:tokenName/chat Since 9.0.0
status?FeatureStatusTypeDetailed feature status (v5.4.0+) - 'ENABLED': Chat is on - 'DISABLED': Owner disabled (owner can re-enable) - 'ADMIN_DISABLED': Admin disabled (owner locked out)
tokenName?stringToken name (lowercased); answered by the SDK's chat status methods