- 账户权益管理API
- 短视频离线合成API
- 直播OpenApi
- 调用须知
- 常见问题
- 实时信息同步
- 直播阿凡达模式WS连接
- 直播流程相关
- 直播间详情GET
- 添加直播间素材,创建直播间POST
- 开始直播POST
- 获取开播的详情POST
- 结束直播POST
- 插入播放音频POST
- 获取当前播放的音频信息POST
- 跳转到指定场景指定音频播放POST
- 直播间ping后端的接口 10s/次轮训POST
- 获取当前账号正在直播的直播间信息GET
- 导购商品手动加到插播列表POST
- 开播前更新直播间配置POST
- 直播中更新直播间素材POST
- 直播中插入播放副本到列表POST
- 预览直播接口POST
- 获取预览链接POST
- 获取当前账号正在直播的直播间列表GET
- 直播并发列表接口GET
- 删除直播间 DELETE
- 更新直播间的推流地址POST
- 场景隐藏和公开POST
- 删除当前已有的音频POST
- 新增场景POST
- 场景排序POST
- 直播素材准备和编辑
- 数字人互动
预览直播接口
POST
/openApiDigitalPerson/liveProcess/previewLive
如果长时间获取不到,比如1min,则可以重试
请求参数
Header 参数
authorization
string
必需
示例值:
{{auth|md5}}
req_from
string
必需
示例值:
C
timestamp
integer
时间戳
示例值:
{{timestamp}}
app_id
string
必需
示例值:
{{appId}}
account
string
可选
示例值:
19999999999
Body 参数application/json
liveRoomId
integer
必需
name
string
必需
status
string
必需
enabledStatus
integer
必需
loopType
string
必需
pushUrl
string
必需
liveRuleList
array[string]
必需
liveRoomConfig
object
必需
liveType
string
必需
interrupt
boolean
必需
guideGoodsList
array [object {13}]
必需
liveMaterialLibraryId
integer
必需
materialUrl
string
必需
enableScope
integer
必需
liveGoodsLibraryIds
array[string]
必需
enableMatting
integer
必需
t0
integer
必需
t1
integer
必需
k
integer
必需
guideRuleList
array[string]
可选
corpusList
array [object {5}]
必需
replySource
string
必需
replyType
string
必需
materialName
string
可选
goodsList
array [object {5}]
必需
liveGoodsLibraryId
integer
可选
liveScenePOList
array [object {14}]
可选
goodsName
string
可选
categoryCode
integer
可选
isExpand
boolean
可选
示例
{
"name": "未命名直播",
"status": "TOLIVE",
"enabledStatus": 1,
"loopType": "ALL_LOOP",
"pushUrl": "rtmp://beauty-tx-push.meituan.net/mtlr/1467839_1665bf_55a6a375cc4140f?e=6541ea62&token=6c1dba38a8e940a78640d7d63c2dda12:PMm_ohUSvvAqQcXYKqnjjj1R8f0=",
"liveRuleList": [],
"liveRoomConfig": {
"liveType": "ONE_PEOPLE",
"interrupt": true
},
"guideGoodsList": [
{
"liveMaterialLibraryId": 12485,
"materialUrl": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/goods_media/260/video/1698056417361cut.mp4",
"enableScope": 0,
"liveGoodsLibraryIds": [],
"enableMatting": 0,
"t0": 70,
"t1": 40,
"k": 7,
"guideRuleList": [],
"corpusList": [
{
"replyType": "TEXT",
"txtContent": "<speak>1111111111111</speak>"
},
{
"liveMaterialLibraryId": 18816,
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/common_media/audio/1701687138727output_1_.mp3",
"materialName": "output(1)1701687139666.mp3",
"replyType": "AUDIO"
}
],
"replySource": "ANCHOR",
"replyType": "TEXT"
},
{
"liveMaterialLibraryId": 14441,
"materialName": "bf80e428c479bc4dcc95286c5f90add9.mp4",
"materialUrl": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/371/goods_media/664/video/1700099834830bf80e428c479bc4dcc95286c5f90add9.mp4",
"enableScope": 0,
"liveGoodsLibraryIds": [],
"enableMatting": 0,
"t0": 70,
"t1": 40,
"k": 7,
"corpusList": [
{
"liveMaterialLibraryId": 14502,
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/371/common_media/audio/1700530238310TTS_1692612683246.wav",
"replyType": "AUDIO"
}
],
"replySource": "ANCHOR",
"replyType": "AUDIO"
}
],
"goodsList": [
{
"liveGoodsLibraryId": 260,
"liveScenePOList": [
{
"name": "未命名",
"dialogFlowList": [
{
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/common_media/audio/1692789707137结束.MP3",
"liveMaterialLibraryId": 7890
},
{
"liveMaterialTextId": 75203,
"txtContent": "这里是文本内容,需要选择对应的音色和播放速度和音量才能正常的使用"
}
],
"materialList": [
{
"liveMaterialLibraryId": 10624,
"materialUrl": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/common_media/image/1695035732970169458686467917363c96022b005f1590c207da58a7c3.gif",
"materialType": 0,
"z": 2,
"frameWidth": 232.875,
"frameHeight": 414,
"x": -99.4375,
"y": 89.51187499999999,
"width": 119.75500000000021,
"height": 89.81625000000004
}
],
"liveDigitalPersonAssetsList": [
{
"digitalPersonAssetsId": 311,
"z": 1,
"frameWidth": 1080,
"frameHeight": 1920,
"x": -540,
"y": -960,
"width": 1080,
"height": 1920
}
],
"backGroundImage": {
"backgroundId": 885,
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/background_media/image/image/1688090241371粉红简约.png",
"z": 0,
"frameWidth": 1080,
"frameHeight": 1920,
"x": -540,
"y": -960,
"width": 1080,
"height": 1920
},
"speed": 1,
"volume": 100,
"duration": 29,
"lang": "zh-CN",
"style": "default",
"role": "Default",
"voice": "xiaoyun",
"liveGoodsLibraryId": 260,
"orderBy": 1
}
],
"goodsName": "内置商品",
"categoryCode": 0,
"isExpand": true
}
]
}
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/openApiDigitalPerson/liveProcess/previewLive' \
--header 'authorization: {{auth|md5}}' \
--header 'req_from: C' \
--header 'timestamp: {{timestamp}}' \
--header 'app_id: {{appId}}' \
--header 'account: 19999999999' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "未命名直播",
"status": "TOLIVE",
"enabledStatus": 1,
"loopType": "ALL_LOOP",
"pushUrl": "rtmp://beauty-tx-push.meituan.net/mtlr/1467839_1665bf_55a6a375cc4140f?e=6541ea62&token=6c1dba38a8e940a78640d7d63c2dda12:PMm_ohUSvvAqQcXYKqnjjj1R8f0=",
"liveRuleList": [],
"liveRoomConfig": {
"liveType": "ONE_PEOPLE",
"interrupt": true
},
"guideGoodsList": [
{
"liveMaterialLibraryId": 12485,
"materialUrl": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/goods_media/260/video/1698056417361cut.mp4",
"enableScope": 0,
"liveGoodsLibraryIds": [],
"enableMatting": 0,
"t0": 70,
"t1": 40,
"k": 7,
"guideRuleList": [],
"corpusList": [
{
"replyType": "TEXT",
"txtContent": "<speak>1111111111111</speak>"
},
{
"liveMaterialLibraryId": 18816,
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/common_media/audio/1701687138727output_1_.mp3",
"materialName": "output(1)1701687139666.mp3",
"replyType": "AUDIO"
}
],
"replySource": "ANCHOR",
"replyType": "TEXT"
},
{
"liveMaterialLibraryId": 14441,
"materialName": "bf80e428c479bc4dcc95286c5f90add9.mp4",
"materialUrl": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/371/goods_media/664/video/1700099834830bf80e428c479bc4dcc95286c5f90add9.mp4",
"enableScope": 0,
"liveGoodsLibraryIds": [],
"enableMatting": 0,
"t0": 70,
"t1": 40,
"k": 7,
"corpusList": [
{
"liveMaterialLibraryId": 14502,
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/371/common_media/audio/1700530238310TTS_1692612683246.wav",
"replyType": "AUDIO"
}
],
"replySource": "ANCHOR",
"replyType": "AUDIO"
}
],
"goodsList": [
{
"liveGoodsLibraryId": 260,
"liveScenePOList": [
{
"name": "未命名",
"dialogFlowList": [
{
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/common_media/audio/1692789707137结束.MP3",
"liveMaterialLibraryId": 7890
},
{
"liveMaterialTextId": 75203,
"txtContent": "这里是文本内容,需要选择对应的音色和播放速度和音量才能正常的使用"
}
],
"materialList": [
{
"liveMaterialLibraryId": 10624,
"materialUrl": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/common_media/image/1695035732970169458686467917363c96022b005f1590c207da58a7c3.gif",
"materialType": 0,
"z": 2,
"frameWidth": 232.875,
"frameHeight": 414,
"x": -99.4375,
"y": 89.51187499999999,
"width": 119.75500000000021,
"height": 89.81625000000004
}
],
"liveDigitalPersonAssetsList": [
{
"digitalPersonAssetsId": 311,
"z": 1,
"frameWidth": 1080,
"frameHeight": 1920,
"x": -540,
"y": -960,
"width": 1080,
"height": 1920
}
],
"backGroundImage": {
"backgroundId": 885,
"url": "https://digital-person-daily.oss-cn-hangzhou.aliyuncs.com/live/81/background_media/image/image/1688090241371粉红简约.png",
"z": 0,
"frameWidth": 1080,
"frameHeight": 1920,
"x": -540,
"y": -960,
"width": 1080,
"height": 1920
},
"speed": 1,
"volume": 100,
"duration": 29,
"lang": "zh-CN",
"style": "default",
"role": "Default",
"voice": "xiaoyun",
"liveGoodsLibraryId": 260,
"orderBy": 1
}
],
"goodsName": "内置商品",
"categoryCode": 0,
"isExpand": true
}
]
}'
返回响应
🟢200成功
application/json
Body
com.yiwise.base.model.bean.ResultModel<com.yiwise.digitalperson.entity.dto.StartLiveResult>
code
integer
可选
默认值:
CommonErrorCode.SUCCESS.getCode()
data
object
返回的数据
liveRoomId
string
直播间id
previewIdentity
string
预览凭证
requestId
string
请求唯一标记
resultMsg
string
提示信息
默认值:
CommonErrorCode.SUCCESS.getDesc()
host
string
业务主机名
默认值:
getHostName()
errorStackTrace
string
异常堆栈
示例
{
"code": 0,
"data": {
"pullUrl": "",
"rtsUrl": "",
"sessionId": "",
"errorMessage": "",
"status": ""
},
"requestId": "",
"resultMsg": "",
"host": "",
"errorStackTrace": ""
}
修改于 2024-06-11 11:25:42