一知开放平台
  1. 短视频作品合成、编辑和查询
一知开放平台
  • 账户权益管理API
    • 开发说明
    • 实际登陆接口
      POST
    • 订单列表-用户充值消耗明细
      POST
    • 登录接口openApi
      POST
    • 数字人作品校验
      POST
    • 充值
      POST
    • 用户资源详情查询
      GET
    • 消息已读接口
      POST
    • 登出接口openApi
      POST
    • 更改账户状态
      POST
    • 获取用户直播并发详情
      GET
    • 消息列表
      POST
    • 创建用户
      POST
  • 短视频离线合成API
    • 调用须知
    • 常见问题
    • 流式TTS-音色需报备
    • 短视频作品合成、编辑和查询
      • 创建视频合成任务-音频文件
        POST
      • 创建视频合成任务-TTS合成
        POST
      • 更新视频作品名称
        POST
      • 合成任务状态查询接口
        GET
      • 查询合成视频作品列表
        GET
      • 删除视频作品
        GET
      • 复制短视频作品
        POST
      • 视频作品统计
        GET
      • 代理商查询其用户的所有视频作品列表
        POST
      • 预览短视频
        POST
      • 查询预览效果接口(轮询)
        GET
      • 模版列表
        POST
      • 模版详情
        GET
    • 音频作品合成、编辑和查询
      • 合成音频作品
      • 查询音频作品的详情
      • 音频作品的列表
      • 音频作品统计
      • TTS合成接口
      • 代理商查询其用户的所有音频作品列表
      • 删除音频作品
      • TTS合成接口(支持标签)
    • 数字人和音色模型
      • 免费模特列表查询
      • 定制模特列表查询
      • 删除模特资产
      • AI合成音列表查询
      • AI合成音查询
      • 定制
      • 音色定制
      • 更新数字人模特名称
      • 更新音色资产名称
      • 删除定制声音资产
      • 同步至短视频平台
      • 同步至直播平台
    • 素材准备和编辑
      • 配音-录音上传
      • 获取上传的录音
      • 背景上传
      • 背景查询-静态背景
      • 背景查询-获取上传的背景
      • 根据音频生成字幕
      • 解析抖音短视频
      • 生成字幕
      • 获取oss签名
      • 获取oss上传ststoken
  • 直播OpenApi
    • 调用须知
    • 常见问题
    • 实时信息同步
    • 直播阿凡达模式WS连接
    • 直播流程相关
      • 直播间详情
      • 添加直播间素材,创建直播间
      • 开始直播
      • 获取开播的详情
      • 结束直播
      • 插入播放音频
      • 获取当前播放的音频信息
      • 跳转到指定场景指定音频播放
      • 直播间ping后端的接口 10s/次轮训
      • 获取当前账号正在直播的直播间信息
      • 导购商品手动加到插播列表
      • 开播前更新直播间配置
      • 直播中更新直播间素材
      • 直播中插入播放副本到列表
      • 预览直播接口
      • 获取预览链接
      • 获取当前账号正在直播的直播间列表
      • 直播并发列表接口
      • 删除直播间
      • 更新直播间的推流地址
      • 场景隐藏和公开
      • 删除当前已有的音频
      • 新增场景
      • 场景排序
    • 直播素材准备和编辑
      • 背景上传
      • 获取背景的集合
      • 创建素材
      • 素材列表
      • 音色列表
      • 新建商品
      • 类目列表
      • 删除商品
      • 商品列表
      • 编辑商品
  • 数字人互动
    • 互动素材准备和编辑
      • 删除素材
      • 背景上传
      • 素材列表
      • 获取背景的集合
      • 创建素材
    • 互动TalkTo版
      • 创建直播间
      • 开始直播
      • 对话接口
      • 退出直播
  1. 短视频作品合成、编辑和查询

合成任务状态查询接口

GET
/openApiDigitalPerson/customer/detail

请求参数

Query 参数
digitalPersonWorksId
integer 
必需
创建合成任务时返回的任务ID精准查询
示例值:
0
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

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET '/openApiDigitalPerson/customer/detail?digitalPersonWorksId=0' \
--header 'authorization: {{auth|md5}}' \
--header 'req_from: C' \
--header 'timestamp: {{timestamp}}' \
--header 'app_id: {{appId}}' \
--header 'account: 19999999999'

返回响应

