一知开放平台
  1. 直播流程相关
一知开放平台
  • 账户权益管理API
    • 开发说明
    • 实际登陆接口
    • 订单列表-用户充值消耗明细
    • 登录接口openApi
    • 数字人作品校验
    • 充值
    • 用户资源详情查询
    • 消息已读接口
    • 登出接口openApi
    • 更改账户状态
    • 获取用户直播并发详情
    • 消息列表
    • 创建用户
  • 短视频离线合成API
    • 调用须知
    • 常见问题
    • 流式TTS-音色需报备
    • 短视频作品合成、编辑和查询
      • 创建视频合成任务-音频文件
      • 创建视频合成任务-TTS合成
      • 更新视频作品名称
      • 合成任务状态查询接口
      • 查询合成视频作品列表
      • 短视频作品创建草稿
      • 删除视频作品
      • 复制短视频作品
      • 视频作品统计
      • 代理商查询其用户的所有视频作品列表
      • 预览短视频
      • 查询预览效果接口(轮询)
      • 模版列表
      • 模版详情
    • 音频作品合成、编辑和查询
      • 合成音频作品
      • 查询音频作品的详情
      • 音频作品的列表
      • 音频作品统计
      • 创建音频草稿
      • TTS合成接口
      • 代理商查询其用户的所有音频作品列表
      • 删除音频作品
      • TTS合成接口(支持标签)
    • 数字人和音色模型
      • 免费模特列表查询
      • 定制模特列表查询
      • 删除模特资产
      • AI合成音列表查询
      • AI合成音查询
      • 定制
      • 音色定制
      • 更新数字人模特名称
      • 更新音色资产名称
      • 删除定制声音资产
      • 同步至短视频平台
      • 同步至直播平台
    • 素材准备和编辑
      • 配音-录音上传
      • 获取上传的录音
      • 背景上传
      • 背景查询-静态背景
      • 背景查询-获取上传的背景
      • 根据音频生成字幕
      • 解析抖音短视频
      • 生成字幕
      • 获取oss签名
      • 获取oss上传ststoken
  • 直播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
    • 直播素材准备和编辑
      • 背景上传
      • 获取背景的集合
      • 创建素材
      • 素材列表
      • 音色列表
      • 新建商品
      • 类目列表
      • 删除商品
      • 商品列表
      • 编辑商品
  • 数字人互动
    • 互动素材准备和编辑
      • 删除素材
      • 背景上传
      • 素材列表
      • 获取背景的集合
      • 创建素材
    • 互动TalkTo版
      • 创建直播间
      • 开始直播
      • 对话接口
      • 退出直播
  1. 直播流程相关

预览直播接口

POST
/openApiDigitalPerson/liveProcess/previewLive
预览接口,主要是用来预览某个场景较短时间的视频。调用方请注意,此方法会消耗直播并发。如果要预览线上某个直播间的时候, 结构上可以传入这个直播间的整体参数,即/openApiDigitalPerson/liveProcess/detail接口的返回信息,但是要控制播放列表里面的音频长度,否则会合成较久的时间。例如:要预览直播间1的第一个场景的视频,可以将第一个场景的所有参数都传入,然后将里面的播放列表只保留两句话,建议预览视频长度控制在30s内,这样可以较快的返回视频地址。
如果长时间获取不到,比如1min,则可以重试

请求参数

Header 参数
authorization
string 
必需
所有接口都需 MD5(APP_ID+APP_SECRET+timestamp) 32位小写 APP_SECRET需要我们提供
示例值:
{{auth|md5}}
req_from
string 
必需
直销客户传C ,代理商传D
示例值:
C
timestamp
integer 
时间戳
必需
示例值:
{{timestamp}}
app_id
string 
必需
APPID,开启后获得
示例值:
{{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 
可选
错误代码,200表示执行成功
默认值:
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
上一页
直播中插入播放副本到列表
下一页
获取预览链接
Built with