查询数字人

接口描述

1、查询数字人列表
2、接口支持https协议

接口URL

http://api.polyv.net/live/v4/ai/digital-human/list

在线API调用

请求方式

GET

接口约束

1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看

请求参数描述

参数名
必选
类型
说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

当前13位毫秒级时间戳,3分钟内有效

pageNumber

true

Integer

分页参数, 页码

pageSize

true

Integer

分页参数, 每页数据量, 最大1000

sign

true

String

签名,为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

示例

http://api.polyv.net/live/v4/ai/digital-human/list?timestamp=1716105057233&appId=gopl67qi7e&pageNumber=1&pageSize=10&sign=7AFFB910696C8657BB2E27ED6162CA5C

响应参数描述

参数名
类型
说明

code

Integer

响应状态码,200为成功返回,非200为失败

status

String

响应结果,由业务决定,成功返回success,失败返回error

success

Boolean

响应结果,由业务决定,成功返回true,失败返回false

data

Object

成功响应时返回频道详细信息【详见data字段说明

error

Object

状态码非200时的错误信息【详见Error字段说明

requestId

String

请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩

data参数描述

参数名
类型
说明

pageNumber

Integer

分页参数, 页码

pageSize

Integer

分页参数, 每页数据量

totalPages

Integer

分页参数, 总页数

totalItems

Integer

分页参数, 总数据量

contents

List

数字人详细信息, 【详见contents参数描述

contents参数描述

参数名
类型
说明

id

Integer

数字人id

name

String

数字人名称

thirdRoleCode

String

数字人模型id

coverPhoto

String

数字人封面图

fullBodyPhoto

String

数字人真实的图

clothesDesc

String

数字人服装

defaultTtsVoiceId

Integer

数字人默认使用的声音id

createTime

Long

数字人创建时间, 13位时间戳

响应示例

成功示例

{
  "code": 200,
  "status": "success",
  "requestId": "e90aba2c69a24bab894c7f708b853b75.72.17161057275927183",
  "data": {
    "pageNumber": 1,
    "pageSize": 2,
    "totalPages": 8,
    "totalItems": 16,
    "contents": [
      {
        "id": 55,
        "name": "萌萌",
        "thirdRoleCode": "00024",
        "coverPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00024-cover.png",
        "fullBodyPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00024.png",
        "defaultTtsVoiceId": 92,
        "clothesDesc": "白色西装",
        "createTime": 1704191006000
      },
      {
        "id": 13,
        "name": "花花",
        "thirdRoleCode": "00006",
        "coverPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00006-cover.png",
        "fullBodyPhoto": "https://img.videocc.net/e5f34f7744/html/adv/wav/00006.png",
        "defaultTtsVoiceId": 28,
        "clothesDesc": "黑色西服",
        "createTime": 1694569468000
      }
    ]
  },
  "success": true
}

Error参数描述

参数名
类型
说明

code

Integer

错误代码,用于确定具体的错误原因

desc

String

错误描述,与 error.code 对应

Last updated

Was this helpful?