本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
异步消息接收
所有响应消息都作为事件异步传递给接收方(例如,SDP 提议或 SDP 应答传递)。以下是事件消息结构。
事件
{ "senderClientId": "string", "messageType": "string", "messagePayload": "string", "statusResponse": { "correlationId": "string", "errorType": "string", "statusCode": "string", "description": "string" } }
-
senderClientId-发件人客户端的唯一标识符。
-
类型:字符串
-
长度限制:最小长度为 1。最大长度为 256。
-
模式:
[a-zA-Z0-9_.-]+
-
必需:否
-
-
messageType - -事件的类型。
-
类型:ENUM
-
有效类型:
SDP_OFFER
、SDP_ANSWER
、ICE_CANDIDATE
、GO_AWAY
、RECONNECT_ICE_SERVER
、STATUS_RESPONSE
-
长度限制:最小长度为 1。最大长度为 256。
-
模式:
[a-zA-Z0-9_.-]+
-
必需:是
-
-
messagePayload - 以 base-64 编码的消息内容。
-
类型:字符串
-
长度限制:最小长度为 1。最大长度为 10K。
-
必需:否
-
-
correlationId - 状态所指的消息的唯一标识符。这是客户端消息(例如,SDP 提议、SDP 应答或 ICE 候选项)中提供的相同 correlationId。
-
类型:字符串
-
长度限制:最小长度为 1。最大长度为 256。
-
模式:
[a-zA-Z0-9_.-]+
-
必需:是
-
-
errorType - 用于唯一标识错误的名称。
-
类型:字符串
-
长度限制:最小长度为 1。最大长度为 256。
-
模式:
[a-zA-Z0-9_.-]+
-
必需:否
-
-
statusCode - 与响应的性质相对应的 HTTP 状态代码。
-
类型:字符串
-
长度限制:最小长度为 1。最大长度为 256。
-
模式:
[a-zA-Z0-9_.-]+
-
必需:否
-
-
description - 解释状态的字符串描述。
-
类型:字符串
-
长度限制:最小长度为 1。最大长度为 1K。
-
必需:否
-