GET /ccmessaging/poll
场景描述
用户侧接收消息(轮询)。
如果使用该接口未查到消息,请确认是否使用了send接口建立连接(connect)。
接口方法
GET
接口URI
https://域名/apiaccess/ccmessaging/poll,例如域名是service.besclouds.com
请求说明
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
receiverId |
string |
False |
接收者Id,即applyToken里面的userId。 |
2 |
channel |
string |
False |
接收者渠道类型,当前固定为WEB。 |
序号 |
名称 |
参数类型 |
是否必选 |
说明 |
---|---|---|---|---|
1 |
ccmessaging-token |
string |
True |
|
2 |
x-app-key |
string |
True |
appKey字段,用户标识,请联系运营人员获取appKey |
3 |
Authorization |
string |
True |
鉴权字段,内容格式为:Bearer +tokenByAKSK接口的返回值中AccessToken(Bearer后有空格) |
响应说明
- 响应状态码: 200
- 响应状态码: 400
错误的请求:请检查请求路径及参数。
- 响应状态码: 401
未授权:1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。
- 响应状态码: 404
请求的内容未找到:请检查请求的路径。
- 响应状态码: 500
业务失败:请依次确认您请求中各参数的取值。
错误码
无。
报文样例
- 场景描述:样例报文
URL:Domain Address/apiaccess/ccmessaging/poll?receiverId=XXXXXXXXXXXXXXXXXXXXXXXX&channel=WEB
请求头:
{ "X-APP-Key": "xxxxxxxxxxxxxxxxxxxxx", "Authorization": "Bearer xxxxxxxxxxxxxxxxxxxxx", "ccmessaging-token": "xxxxxxxxxxxxxxxxxxxxx" }
响应参数:
{ "resultCode": "0", "resultDesc": "query user messages success.", "downlinkMessages": [ { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "欢迎欢迎,热列欢迎", "simQuestions": null, "senderNickname": "test", "senderAvatar": "1", "timestamp": 1619590480756, "sourceType": "ROBOT", "callId": null, "robotGender": "MALE" }, { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "转人工", "simQuestions": null, "senderNickname": "test", "senderAvatar": "1", "timestamp": 1619590482098, "sourceType": "ROBOT", "callId": null, "robotGender": "MALE" }, { "from": "1011577355744904195", "channel": "WEB", "to": "session_fixed_user_fixed", "controlType": "CHAT", "mediaType": "TEXT", "content": "已接通座席。", "simQuestions": null, "senderNickname": "系统", "senderAvatar": null, "timestamp": 1619590484115, "sourceType": "SYSTEM", "callId": null, "robotGender": null } ] }