创建直播间

开发中

POST

/apiDigitalPersonDialogWeb/openApi/createLiveRoom

请求参数

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

null

新建可不填

可选

digitalPersonDialogId

null

新建可不填

可选

cover

null

可选

name

string

直播间名

必需

account

string

账号

必需

align

string

必需

横竖屏, HORIZONTAL:横屏， VERTICAL：竖屏

background

object

背景

必需

backgroundId

integer

可选

name

string

必需

url

string

url必填

必需

align

string

必需

横竖屏, HORIZONTAL:横屏， VERTICAL：竖屏

digitalPersonAssets

object

必需

数字人，注意z 背景z是0，不传z是1，

dialogDigitalPersonAssetsId

integer

必需

name

string

必需

templateId

string

必需

description

null

必需

number

必需

number

必需

string

必需

width

number

必需

height

number

必需

frameWidth

integer

必需

frameHeight

number

必需

audioAssets

object

音色

必需

audioAssetsId

integer

必需

name

string

必需

templateId

string

必需

sourceType

integer

传1

必需

materialList

array [object {23}]

必需

素材，注意z，若素材z是1 数字人是2，素材在数字人下面

liveMaterialLibraryId

integer

可选

materialName

string

可选

materialType

integer

可选

liveGoodsLibraryId

integer

可选

materialUrl

string

必需

materialSize

integer

可选

enableMatting

integer

可选

integer

可选

integer

可选

integer

可选

tenantId

integer

可选

createTime

string

可选

orderNum

可选

integer

必需

integer

必需

integer

必需

width

integer

必需

height

integer

必需

avatar

string

可选

frameWidth

integer

必需

frameHeight

integer

必需

position

string

UP表示置顶

可选

status

integer

可选

示例

{
  "id": null,
  "digitalPersonDialogId": null,
  "cover": null,
  "name": "直播间1",
  "account": "13218099831",
  "liveRoomId": null,
  "align": "HORIZONTAL",
  "width": null,
  "height": null,
  "model": "",
  "background": {
    "backgroundId": 38,
    "name": "餐厅咖啡吧休闲桌椅",
    "url": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/1/UID_1/Image/Background/nafiniaputraKwdp0pokIunsplash_1678881317677.jpg",
    "account": null,
    "align": "HORIZONTAL"
  },
  "digitalPersonAssets": {
    "dialogDigitalPersonAssetsId": 4764,
    "name": "汇成医美talkto",
    "templateId": "26079178e16845f78d9f0896abd762bfsub_1718107096523922",
    "description": null,
    "x": -152.34960937500003,
    "y": -270.84375000000006,
    "z": "2",
    "width": 304.69921875000006,
    "height": 541.6875000000001,
    "frameWidth": 963,
    "frameHeight": 541.6875
  },
  "audioAssets": {
    "audioAssetsId": 1159,
    "name": "汇成talkto1",
    "templateId": "S_P3Ev3EYS",
    "sourceType": 1
  },
  "materialList": [
    {
      "liveMaterialLibraryId": 9499299,
      "materialName": "output.mp4",
      "materialType": 2,
      "liveGoodsLibraryId": 23182,
      "materialUrl": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/258/goods_media/23182/video/1718848596868output.mp4",
      "materialSize": 9857,
      "enableMatting": 0,
      "t0": 70,
      "t1": 40,
      "k": 7,
      "tenantId": 2247,
      "createTime": "2024-06-20 09:56:41",
      "orderNum": 1803607875342352400,
      "x": 0,
      "y": 0,
      "z": 1,
      "width": 1920,
      "height": 1080,
      "avatar": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/258/goods_media/23182/video/1718848596868output.mp4?x-oss-process=video/snapshot,t_0,f_jpg,w_0,h_0,m_fast,ar_auto",
      "frameWidth": 315,
      "frameHeight": 560,
      "position": "UP",
      "status": 0
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/apiDigitalPersonDialogWeb/openApi/createLiveRoom' \
--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 '{
	"id": null,
	"digitalPersonDialogId": null,
	"cover": null,
	"name": "直播间1",
	"account": "13218099831",
	"liveRoomId": null,
	"align": "HORIZONTAL",
	"width": null,
	"height": null,
	"model": "",
	"background": {
		"backgroundId": 38,
		"name": "餐厅咖啡吧休闲桌椅",
		"url": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/FileUpload/1/UID_1/Image/Background/nafiniaputraKwdp0pokIunsplash_1678881317677.jpg",
		"account": null,
		"align": "HORIZONTAL"
	},
	"digitalPersonAssets": {
		"dialogDigitalPersonAssetsId": 4764,
		"name": "汇成医美talkto",
		"templateId": "26079178e16845f78d9f0896abd762bfsub_1718107096523922",
		"description": null,
		"x": -152.34960937500003,
		"y": -270.84375000000006,
        "z":"2",
		"width": 304.69921875000006,
		"height": 541.6875000000001,
		"frameWidth": 963,
		"frameHeight": 541.6875
	},
	"audioAssets": {
		"audioAssetsId": 1159,
		"name": "汇成talkto1",
		"templateId": "S_P3Ev3EYS",
		"sourceType": 1
	},
    "materialList":[{
        "liveMaterialLibraryId": 9499299,
        "materialName": "output.mp4",
        "materialType": 2,
        "liveGoodsLibraryId": 23182,
        "materialUrl": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/258/goods_media/23182/video/1718848596868output.mp4",
        "materialSize": 9857,
        "enableMatting": 0,
        "t0": 70,
        "t1": 40,
        "k": 7,
        "tenantId": 2247,
        "createTime": "2024-06-20 09:56:41",
        "orderNum": 1803607875342352386,
        "x": 0.0,
        "y": 0.0,
        "z": 1,
        "width": 1920,
        "height": 1080,
        "avatar": "https://digital-person.oss-cn-hangzhou.aliyuncs.com/live/258/goods_media/23182/video/1718848596868output.mp4?x-oss-process=video/snapshot,t_0,f_jpg,w_0,h_0,m_fast,ar_auto",
        "frameWidth": 315.0,
        "frameHeight": 560.0,
        "position": "UP",
        "status": 0
    }]
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

data

integer

必需

直播间id，开启直播需要

requestId

string

必需

resultMsg

string

必需

host

string

必需

errorStackTrace

null

必需

示例

{
  "code": 200,
  "data": 48,
  "requestId": "dyC8tCkg",
  "resultMsg": "执行成功",
  "host": "pre-acp-02",
  "errorStackTrace": null
}

创建素材

开始直播