给与会设备发送字幕提示，可以指定设备，也可以发送给所有与会设备。
默认接口请求频率限制：20次/秒
REST URL
POST https://sdk.xylink.com/api/rest/external/{version}/conferenceControl/{callNumber}/meeting/subtitle?enterpriseId=XXX&signature=XXX
请求参数说明
参数 | 参数类型 | 参数位置 | 是否必须 | 默认值 | 说明 | 初始平台 |
version | String | Path | 是 | 无 | v1 | |
enterpriseId | String | Query | 是 | 无 | 企业ID，通过管理平台-云视讯API获得 | |
signature | String | Query | 是 | 无 | API签名，参见签名规则 | |
callNumber | String | Path | 是 | 无 | 当前会议的云会议号 | 3.9 |
content | String | Body | 是 | 无 | 发送的字幕内容 | 3.9 |
action | String | Body | 否 | push | 发送/取消字幕 push/cancel cancel取消会中所有终端字幕 | 3.9 |
location | String | Body | 否 | top | 字幕位置 top顶端/middle中间/bottom底部 | 3.9 |
displayType | String | Body | 否 | center | 字幕位置 left靠左/center居中/right靠右 此配置需要在oms管理平台配置权限后生效，如有需要请联系管理员 | 3.10 |
scroll | Integer | Body | 否 | 1 | 是否滚动 1/0 1滚动 0固定 | 3.9 |
fontSize | String | Body | 否 | 无 | 字号 big/middle/small | 3.9 |
fontRGB | String | Body | 否 | 无 | 字体颜色 RGB | 3.9 |
backgroundRGB | String | Body | 否 | 无 | 字幕背景颜色 RGB | 3.9 |
backgroundAlpha | Integer | Body | 否 | 无 | 字幕背景不透明度 0-100整数 | 3.9 |
targets | List | Body | 是 | 无 | 被发送字幕的终端列表：列表为空则发送所有参会终端 | 3.9 |
└ deviceId | long | Body | 是 | 无 | 参会者设备Id， 可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 3.9 |
└ deviceType | int | Body | 是 | 无 | 参会者设备类型，可以从“主持会议 - 根据云会议室号查看当前会议全体成员的会议状态”API查询 | 3.9 |
└ deviceParticipantNumber | String | Body | 是 | 无 | 参会者设备号，设备类型为H.323/SIP终端时必须传。可以从“主持会议 - 查看全体成员的会议状态”API查询： participantNumber表示参会者设备号 | 3.9 |
有关字幕背景颜色与字体颜色的推荐配置如下：
FontRGB | BackgroundRGB | 字幕格式 |
#FFFFFF | "" | 白底白字 |
#FFFFFF | #434343 | 灰底白字 |
#FFFFFF | #FF0000 | 红底白字 |
#FFFFFF | #FFA500 | 黄底白字 |
#FFFFFF | #0000FF | 蓝底白字 |
#FF0000 | #FFFFFF | 白色红字 |
#FF0000 | #FFC90E | 黄底红字 |
#FFC808 | #FF0000 | 红底黄字 |
#FFC90E | #0000FF | 蓝底黄字 |
#0000FF | #FFFFFF | 白底蓝字 |
#000000 | #FFFFFF | 白底黑字 |
#000000 | #C0C0C0 | 灰底黑字 |
示例代码
请求消息体示例（Json）
{
"content": "时尚大方",
"action": "push",
"location": "top",
"scroll": 1,
"fontSize": "big",
"fontRGB": "#FFFFFF",
"backgroundRGB": "",
"backgroundAlpha": 20,
"targets": [
{
"deviceId": 60784924,
"deviceType": 7,
"deviceParticipantNumber": "192.168.0.1"
}
]
}返回结果示例：
成功时返回200，失败时返回小鱼RESTAPI错误码