创建赛事
更新时间:2024-03-22
接口说明
本接口用来创建一场赛事。
备注:
(1)使用赛事贴片功能时,需要传入样式id,支持的样式参考实体说明中的贴片介绍;
(2)图片url可提供自定义的公网图片url;
(3)创建赛事需要设定开始时间和结束时间,设备会在指定时间自动开启和关闭;赛事时间不能少于5分钟;
(4)设置比分、计时器、图片、文本时请按需要放置的位置指定槽位index,与样式示例图片上的槽位index对应;
(5)可设置各比分槽位的比分初始值,如果未设置,默认从0开始;
(6)支持多机位。部分从设备处理错误不会影响方法报错,处理错误信息会通过secondaryDevicesErrInfoList返回;
(7)直播和录制的规格不支持自选,默认为1080p。
请求
请求路径
Path | Method | 说明 |
---|---|---|
/v1/event | POST | 创建一场赛事 |
请求参数
无
请求头
无其他特殊头域
请求体
参数 | 类型 | 描述 | 是否必须 |
---|---|---|---|
deviceId | String | 设备id | Y |
secondaryDeviceIdList | List<String> | 当为空时,表示不设置从机位;不为空时,开启多机位,列表表示设置的从机位的设备ID列表。当从设备是三方设备(设备没有注册到IBS),固定传递“device-thirdParty”作为设备ID。 例:["device-thirdParty", "device-2389ddfsf32"] 表示从设备1是三方设备,从设备2是已注册设备。 |
N |
name | String | 赛事name | Y |
sportType | String | 赛事类型 | Y |
description | String | 赛事描述 | N |
startTime | Long | 赛事开始时间,秒级时间戳 | Y |
endTime | Long | 赛事结束时间,秒级时间戳 | Y |
media | Object | 媒体信息 | Y |
callbackUrl | String | 事件回调url | N |
graphics | Object | 贴片配置 | N |
+patternId | String | 贴片样式模板id | N |
+team | Object | 队伍信息 | N |
+scoreboard | List | 比分板 | N |
+clock | List | 计时器 | N |
+text | List | 文本配置 | N |
+image | List | 图片水印配置 | N |
响应
响应头域
除公共头域外,无其他特殊头域
响应体
参数 | 类型 | 描述 | 备注 |
---|---|---|---|
Event | Object | 赛事信息 | |
+id | String | 赛事ID | |
+ ..... | ..... | 更多详见Event实体信息 | |
errorMessage | String | 错误信息 | |
secondaryDevicesErrInfoList | List | 多机位错误信息 | 存在多机位时,且处理错误时返回 |
+deviceId | String | 多机位设备ID | |
+errorMessage | string | 该设备处理中产生的报错信息 |
示例
-
请求示例
Text1POST /v1/event HTTP/1.1 2host: {host} 3content-type: application/json 4authorization: {authorization} 5{ 6 "deviceId":"device-aaaaaa1", 7 "secondaryDeviceIDList":["device-thirdParty", "device_bbbb1"], 8 "name":"三亚沙滩排球\"甘伯杯\"2023年预选赛", 9 "sportType":"volleyball", 10 "startTime":1667890800, 11 "endTime":1667898000, 12 "media":{ 13 "forwardUrl":[ 14 "rtmp://xxxx/xxxx/xxxxxxxx" 15 ] 16 }, 17 "graphics":{ 18 "patternId":"pattern-1", 19 "team":{ 20 "homeTeam":{ 21 "name":"非凡排球", 22 "boxColor":"#FF0000" 23 }, 24 "awayTeam":{ 25 "name":"沙排联盟", 26 "boxColor":"#FFFF00" 27 } 28 }, 29 "scoreboard":[ 30 { 31 "index":1, 32 "homeTeamScore":2, 33 "awayTeamScore":4 34 }, 35 { 36 "index":2, 37 "homeTeamScore":5, 38 "awayTeamScore":10 39 } 40 ], 41 "text":[ 42 { 43 "index":1, 44 "content":"三亚沙滩排球\"甘伯杯\"2023年预选赛" 45 } 46 ], 47 "image":[ 48 { 49 "index":1, 50 "imageUrl":"http://xxx.1.jpg" 51 }, 52 { 53 "index":2, 54 "imageUrl":"http://xxx.2.jpg" 55 }, 56 { 57 "index":3, 58 "imageUrl":"http://xxx.3.jpg" 59 } 60 ], 61 "clock":[ 62 { 63 "index":1, 64 "reverse":0 65 } 66 ], 67 "penalty":[ 68 { 69 "index":1, 70 "homeTeamPenalty":[1,0,1], 71 "awayTeamPenalty":[1,0,1,1] 72 } 73 ] 74 } 75}
-
响应示例
Text1HTTP/1.1 200 OK 2x-bce-request-id: 8dbde9a9-34e8-4071-afa0-b6d4c4e974b2 3Date: Tue, 08 Now 2022 15:00:00 GMT 4Content-Type: application/json;charset=UTF-8 5 6{ 7 8 "event": { 9 "id":"event-aaaaaa1", 10 "userId":"xxx", 11 "deviceId":"device-aaaaaa1", 12 "secondaryDeviceIDList":["device-thirdParty", "device_bbbb1"], 13 "name":"三亚沙滩排球\"甘伯杯\"2023年预选赛", 14 "state":"notStarted", 15 "sportType":"volleyball", 16 "startTime":1667890800, 17 "endTime":1667898000, 18 "media":{ 19 "liveStream":[ 20 "1080p" 21 ], 22 "recording":[ 23 "1080p" 24 ], 25 "mediaState":"liveStreamUnready", 26 "forwardUrl":[ 27 "rtmp://xxxx/xxxx/xxxxxxxx" 28 ] 29 }, 30 "graphics":{ 31 "patternId":"pattern-1", 32 "team":{ 33 "homeTeam":{ 34 "name":"非凡排球", 35 "boxColor":"#FF0000" 36 }, 37 "awayTeam":{ 38 "name":"沙排联盟", 39 "boxColor":"#FFFF00" 40 } 41 }, 42 "scoreboard":[ 43 { 44 "index":1, 45 "homeTeamScore":2, 46 "awayTeamScore":4 47 }, 48 { 49 "index":2, 50 "homeTeamScore":5, 51 "awayTeamScore":10 52 } 53 ], 54 "text":[ 55 { 56 "index":1, 57 "content":"三亚沙滩排球\"甘伯杯\"2023年预选赛" 58 } 59 ], 60 "image":[ 61 { 62 "index":1, 63 "imageUrl":"http://xxx.1.jpg" 64 }, 65 { 66 "index":2, 67 "imageUrl":"http://xxx.2.jpg" 68 }, 69 { 70 "index":3, 71 "imageUrl":"http://xxx.3.jpg" 72 } 73 ] 74 } 75 }, 76 "errorMessage":"xxxxxxxx", 77 "secondaryDevicesErrInfoList":[ 78 { 79 "deviceId":"device-bbbb1", 80 "errorMessage":"device create event err" 81 } 82 ] 83 84}