抖音开放平台Logo
开发者文档
服务商平台
控制台
  • 生成代开发AI分身的授权链接
  • 获取第三方AI分身已经授权的AI分身列表
  • 部署AI分身抖音云的测试环境
  • AI分身上线前提审
  • AI分身部署抖音云生产环境

    • 部署AI分身抖音云的测试环境

    收藏
    我的收藏

    接口说明

    部署Ai分身抖音云的dev测试环境

    前提条件

    • AI分身已在抖音云平台完成初始化，本步骤在授权流程自动完成。服务商可使用服务商账号登陆抖音云服务商平台平台查看。
    • 部署结果会通过服务商平台配置的"消息与事件接收 URL"进行推送告知。可前往服务商平台，开发-开发配置-授权管理-消息与事件接收 URL 配置

    基本信息

    名称描述
    HTTP URL
    https://open.douyin.com/api/tpapp/aiavatar/deploy/deploy_dev_aiavatar/
    HTTP Method
    POST
    Scope
    ma.tp_ai_avatar.deploy
    权限要求
    用户已前置完成扫码授权AI分身给服务商的第三方AI分身。

    请求参数

    请求头
    access-token必填String
    示例：isvact.0801121846735352506a356a6
    调用https://open.douyin.com/api/tpapp/v2/auth/get_auth_token/生成的token
    content-type必填String
    示例：application/json
    固定值"application/json"
    Body
    deploy_descString
    示例：测试
    部署描述
    image_versionString
    示例：1.0.1

    部署的镜像版本，前往服务商平台开发-模版管理-版本库 获取。

    tpl_repo_identityInt64
    示例：7447858168358649901

    模版标识，前往服务商平台开发-模版管理 获取。

    请求示例
    curl --location --request POST 'https://open.douyin.com/api/tpapp/aiavatar/deploy/deploy_dev_aiavatar/' \
--header 'content-type: application/json' \
--header 'access-token: 0801121846735352506a356a6' \
--data '{"tpl_repo_identity":498566217590485583,"image_version":"1.01","deploy_desc":"部署测试"}'

    响应参数

    Body展开全部子属性
    data必填Struct
    展开子属性
    err_msg必填String
    示例："access_token无效"
    错误描述
    err_no必填Int32
    示例：28001003
    错误码
    log_id必填String
    示例："202405291440576E078D8757B9"
    日志id
    响应示例
    正常响应示例异常响应示例
    {
  "err_msg": "",
  "log_id": "2024fds123xxxxxxxxxxxxxxx",
  "data": {
    "deploy_id": 5267096924261078000
  },
  "err_no": 0
}
    切换单列布局

    错误码

    HTTP 状态码错误码错误码描述排查建议
    20028001005
    系统内部错误，请重试
    请求重试，若依然无解请向平台提交反馈
    20028001003
    access_token无效
    重新请求生成access_token
    20028001008
    access_token过期,请刷新或重新授权
    重新请求生成access_token
    20028001016
    当前应用已被封禁或下线
    clientKey被封禁或者下线
    20028001006
    网络调用错误，请重试
    重试即可
    20028001014
    应用未授权任何能力
    确认应用是否授权能力
    20028001018
    应用未获得该能力
    开通相关能力
    20028003017
    quota已用完
    联系平台处理
    20028001019
    应用该能力已被封禁
    该能力被封禁，联系平台处理
    20028001007
    参数不合法
    根据错误信息检查请求参数是否填写正常

    部署结果通知

    部署结果会按照用户在服务商系统中配置回调地址进行结果推送。配置入口:服务商平台-控制台-选中第三方AI分身应用-开发配置-授权管理-消息与事件接收 URL。
    消息推送的结构为一个key、value为string类型的map，KV定义如下：
    Key
    Value示例
    备注
    AppId
    tt123xxxxxxx12
    用户授权的AI分身id
    TpAppId
    tt456xxxxxxx13
    服务商的第三方AI分身id
    EventTime
    2024-01-02 15:04:05
    回调的时间戳
    Event
    固定值：AiAvatarDycDevDeploy
    固定值
    QrCodeURL
    snssdk1128://wexxxxxxxxx//hi_data=%7B%7B%7D
    体验二维码，使用二维码解析工具将字符串转码为二维码后，可使用抖音app扫码体验对话。
    只有Status为Success时该value有值，部署Failed时，该value为空串。
    Status
    Success
    部署成功：Success，部署失败：Failed
    ​