调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AccessChannelId | string | 是 | 网络业务渠道 ID。 | cf584733-***-***-9699-cb77aa3b7aa6 |
ConversationId | string | 是 | 会话 id | d165de4f-9851-445e-9535-66ebfa72fa51 |
SenderId | string | 是 | 消息发送者用户 ID。 | 63061274befd6b545aab4c83 |
SenderName | string | 否 | 发送者名称。 | tom |
RequestId | string | 否 | 请求 ID | 03C67DAD-EB26-41D8-949D-9B0C470FB716 |
InstanceId | string | 是 | 实例 ID。 | 9cfad875-6260-4a53-ab6e-b13e3fb31f7d |
SenderAvatarMediaId | string | 否 | 头像 id | xxxx |
MessageContent | string | 是 | 消息内容 | 消息内容,格式如下: 文本消息: { "contentType":"Text", "text":"你好 " } 图片消息: { "contentType":"Image", "mediaId": "xxx-xxx-xxx", "fileType": "png", "fileSize": 1233 } 视频消息: { "contentType":"Video", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233, } 音频消息: { "contentType":"Audio", "mediaId": "xxx-xxx-xxx" "duration": 12, "fileSize": 1233 } 文件消息: { "contentType":"File", "mediaId": "xxx-xxx-xxx", "fileSize": 223232, "filename": "xyz. zip" } |
返回参数
示例
正常返回示例
JSON
格式
{
"JobId": "chat-65382141036853491",
"RequestId": "2778FA12-EDD6-42AA-9B15-AF855072E5E5",
"HttpStatusCode": 200,
"Code": "OK",
"Message": "无",
"Params": [
"['OFFLINE', 'BREAK,READY,WORKING']"
],
"Data": "无"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
访问错误中心查看更多错误码。