🟢200成功
application/json
Body
com.yiwise.base.model.bean.ResultModel<com.yiwise.digitalperson.entity.vo.DigitalPersonWorksVO>
code
integer 
可选
错误代码,200表示执行成功
默认值:
CommonErrorCode.SUCCESS.getCode()
data
object (DigitalPersonWorksVO) 
返回的数据
可选
sceneVOList
array[object (SceneVO) {15}] 
场景列表
可选
srcDigitalPersonWorksId
integer 
源作品id
可选
currentUserId
integer 
可选
globalBackgroundSound
object (AudioTrackClipExt) 
全局背景音
可选
digitalPersonAssetsId
integer 
数字人资产id
可选
sceneId
integer 
用于预览合成
可选
isPreview
boolean 
可选
是否预览(true-作品预览;false-作品合成)
previewJobId
string 
预览任务id
可选
templateId
string 
模板id
可选
orderNo
string 
订单编号
可选
digitalPersonWorksId
integer 
自增主键
可选
userId
integer 
用户ID
可选
name
string 
作品名
可选
avatar
string 
作品头像
可选
status
enum<string> 
作品状态
可选
枚举值:
DRAFTIN_PROGRESSIN_PROGRESS_FAILSUCCESSFAIL
align
enum<string> 
横竖屏
可选
枚举值:
HORIZONTALVERTICAL
resolution
string 
分辨率
可选
worksUrl
string 
作品链接
可选
fee
integer 
作品费用
可选
duration
number 
作品时长,单位秒
可选
failRemark
string 
合成失败原因
可选
createTime
string 
可选
updateTime
string 
可选
requestId
string 
请求唯一标记
可选
resultMsg
string 
提示信息
可选
默认值:
CommonErrorCode.SUCCESS.getDesc()
host
string 
业务主机名
可选
默认值:
getHostName()
errorStackTrace
string 
异常堆栈
可选
示例
{
  "code": 0,
  "data": {
    "sceneVOList": [
      {
        "trackPO": {
          "sceneId": 0,
          "id": "",
          "delay": 0,
          "audioTrack": [
            {
              "duration": 0,
              "digitalPersonWorksUploadAudioId": 0,
              "audioAssetsId": 0,
              "audioType": "",
              "volume": 0,
              "durationList": [
                0
              ],
              "MediaId": "",
              "MediaURL": "",
              "In": 0,
              "Out": 0,
              "TimelineIn": 0,
              "TimelineOut": 0,
              "Speed": 0,
              "Effects": [
                {
                  "Type": "",
                  "SubType": "",
                  "Duration": 0,
                  "Gain": 0,
                  "Auto": 0,
                  "Thres": 0,
                  "Color": ""
                }
              ],
              "LoopMode": false
            }
          ],
          "backGroundSoundTrack": {
            "duration": 0,
            "digitalPersonWorksUploadAudioId": 0,
            "audioAssetsId": 0,
            "audioType": "",
            "volume": 0,
            "durationList": [
              0
            ],
            "MediaId": "",
            "MediaURL": "",
            "In": 0,
            "Out": 0,
            "TimelineIn": 0,
            "TimelineOut": 0,
            "Speed": 0,
            "Effects": [
              {
                "Type": "",
                "SubType": "",
                "Duration": 0,
                "Gain": 0,
                "Auto": 0,
                "Thres": 0,
                "Color": ""
              }
            ],
            "LoopMode": false
          },
          "imageTrack": [
            {
              "z": 0,
              "speed": 0,
              "type": "",
              "MaterialId": 0,
              "avatar": "",
              "duration": 0,
              "MediaId": "",
              "MediaURL": "",
              "X": 0,
              "Y": 0,
              "Width": 0,
              "Height": 0,
              "TimelineIn": 0,
              "TimelineOut": 0,
              "DyncFrames": 0,
              "Effects": [
                {
                  "Type": "",
                  "SubType": "",
                  "Duration": 0,
                  "Gain": 0,
                  "Auto": 0,
                  "Thres": 0,
                  "Color": ""
                }
              ]
            }
          ],
          "subtitleTrack": [
            {
              "textHeight": 0,
              "outlinef": 0,
              "speed": 0,
              "Type": "",
              "SubType": "",
              "FileURL": "",
              "X": 0,
              "Y": 0,
              "TimelineIn": 0,
              "TimelineOut": 0,
              "Content": "",
              "Font": "",
              "FontSize": 0,
              "FontColor": "",
              "FontColorOpacity": "",
              "FontFace": {
                "Bold": false,
                "Italic": false,
                "Underline": false
              },
              "Spacing": 0,
              "Angle": 0,
              "BorderStyle": 0,
              "Outline": 0,
              "OutlineColour": "",
              "Shadow": 0,
              "BackColour": "",
              "Alignment": "",
              "AdaptMode": "",
              "TextWidth": 0,
              "FontUrl": "",
              "EffectColorStyle": "",
              "AaiMotionInEffect": "",
              "AaiMotionIn": 0,
              "AaiMotionOutEffect": "",
              "AaiMotionOut": 0,
              "AaiMotionLoopEffect": "",
              "Ratio": 0
            }
          ],
          "digitalPersonTrack": [
            {
              "z": 0,
              "digitalPersonAssetsId": 0,
              "backgroundId": 0,
              "previewUrl": "",
              "name": "",
              "scale": 0,
              "avatar": "",
              "MediaId": "",
              "MediaURL": "",
              "Type": "",
              "X": 0,
              "Y": 0,
              "Width": 0,
              "Height": 0,
              "In": 0,
              "Out": 0,
              "MaxOut": 0,
              "Duration": 0,
              "DyncFrames": 0,
              "TimelineIn": 0,
              "TimelineOut": 0,
              "Speed": 0,
              "AdaptMode": "",
              "Effects": [
                {
                  "Type": "",
                  "SubType": "",
                  "Duration": 0,
                  "Gain": 0,
                  "Auto": 0,
                  "Thres": 0,
                  "Color": ""
                }
              ]
            }
          ],
          "backGroundImageTrack": {
            "z": 0,
            "digitalPersonAssetsId": 0,
            "backgroundId": 0,
            "previewUrl": "",
            "name": "",
            "scale": 0,
            "avatar": "",
            "MediaId": "",
            "MediaURL": "",
            "Type": "",
            "X": 0,
            "Y": 0,
            "Width": 0,
            "Height": 0,
            "In": 0,
            "Out": 0,
            "MaxOut": 0,
            "Duration": 0,
            "DyncFrames": 0,
            "TimelineIn": 0,
            "TimelineOut": 0,
            "Speed": 0,
            "AdaptMode": "",
            "Effects": [
              {
                "Type": "",
                "SubType": "",
                "Duration": 0,
                "Gain": 0,
                "Auto": 0,
                "Thres": 0,
                "Color": ""
              }
            ]
          }
        },
        "audioFilePath": "",
        "speechStr": "",
        "textList": [
          ""
        ],
        "sceneId": 0,
        "digitalPersonWorksId": 0,
        "userId": 0,
        "backgroundId": 0,
        "orderBy": 0,
        "content": "",
        "composeContent": "",
        "voice": "",
        "textStr": "",
        "createTime": "",
        "updateTime": ""
      }
    ],
    "srcDigitalPersonWorksId": 0,
    "currentUserId": 0,
    "globalBackgroundSound": {
      "duration": 0,
      "digitalPersonWorksUploadAudioId": 0,
      "audioAssetsId": 0,
      "audioType": "",
      "volume": 0,
      "durationList": [
        0
      ],
      "MediaId": "",
      "MediaURL": "",
      "In": 0,
      "Out": 0,
      "TimelineIn": 0,
      "TimelineOut": 0,
      "Speed": 0,
      "Effects": [
        {
          "Type": "",
          "SubType": "",
          "Duration": 0,
          "Gain": 0,
          "Auto": 0,
          "Thres": 0,
          "Color": ""
        }
      ],
      "LoopMode": false
    },
    "digitalPersonAssetsId": 0,
    "sceneId": 0,
    "isPreview": false,
    "previewJobId": "",
    "templateId": "",
    "orderNo": "",
    "digitalPersonWorksId": 0,
    "userId": 0,
    "name": "",
    "avatar": "",
    "status": "",
    "align": "",
    "resolution": "",
    "worksUrl": "",
    "fee": 0,
    "duration": 0,
    "createTime": "",
    "updateTime": ""
  },
  "requestId": "",
  "resultMsg": "",
  "host": "",
  "errorStackTrace": ""
}
修改于 2023-12-05 10:20:22
上一页
更新视频作品名称
下一页
查询合成视频作品列表
Built with