事件回调api
<h1>事件回调API</h1>
<h2>请求信息</h2>
<h3>请求地址</h3>
<pre><code>https://test-cms-admin.jindashi.cn/mcn/callback/event</code></pre>
<h3>请求方法</h3>
<pre><code>POST</code></pre>
<h3>请求体类型</h3>
<pre><code>applicatin/json</code></pre>
<h3>事件说明</h3>
<pre><code>GET_ACCOUNT_INFO:获取播主信息
CANCEL_SUBSCRIBE_ACCOUNT:播主取消关注
GET_ACCOUNT_LIVE_STATUS:获取播主信息
GET_ACCOUNT_LIVE_DATA:获取播主直播数据
GET_ACCOUNT_VIDEO_LIST:获取播主视频列表
REPORT_DEVICE_STATUS:上报设备状态
GET_ACCOUNT_SIMPLE_VIDEO:播主单视频获取
SEARCH_ACCOUNT_INFO:搜索播主信息</code></pre>
<h2>入参</h2>
<h3>入参示例,根据事件类型分别给出示例 (RequestBody)</h3>
<pre><code>{
"msgId": "d5baf495-acb3-4078-b7b5-2b57ded52f95",
"event": "GET_ACCOUNT_INFO",
"code": 200,
"data": {
"accountData": {
"nickname": "陈翔六点半",
"uniqueId": "cxldb"
}
}
}
{
"msgId": "d5baf495-acb3-4078-b7b5-2b57ded52f95",
"event": "CANCEL_SUBSCRIBE_ACCOUNT",
"code": 200
}
{
"msgId": "53368f74-5536-4344-884c-f2247889fcd6",
"event": "GET_ACCOUNT_LIVE_STATUS",
"code": 200,
"data": {
"liveStatusList": [
{
"nickname": "陈翔六点半",
"uniqueId": "cxldb",
"liveStatus": true,
"coverUrl": "https://coverUrl.com",
"title": "直播啦"
},
{
"nickname": "张三",
"uniqueId": "zs",
"liveStatus": true,
"coverUrl": "https://coverUrl.com",
"title": "直播啦"
},
{
"nickname": "李四",
"uniqueId": "ls",
"liveStatus": false
}
]
}
}
{
"msgId": "d5baf495-acb3-4078-b7b5-2b57ded52f95",
"event": "GET_ACCOUNT_LIVE_DATA",
"code": 200,
"data": {
"liveData": {
"nickname": "陈翔六点半",
"authorId": "cxldb",
"liveId": "123456",
"streamUrl": "https://streamUrl.com",
"watchNum": 100,
"likeNum": 200,
"heatNum": 100,
"startTime":1662017176,
"title": "直播啦"
}
}
}
{
"msgId": "d5baf495-acb3-4078-b7b5-2b57ded52f95",
"event": "GET_ACCOUNT_VIDEO_LIST",
"code": 200,
"data": {
"videoData": {
"nickname": "陈翔六点半",
"uniqueId": "cxldb",
"videoList": [
{
"videoId": "123",
"title": "视频标题1",
"duration": 876,
"coverUrl": "https://coverUrl.com",
"publishTime": "2022-08-01 12:00:00",
"likeNum": 159,
"forwardNum": 614,
"recommendNum": 162,
"commentNum": 351
},
{
"videoId": "456",
"title": "视频标题2",
"duration": 876,
"coverUrl": "https://coverUrl.com",
"publishTime": "2022-08-02 12:00:00",
"likeNum": 159,
"forwardNum": 614,
"recommendNum": 162,
"commentNum": 351
}
]
}
}
}
{
"msgId": "d5baf495-acb3-4078-b7b5-2b57ded52f95",
"event": "REPORT_DEVICE_STATUS",
"topic":"cat_00000000-0049-a716-0000-0000026581f0",
"deviceFreeStatus":true,
"code": 200
}
{
"msgId": "d5baf495-acb3-4078-b7b5-2b57ded52f95",
"event": "GET_ACCOUNT_SIMPLE_VIDEO",
"code": 200,
"data": {
"simpleVideoData": {
"nickname": "陈翔六点半",
"videoData": {
"videoId": "2737598603882979018_0_125_2_1",
"videoNoLike": "2737598603882979018",
"title": "视频标题1",
"duration": 876,
"coverUrl": "https://coverUrl.com",
"publishTime": "2022-08-01 12:00:00",
"likeNum": 159,
"forwardNum": 614,
"recommendNum": 162,
"commentNum": 351
}
}
}
}
{
"code": 200,
"event": "SEARCH_ACCOUNT_INFO",
"msgId": "c1003609-32e2-4077-9252-7e302d81f85b",
"topic": "cat_476b4e5f-0654-4cfd-92e6-a1446e368a7a",
"data": {
"accountDataList": [
{
"avatarUrl": "https://pic2.pedaily.cn/18/201809/20180910@347745.jpg",
"liveStatus": 2,
"nickname": "测试博主6666",
"uniqueId": "test0666666666@finder"
}
]
}
}</code></pre>
<h3>入参字段说明</h3>
<table>
<thead>
<tr>
<th><strong>字段</strong></th>
<th><strong>类型</strong></th>
<th><strong>必填</strong></th>
<th><strong>含义</strong></th>
<th><strong>其他参考信息</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>msgId</td>
<td><strong>String</strong></td>
<td>是</td>
<td>消息id</td>
<td></td>
</tr>
<tr>
<td>event</td>
<td><strong>String</strong></td>
<td>是</td>
<td>事件类型</td>
<td></td>
</tr>
<tr>
<td>topic</td>
<td><strong>String</strong></td>
<td>是</td>
<td>设备topic</td>
<td></td>
</tr>
<tr>
<td>deviceFreeStatus</td>
<td><strong>Boolean</strong></td>
<td>是</td>
<td>设备是否空闲,true:是,false:否</td>
<td></td>
</tr>
<tr>
<td>code</td>
<td><strong>Integer</strong></td>
<td>是</td>
<td>状态码</td>
<td></td>
</tr>
<tr>
<td>data</td>
<td><strong>Data</strong></td>
<td>是</td>
<td>响应数据</td>
<td></td>
</tr>
<tr>
<td>└─ accountData</td>
<td><strong>AccountData</strong></td>
<td>是</td>
<td>播主数据</td>
<td></td>
</tr>
<tr>
<td> └─ nickname</td>
<td><strong>String</strong></td>
<td>是</td>
<td>昵称</td>
<td></td>
</tr>
<tr>
<td> └─ uniqueId</td>
<td><strong>String</strong></td>
<td>是</td>
<td>播主唯一标识</td>
<td></td>
</tr>
<tr>
<td>└─ liveStatusList</td>
<td><strong>List<LiveData></strong></td>
<td>是</td>
<td>播主直播状态数据</td>
<td></td>
</tr>
<tr>
<td> └─ nickname</td>
<td><strong>String</strong></td>
<td>是</td>
<td>播主昵称</td>
<td></td>
</tr>
<tr>
<td> └─ uniqueId</td>
<td><strong>String</strong></td>
<td>是</td>
<td>账号id</td>
<td></td>
</tr>
<tr>
<td> └─ liveStatus</td>
<td><strong>Boolean</strong></td>
<td>是</td>
<td>是否在直播中,true:直播中,false:未开播</td>
<td></td>
</tr>
<tr>
<td> └─ coverUrl</td>
<td><strong>String</strong></td>
<td>否</td>
<td>直播封面(直播中的才有该值)</td>
<td></td>
</tr>
<tr>
<td>└─ liveData</td>
<td><strong>LiveData</strong></td>
<td>是</td>
<td>播主直播数据</td>
<td></td>
</tr>
<tr>
<td> └─ nickname</td>
<td><strong>String</strong></td>
<td>是</td>
<td>播主昵称</td>
<td></td>
</tr>
<tr>
<td> └─ uniqueId</td>
<td><strong>String</strong></td>
<td>是</td>
<td>账号id</td>
<td></td>
</tr>
<tr>
<td> └─ liveId</td>
<td><strong>String</strong></td>
<td>是</td>
<td>直播唯一标识</td>
<td></td>
</tr>
<tr>
<td> └─ streamUrl</td>
<td><strong>String</strong></td>
<td>是</td>
<td>直播流地址</td>
<td></td>
</tr>
<tr>
<td> └─ watchNum</td>
<td><strong>Long</strong></td>
<td>是</td>
<td>累计观看数</td>
<td></td>
</tr>
<tr>
<td> └─ likeNum</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>累计点赞数</td>
<td></td>
</tr>
<tr>
<td> └─ heatNum</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>热度</td>
<td></td>
</tr>
<tr>
<td> └─ startTime</td>
<td><strong>Long</strong></td>
<td>是</td>
<td>开播时间</td>
<td></td>
</tr>
<tr>
<td> └─ title</td>
<td><strong>String</strong></td>
<td>否</td>
<td>直播主体</td>
<td></td>
</tr>
<tr>
<td>└─ videoData</td>
<td><strong>VideoData</strong></td>
<td>是</td>
<td>播主视频数据</td>
<td></td>
</tr>
<tr>
<td> └─ nickname</td>
<td><strong>String</strong></td>
<td>是</td>
<td>昵称</td>
<td></td>
</tr>
<tr>
<td> └─ videoList</td>
<td><strong>List<Video></strong></td>
<td>否</td>
<td>视频列表</td>
<td></td>
</tr>
<tr>
<td> └─ videoId</td>
<td><strong>String</strong></td>
<td>否</td>
<td>视频唯一标识</td>
<td></td>
</tr>
<tr>
<td> └─ videoNo</td>
<td><strong>String</strong></td>
<td>否</td>
<td>视频唯一标识模糊值</td>
<td></td>
</tr>
<tr>
<td> └─ title</td>
<td><strong>String</strong></td>
<td>否</td>
<td>视频标题</td>
<td></td>
</tr>
<tr>
<td> └─ duration</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>视频时长</td>
<td></td>
</tr>
<tr>
<td> └─ coverUrl</td>
<td><strong>String</strong></td>
<td>否</td>
<td>视频封面</td>
<td></td>
</tr>
<tr>
<td> └─ publishTime</td>
<td><strong>Date</strong></td>
<td>否</td>
<td>视频发布时间</td>
<td></td>
</tr>
<tr>
<td> └─ likeNum</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>视频点赞数</td>
<td></td>
</tr>
<tr>
<td> └─ forwardNum</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>视频转发数</td>
<td></td>
</tr>
<tr>
<td> └─ recommendNum</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>视频推荐数</td>
<td></td>
</tr>
<tr>
<td> └─ commentNum</td>
<td><strong>Long</strong></td>
<td>否</td>
<td>视频评论数</td>
<td></td>
</tr>
<tr>
<td>└─ accountDataList</td>
<td><strong>VideoData</strong></td>
<td>是</td>
<td>播主视频数据</td>
<td></td>
</tr>
<tr>
<td> └─ nickname</td>
<td><strong>String</strong></td>
<td>是</td>
<td>昵称</td>
<td></td>
</tr>
<tr>
<td> └─ liveStatus</td>
<td><strong>Integer</strong></td>
<td>否</td>
<td>是否在直播中,1:直播中,2:未开播</td>
<td></td>
</tr>
<tr>
<td> └─ avatarUrl</td>
<td><strong>String</strong></td>
<td>是</td>
<td>播主头像</td>
<td></td>
</tr>
<tr>
<td> └─ uniqueId</td>
<td><strong>String</strong></td>
<td>是</td>
<td>账号id</td>
<td></td>
</tr>
</tbody>
</table>
<h2>出参</h2>
<h3>出参示例</h3>
<pre><code>{
"code": "10000",
"message": "success",
"result": {},
"extra": {}
}</code></pre>
<h3>出参字段说明</h3>
<table>
<thead>
<tr>
<th><strong>字段</strong></th>
<th><strong>类型</strong></th>
<th><strong>含义</strong></th>
<th><strong>其他参考信息</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>code</td>
<td><strong>String</strong></td>
<td></td>
<td></td>
</tr>
<tr>
<td>message</td>
<td><strong>String</strong></td>
<td></td>
<td></td>
</tr>
<tr>
<td>result</td>
<td><strong>Object</strong></td>
<td></td>
<td></td>
</tr>
<tr>
<td>extra</td>
<td><strong>Object</strong></td>
<td></td>
<td></td>
</tr>
</tbody>
</table>