新建直播

1.接口说明

创建一路数字人直播实例，传入指定的参数进行系统初始化，新建成功时返回会话ID。直播初始化完成时通过回调同步直播初始化结果，初始化完成时可以操作开启直播。

注意：创建直播后直播会话就开始了，需要定期发送直播状态检测请求保持直播心跳。

2.请求地址

https://digitbot.bokecc.com/api/interact/channel/create

3.请求方式

POST application/json

4.请求参数

①.Query参数：通过URL参数传递。

公共参数及以下参数:

参数名	类型	必需	说明
version	String	是	接口版本号，当前支持版本：1.0.0、1.6.0 。

②.Body参数：通过请求Body传递，JSON格式。

参数名	类型	必需	说明
videoWidth	Integer	是	推流分辨率宽，正偶数。
videoHeight	Integer	是	推流分辨率高，正偶数。
digitalRole	Object	是	数字人信息
ttsConfig	Object	否	tts合成配置，有文本接管时必需
backgroundImage	String	否	背景图片url，如："https://xxx/bg.png"，背景图片将按中心点对齐，等比拉伸铺满合成视频大小，短边对齐，长边超出部分隐藏。
backgroundColor	String	否	背影颜色色值。格式为"RRGGBB"或者"#RRGGBB"，其中RR，GG, BB分别为红色、绿色、蓝色的16进制表示，默认为#FFFFFF。背景颜色和背景图片都传时忽略背景颜色，优先使用背景图片。
sdRtn	Object	否	声网rtc信息，用于rtc推视频流数据，version为1.0.0时必需，version为1.6.0后为非必需，不传时默认使用系统内置声网rtc账号信息，并提供“获取观众rtc token”接口生成观众rtc token。
liveStateCallback	String	否	直播状态回调地址, 直播状态变化时回调到此接口

digitalRole参数说明：

参数名	类型	必需	说明	更新说明
id	String	是	互动数字人id, 暂时只人工联系获取
width	Integer	是	数字人宽,必须大于0
height	Integer	是	数字人高,必须大于0
x	Integer	是	数字人x方向坐标值，0为视频左上角
y	Integer	是	数字人y方向坐标值，0为视频左上角
useGeneralModel	Boolean	否	是否使用通用模型推理。true表示使用。默认：false。	20250522，通用更新
expStrength	Float	否	数字人表情系数，取值范围：1.0~3.0。默认：1.2。	20250522，通用更新

ttsConfig参数说明：

参数名	类型	必需	说明
id	String	是	AI声音数字人ID, 可通过 "查询互动AI声音列表" 接口获取
pitch	Float	否	音调，数值越大越尖锐，越低越低沉，支持范围 [-12, 12], 默认0
speed	Float	否	语速，取值在[0.6, 1.5]区间内，支持两位小数。1.00表示标准语速。默认值：1.00
volume	Float	否	音量，取值在[1.0, 2.0]区间内，支持一位小数。1.0表示正常音量，2.0表示最大音量。默认值：1.0。

sdRtn参数说明：

参数名	类型	必需	说明
appId	String	是	声网rtc appid
channelId	String	是	声网rtc channelId
token	String	是	声网rtc token
uid	String	是	声网rtc uid
tokenCallback	String	是	rtc token续期回调地址，获取新rtc token

5.请求示例

POST https://digitbot.bokecc.com/api/interact/channel/create?accountId=xxx&version=1.6.0&hash=xxx&time=xxx HTTP/1.1
{
 "videoWidth": 1080,
 "videoHeight": 1920,
 "digitalRole": {
     "id": "xxxxxx",
     "width": 1080,
     "height": 1920,
     "x": 0,
     "y": 0
    },
    "ttsConfig": {
     "id": "xxxxxx",
     "pitch": 0,
     "speed": 1.0,
     "volume": 1.2
    },
    "backgroundImage": "https://xxxxxx/background.png",
    "sdRtn": {
     "appId": "xxxxxxxxxxxx",
     "channelId": "aaaa",
     "token": "xxxxxxxxxxx",
     "uid": "123",
     "tokenCallback": "http://xxxxxxx"
    },
   "liveStateCallback": "https://xxxxxx"
}

6.响应示例

请求参数有sdRtn时的返回示例：
{
  "sessionId": "xxxxxx",
  "rtcTokenRenewKey": "xxxxxxxxxxxx"
}


请求参数无sdRtn时的返回示例：
{
  "sessionId": "xxxxxx",
  "rtcAppId": "xxxxxxxxxxxx",
  "rtcChannelId": "a221fb2016ab4dd081846bab63811d75",
  "rtcUid": 1
}

7. 响应data说明

字段名	类型	说明
sessionId	String	直播会话id
rtcTokenRenewKey	String	rtc token续期回调客户接口时生成签名使用的salt，有sdRtn参数时返回
rtcAppId	String	内置声网rtc appid, 无sdRtn参数时返回
rtcChannelId	String	内置声网rtc channelId, 无sdRtn参数时返回
rtcUid	String	内置声网rtc uid, 无sdRtn参数时返回

1.接口说明​

2.请求地址​

3.请求方式​

4.请求参数​

①.Query参数：通过URL参数传递。​

②.Body参数：通过请求Body传递，JSON格式。​

5.请求示例​

6.响应示例​

7. 响应data说明​

1.接口说明

2.请求地址

3.请求方式

4.请求参数

①.Query参数：通过URL参数传递。

②.Body参数：通过请求Body传递，JSON格式。

5.请求示例

6.响应示例

7. 响应data说明