创建数字人名片制作 - CreateDigitalHumanBusinessCard
功能介绍
该接口用于数字人名片制作任务。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。
URI
POST /v1/{project_id}/digital-human-business-cards
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,获取方法请参考获取项目ID。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 否 | String | 用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取。 响应消息头中X-Subject-Token的值。 |
| Authorization | 否 | String | 使用AK/SK方式认证时必选,携带的鉴权信息。 |
| X-Sdk-Date | 否 | String | 使用AK/SK方式认证时必选,请求的发生时间。 格式为(YYYYMMDD'T'HHMMSS'Z')。 |
| X-Project-Id | 否 | String | 使用AK/SK方式认证时必选,携带项目ID信息。 |
| X-App-UserId | 否 | String | 第三方用户ID。不允许输入中文。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| business_card_type | 是 | String | 数字人名片类型。 |
| card_templet_asset_id | 是 | String | 数字人名片模板资产ID,可以从资产库中查询。 |
| card_text_config | 是 | BusinessCardTextConfig object | 用户输入的数字人名片信息。实际可以填写哪些字段取决于名片模板。 |
| card_image_config | 是 | BusinessCardImageConfig object | 用户上传的用于制作数字人名片的图片。 |
| introduction_type | 否 | String | 自我介绍驱动方式。
默认取值: TEXT |
| introduction_text | 否 | String | 自我介绍文本,用于驱动数字人口型。 |
| voice_asset_id | 否 | String | 音色资产ID,可以从资产库中查询。 |
| introduction_audio_asset_id | 否 | String | 自我介绍语音资产ID,用于驱动数字人口型。 |
| video_asset_name | 否 | String | 输出名片视频资产名称。默认取card_name的值 |
| gender | 否 | String | 性别。 |
| review_config | 否 | ReviewConfig object | 内容审核配置 |
| callback_config | 否 | CallBackConfig object | 回调设置。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 否 | String | 姓名。 |
| company | 否 | String | 企业或组织名称。 |
| title | 否 | String | 职位名称。 |
| mobile_phone | 否 | String | 手机号码。 |
| phone | 否 | String | 固话号码。 |
| | 否 | String | 电子邮件地址。 |
| address | 否 | String | 地址。 |
| other1 | 否 | String | 其他信息1。可填写一些公司广告语等 |
| other2 | 否 | String | 其他信息2。可填写一些公司广告语等 |
| other3 | 否 | String | 其他信息3。可填写一些公司广告语等 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| human_image | 是 | String | 人物照片,需要Base64编码。 |
| logo_image | 否 | String | Logo图片,需要Base64编码。 |
| id_card_image1 | 否 | String | 身份证国徽面照片,需要Base64编码。 |
| id_card_image2 | 否 | String | 身份证人像面照片,需要Base64编码。 |
| authorize_use_human_image | 否 | Boolean | 授权使用照片 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| X-Request-Id | String | 请求ID。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| job_id | String | 任务ID。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:500
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
POST https://{endpoint}/v1/70b76xxxxxx34253880af501cdxxxxxx/digital-human-business-cards 响应示例
状态码:200
处理成功返回。
{
"job_id" : "26f06524-4f75-4b3a-a853-b649a21aaf66"
} 状态码:400
请求传参异常,包含错误码及对应描述。
{
"error_code" : "MSS.00000003",
"error_msg" : "Invalid parameter"
} 状态码:401
未鉴权或鉴权失败。
{
"error_code" : "MSS.00000001",
"error_msg" : "Unauthorized"
} 状态码:500
内部服务错误。
{
"error_code" : "MSS.00000004",
"error_msg" : "Internal Error"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 处理成功返回。 |
| 400 | 请求传参异常,包含错误码及对应描述。 |
| 401 | 未鉴权或鉴权失败。 |
| 500 | 内部服务错误。 |
错误码
请参见错误码。