添加直播间素材，创建直播间

POST

/openApiDigitalPerson/liveProcess/createLiveRoom

done

请求参数

Header 参数

authorization

string

必需

所有接口都需 MD5(APP_ID+APP_SECRET+timestamp) 32位小写 APP_SECRET需要我们提供

示例值:

req_from

string

必需

直销客户传C ，代理商传D

示例值:

timestamp

integer

时间戳

必需

示例值:

app_id

string

必需

APPID，开启后获得

示例值:

account

string

可选

代理商的客户账号，直销客户不传，代理商必传

示例值:

19999999999

Body 参数application/json

name

string

直播间名称

必需

status

string

必需

直播间状态 TOLIVE

pushUrl

string

推流地址

可选

pushSecret

string

推流密钥

可选

streamUrl

string

拉流地址

可选

enabledStatus

integer

必需

直播间是否能使用 1为是

loopType

string

必需

直播间产品循环播放的方式 ALL_LOOP为全部商品循环 SINGLE_LOOP为单品循环

liveRuleList

array[string]

必需

规则列表传空list

liveRoomConfig

object

直播间全局配置

必需

type

string

可选

直播互动平台类型，目前只支持DOUYIN

liveType

string

必需

单双人直播默认传ONE_PEOPLE为单人直播

interrupt

boolean

必需

是否要智能打断插入插播列表 true为是 false为否

guideGoodsList

array [object {17}]

必需

商品导购列表传空列表

liveMaterialLibraryId

integer

素材id

必需

materialUrl

string

素材url

必需

enableScope

integer

必需

启用范围 0全局 1为不启用 2为部分商品

liveGoodsLibraryIds

array[integer]

启用的商品ids

可选

enableMatting

integer

必需

抠图开关,0:关 ,1:开

integer

必需

算法抠图参数t0 默认70

integer

必需

算法抠图参数t1 默认40

integer

必需

算法抠图参数k 默认7

string

必需

商品导购的x位置，坐标原点为画布中心，都是以1080*1920的画布为基准传参

string

必需

商品导购的y位置，坐标原点为画布中心，都是以1080*1920的画布为基准传参

width

string

必需

商品导购视频的宽，是以1080*1920的画布为基准传参

height

string

必需

商品导购视频的高，是以1080*1920的画布为基准传参

backgroundAudioUrl

string

特写素材背景音

必需

guideRuleList

array[object (GuideRulePO) {4}]

话术

可选

corpusList

array [object {4}]

商品导购的回复语料

必需

replySource

enum<string>

必需

回复者主播 ANCHOR, 助播 ASSISTANT;

枚举值:

ANCHORASSISTANT

replyType

enum<string>

必需

回复类型文本 TEXT, 音频 AUDIO;

枚举值:

TEXTAUDIO

goodsList

array [object {5}]

商品列表

必需

liveGoodsLibraryId

integer

必需

产品id 使用内置商品测试环境260 正式环境886

liveScenePOList

array [object {16}]

可选

goodsName

string

必需

openApi使用商品

categoryCode

integer

商品类型传1

必需

isExpand

boolean

必需

示例

