声网实时消息回调(API名称:agoraMsgCallback)
功能介绍
仅供声网订阅,用于实时消息回调
相关接口
接口名称 |
调用说明 |
---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 |
HTTPS地址 |
服务架构 |
消息体类型 |
---|---|---|---|
POST |
https://isdp+域名/openapi/v1/metering/agoraMsgCallback |
OpenAPI |
application/json |
请求头
KEY |
VALUE |
是否必填 |
描述 |
---|---|---|---|
Content-Type |
application/json |
是 |
无 |
Authorization |
bearer ${access_token} |
是 |
bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
eventType |
Int |
是 |
事件类型 |
noticeId |
String |
是 |
消息ID |
notifyMs |
Int |
是 |
消息信息 |
payload |
String |
否 |
有效载荷 |
productId |
String |
否 |
产品ID |
payload参数
参数 |
类型 |
是否必填 |
描述 |
---|---|---|---|
channelName |
Int |
否 |
通道名称 |
ts |
String |
否 |
通知信息 |
响应参数
字段名 |
数据类型 |
描述 |
status |
int |
返回状态:0-成功;1-失败 |
message |
String |
返回的失败消息。 |
请求示例
{ "eventType": 101, "noticeId": "2003239619:606959:105", "notifyMs": 1614335577167, "payload": { "channelName": "test_webhook", "ts": 1560396834 }, "productId": 1 }
响应示例
{ "status": 1, "message": "SUCCESS", "error": null, "data": null, "timestamp": "2021-03-26T14:10:39.628+0800" }