{
  "name": "未命名直播",
  "loopType": "ALL_LOOP",
  "liveRoomConfig": {
    "liveType": "ONE_PEOPLE",
    "interrupt": true
  },
  "liveRuleList": [],
  "guideGoodsList": [],
  "goodsList": [
    {
      "liveGoodsLibraryId": 260,
      "goodsName": "AI智能课",
      "enabledStatus": 1,
      "liveScenePOList": [
        {
          "liveGoodsLibraryId": 260,
          "isHide": false,
          "name": "1171",
          "orderBy": 1,
          "voice": "guijie",
          "speed": 1,
          "volume": 23,
          "duration": 100,
          "lang": "zh-CN",
          "role": "Default",
          "style": "default",
          "sourceType": 0,
          "backgroundAudioUrl": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/936/goods_media/0/VOICE/dd9e3d8e-c36c-42c9-aa44-2ce9a2209db2.mp3",
          "backgroundVolume": 1,
          "dialogFlowList": [
            {
              "liveMaterialTextId": 164840,
              "txtContent": "以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍",
              "duration": 33.060936,
              "url": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/tmp/tts/a0ff4aa4-b103-4c0f-aa6e-7d1d576a469a.wav",
              "audioId": "text_000_164840",
              "backgroundVolume": 0.5,
              "x": 0,
              "y": 0,
              "width": 0,
              "height": 0
            },
            {
              "liveMaterialTextId": 164839,
              "txtContent": "欢迎新进直播间的家人们。留下来，让主播给你讲解你感兴趣的团购哈！",
              "duration": 5.66125,
              "url": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/tmp/tts/99f63918-db62-4e20-beb2-e6fd93de80d7.wav",
              "audioId": "text_001_164839",
              "backgroundVolume": 1,
              "x": 0,
              "y": 0,
              "width": 0,
              "height": 0
            },
            {
              "liveMaterialTextId": 164842,
              "txtContent": "123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品",
              "duration": 11.371187,
              "url": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/tmp/tts/9f9983a2-4c0c-4d4c-b27d-aefdcc0d8699.wav",
              "audioId": "text_002_164842",
              "backgroundVolume": 1,
              "x": 0,
              "y": 0,
              "width": 0,
              "height": 0
            }
          ],
          "materialList": [
            {
              "liveMaterialLibraryId": 4074596596519864300,
              "materialType": 0,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/成都-5_73be83e58bd7b0f.png",
              "x": 376.2,
              "y": 1361.9667,
              "z": 1,
              "width": 830.2,
              "height": 544.8333,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": 2085705662474423000,
              "materialType": 2,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/上海-开元明庭_75b89001e9a48fc.mp4",
              "x": 127.93332,
              "y": 51.166687,
              "z": 3,
              "width": 725.3333,
              "height": 408,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": 3972997274946412500,
              "materialType": 2,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/成都-锦著酒店_650454efa1d11e7.mp4",
              "x": 154.70001,
              "y": 493.4,
              "z": 4,
              "width": 704,
              "height": 469.3333,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": -193543254181990900,
              "materialType": 2,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/成都-谷兹博雅_3d85dae588fdc84.mp4",
              "x": 316.43335,
              "y": 987.6,
              "z": 5,
              "width": 640,
              "height": 360,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": 763191773565832700,
              "materialType": 0,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/声音-大_volume-notice_7d04064eeb56d6f.png",
              "x": 196.23334,
              "y": 1222.6333,
              "z": 6,
              "width": 120,
              "height": 120,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": -3980003212096529000,
              "materialType": 0,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/声音-大_volume-notice_7d04064eeb56d6f.png",
              "x": 809.56665,
              "y": 516.6333,
              "z": 7,
              "width": 133.33333,
              "height": 133.33333,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": -3595962433051355600,
              "materialType": 0,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/静音_volume-mute_aa6642ea877682d.png",
              "x": 835.73334,
              "y": 166.46667,
              "z": 8,
              "width": 93.33333,
              "height": 93.33333,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": -7894334561643101000,
              "materialType": 0,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/声音-大_volume-notice_7d04064eeb56d6f.png",
              "x": 809.1,
              "y": 662.9667,
              "z": 9,
              "width": 120,
              "height": 120,
              "frameWidth": 1080,
              "frameHeight": 1920
            }
          ],
          "liveDigitalPersonAssetsList": [
            {
              "digitalPersonAssetsId": 2496,
              "templateId": "苦橘子_备用_1700739818596180",
              "t0": 70,
              "t1": 40,
              "k": 7,
              "isMatting": true,
              "templateValidLength": 216,
              "x": -36,
              "y": 963,
              "z": 2,
              "width": 540,
              "height": 960,
              "frameWidth": 1080,
              "frameHeight": 1920
            }
          ],
          "backGroundImage": {
            "backgroundId": 0,
            "name": "",
            "url": "https://msstest.sankuai.com/avatar-mgrplatform/成都_ad1ba3a96def28a.jpg",
            "frameWidth": 1080,
            "frameHeight": 1920
          }
        },
        {
          "liveGoodsLibraryId": 260,
          "isHide": false,
          "name": "1175",
          "orderBy": 1,
          "voice": "guijie",
          "speed": 1,
          "volume": 100,
          "duration": 100,
          "lang": "zh-CN",
          "role": "Default",
          "style": "default",
          "sourceType": 0,
          "backgroundAudioUrl": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/616/goods_media/1814/audio/170677956935211111.mp3",
          "backgroundVolume": 1,
          "dialogFlowList": [
            {
              "txtContent": "",
              "liveMaterialLibraryId": 480101,
              "duration": 51,
              "url": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/936/goods_media/0/VOICE/3de6734b-1f76-4c7d-8781-9a7e9d77b0f8.mp3",
              "audioId": "audio_020_480101",
              "audioUrl": "",
              "backgroundVolume": 1,
              "x": 0,
              "y": 0,
              "width": 0,
              "height": 0
            }
          ],
          "materialList": [
            {
              "liveMaterialLibraryId": -1226640265282049300,
              "materialType": 0,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/成都-9_4fa52a5b37cafcd.png",
              "x": 236.66666,
              "y": 868,
              "z": 1,
              "width": 593,
              "height": 389.16666,
              "frameWidth": 1080,
              "frameHeight": 1920
            },
            {
              "liveMaterialLibraryId": -6810748942624701000,
              "materialType": 2,
              "materialUrl": "https://msstest.sankuai.com/avatar-mgrplatform/成都-锦著酒店_650454efa1d11e7.mp4",
              "x": 136.56668,
              "y": 113.63336,
              "z": 3,
              "width": 896,
              "height": 597.3333,
              "frameWidth": 1080,
              "frameHeight": 1920
            }
          ],
          "liveDigitalPersonAssetsList": [
            {
              "digitalPersonAssetsId": 2496,
              "templateId": "梦梦_1682331275657_1693879980811882",
              "t0": 70,
              "t1": 40,
              "k": 7,
              "isMatting": true,
              "x": 270,
              "y": 960,
              "z": 2,
              "width": 540,
              "height": 960,
              "frameWidth": 1080,
              "frameHeight": 1920
            }
          ],
          "backGroundImage": {
            "backgroundId": 0,
            "name": "",
            "url": "https://msstest.sankuai.com/avatar-mgrplatform/d99c7d1d1e334887aa929086db4c2c27.png",
            "frameWidth": 1080,
            "frameHeight": 1920
          }
        }
      ],
      "categoryCode": 19
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/openApiDigitalPerson/liveProcess/createLiveRoom' \
--header 'authorization: {{auth|md5}}' \
--header 'req_from: C' \
--header 'timestamp: {{timestamp}}' \
--header 'app_id: {{appId}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "未命名直播",

  "loopType": "ALL_LOOP",

  "liveRoomConfig": {
    "liveType": "ONE_PEOPLE",
    "interrupt": true
  },
  "liveRuleList":[

    ],
  "guideGoodsList": [

  ],
  "goodsList": [
    {
      "liveGoodsLibraryId": 260,
      "goodsName":"AI智能课",
      "enabledStatus":1,
      "liveScenePOList": [
        {
                    "liveGoodsLibraryId":260,
                    "isHide":false,
                    "name":"1171",
                    "orderBy":1,
                    "voice":"guijie",
                    "speed":1,
                    "volume":23,
                    "duration":100,
                    "lang":"zh-CN",
                    "role":"Default",
                    "style":"default",
                    "sourceType":0,
                    "backgroundAudioUrl":"https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/936/goods_media/0/VOICE/dd9e3d8e-c36c-42c9-aa44-2ce9a2209db2.mp3",
                    "backgroundVolume":1,
                    "dialogFlowList":[
                        {
                            "liveMaterialTextId":164840,
                            "txtContent":"以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍",
                            "duration":33.060936,
                            "url":"https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/tmp/tts/a0ff4aa4-b103-4c0f-aa6e-7d1d576a469a.wav",
                            "audioId":"text_000_164840",
                            "backgroundVolume":0.5,
                            "x":0,
                            "y":0,
                            "width":0,
                            "height":0
                        },
                        {
                            "liveMaterialTextId":164839,
                            "txtContent":"欢迎新进直播间的家人们。留下来，让主播给你讲解你感兴趣的团购哈！",
                            "duration":5.66125,
                            "url":"https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/tmp/tts/99f63918-db62-4e20-beb2-e6fd93de80d7.wav",
                            "audioId":"text_001_164839",
                            "backgroundVolume":1,
                            "x":0,
                            "y":0,
                            "width":0,
                            "height":0
                        },
                        {
                            "liveMaterialTextId":164842,
                            "txtContent":"123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品，以下是第5个商品的介绍，123456是一个不错的商品",
                            "duration":11.371187,
                            "url":"https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/tmp/tts/9f9983a2-4c0c-4d4c-b27d-aefdcc0d8699.wav",
                            "audioId":"text_002_164842",
                            "backgroundVolume":1,
                            "x":0,
                            "y":0,
                            "width":0,
                            "height":0
                        }
                    ],
                    "materialList":[
                        {
                            "liveMaterialLibraryId":4074596596519864148,
                            "materialType":0,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/成都-5_73be83e58bd7b0f.png",
                            "x":376.2,
                            "y":1361.9667,
                            "z":1,
                            "width":830.2,
                            "height":544.8333,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":2085705662474423145,
                            "materialType":2,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/上海-开元明庭_75b89001e9a48fc.mp4",
                            "x":127.93332,
                            "y":51.166687,
                            "z":3,
                            "width":725.3333,
                            "height":408,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":3972997274946412489,
                            "materialType":2,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/成都-锦著酒店_650454efa1d11e7.mp4",
                            "x":154.70001,
                            "y":493.4,
                            "z":4,
                            "width":704,
                            "height":469.3333,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":-193543254181990905,
                            "materialType":2,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/成都-谷兹博雅_3d85dae588fdc84.mp4",
                            "x":316.43335,
                            "y":987.6,
                            "z":5,
                            "width":640,
                            "height":360,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":763191773565832648,
                            "materialType":0,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/声音-大_volume-notice_7d04064eeb56d6f.png",
                            "x":196.23334,
                            "y":1222.6333,
                            "z":6,
                            "width":120,
                            "height":120,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":-3980003212096528946,
                            "materialType":0,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/声音-大_volume-notice_7d04064eeb56d6f.png",
                            "x":809.56665,
                            "y":516.6333,
                            "z":7,
                            "width":133.33333,
                            "height":133.33333,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":-3595962433051355603,
                            "materialType":0,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/静音_volume-mute_aa6642ea877682d.png",
                            "x":835.73334,
                            "y":166.46667,
                            "z":8,
                            "width":93.33333,
                            "height":93.33333,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":-7894334561643101359,
                            "materialType":0,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/声音-大_volume-notice_7d04064eeb56d6f.png",
                            "x":809.1,
                            "y":662.9667,
                            "z":9,
                            "width":120,
                            "height":120,
                            "frameWidth":1080,
                            "frameHeight":1920
                        }
                    ],
                    "liveDigitalPersonAssetsList":[
                        {
                            "digitalPersonAssetsId":2496,
                            "templateId":"苦橘子_备用_1700739818596180",
                            "t0":70,
                            "t1":40,
                            "k":7,
                            "isMatting":true,
                            "templateValidLength":216,
                            "x":-36,
                            "y":963,
                            "z":2,
                            "width":540,
                            "height":960,
                            "frameWidth":1080,
                            "frameHeight":1920
                        }
                    ],
                    "backGroundImage":{
                        "backgroundId":0,
                        "name":"",
                        "url":"https://msstest.sankuai.com/avatar-mgrplatform/成都_ad1ba3a96def28a.jpg",
                        "frameWidth":1080,
                        "frameHeight":1920
                    }
                },
                
                {
                    "liveGoodsLibraryId":260,
                    "isHide":false,
                    "name":"1175",
                    "orderBy":1,
                    "voice":"guijie",
                    "speed":1,
                    "volume":100,
                    "duration":100,
                    "lang":"zh-CN",
                    "role":"Default",
                    "style":"default",
                    "sourceType":0,
                    "backgroundAudioUrl":"https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/616/goods_media/1814/audio/170677956935211111.mp3",
                    "backgroundVolume":1,
                    "dialogFlowList":[
                        {
                            "txtContent":"",
                            "liveMaterialLibraryId":480101,
                            "duration":51,
                            "url":"https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/936/goods_media/0/VOICE/3de6734b-1f76-4c7d-8781-9a7e9d77b0f8.mp3",
                            "audioId":"audio_020_480101",
                            "audioUrl":"",
                            "backgroundVolume":1,
                            "x":0,
                            "y":0,
                            "width":0,
                            "height":0
                        }
                    ],
                    "materialList":[
                        {
                            "liveMaterialLibraryId":-1226640265282049407,
                            "materialType":0,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/成都-9_4fa52a5b37cafcd.png",
                            "x":236.66666,
                            "y":868,
                            "z":1,
                            "width":593,
                            "height":389.16666,
                            "frameWidth":1080,
                            "frameHeight":1920
                        },
                        {
                            "liveMaterialLibraryId":-6810748942624701585,
                            "materialType":2,
                            "materialUrl":"https://msstest.sankuai.com/avatar-mgrplatform/成都-锦著酒店_650454efa1d11e7.mp4",
                            "x":136.56668,
                            "y":113.63336,
                            "z":3,
                            "width":896,
                            "height":597.3333,
                            "frameWidth":1080,
                            "frameHeight":1920
                        }
                    ],
                    "liveDigitalPersonAssetsList":[
                        {
                            "digitalPersonAssetsId":2496,
                            "templateId":"梦梦_1682331275657_1693879980811882",
                            "t0":70,
                            "t1":40,
                            "k":7,
                            "isMatting":true,
                            "x":270,
                            "y":960,
                            "z":2,
                            "width":540,
                            "height":960,
                            "frameWidth":1080,
                            "frameHeight":1920
                        }
                    ],
                    "backGroundImage":{
                        "backgroundId":0,
                        "name":"",
                        "url":"https://msstest.sankuai.com/avatar-mgrplatform/d99c7d1d1e334887aa929086db4c2c27.png",
                        "frameWidth":1080,
                        "frameHeight":1920
                    }
                }
        
      ],
      
      "categoryCode": 19
    }
  ]
}'

返回响应

🟢200成功

application/json

Body

code

integer

可选

错误代码，200表示执行成功

默认值:

CommonErrorCode.SUCCESS.getCode()

data

integer

可选

返回的数据，直播间的id，后续用到的liveRoomId

requestId

string

请求唯一标记

可选

resultMsg

string

提示信息

可选

默认值:

CommonErrorCode.SUCCESS.getDesc()

host

string

业务主机名

可选

默认值:

getHostName()

errorStackTrace

string

异常堆栈

可选

示例

{
  "code": 0,
  "data": 0,
  "requestId": "",
  "resultMsg": "",
  "host": "",
  "errorStackTrace": ""
}

直播间详情

开始直播