查询数字人组织

接口描述

1、查询数字人关联的组织,最多支持100个数字人ID
2、接口支持https协议

接口URL

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

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名
必选
类型
说明

appId

true

String

账号appId【详见获取密钥

timestamp

true

Long

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

sign

true

String

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

aiDigitalHumanIds

true

String

数字人ID,多个用英文逗号隔开,最多100个ID

示例

http://api.polyv.net/live/v4/ai/digital-human/list-organization?appId=frlr1zacn3&sign=0F412B15C2DC032517E1D29BD4452C43&timestamp=1630996829815&aiDigitalHumanIds=1,2,3

响应参数描述

参数名
类型
说明

code

Integer

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

status

String

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

success

Boolean

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

data

List<AIDigitalHumanOrganizationVO>

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

error

Object

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

requestId

String

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

Error参数描述

参数名
类型
说明

code

Integer

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

desc

String

错误描述,与 error.code 对应

data参数描述

AIDigitalHumanOrganizationVO

参数名
类型
说明

aiDigitalHumanId

Integer

数字人ID

organizationIds

List<Integer>

组织ID列表

includeChildren

Boolean

是否包含子节点

响应示例

成功示例

{
    "code": 200,
    "status": "success",
    "requestId": "dc7ae621ef8e4f4a8e4976833f1dbbd4.66.16309975070362179",
    "data": [
        {"aiDigitalHumanId":1,"organizationIds":[1,2,3],"includeChildren":true},				
        {"aiDigitalHumanId":2,"organizationIds":[3,4,5],"includeChildren":false}
    ],
    "success": true
}

异常示例

{
    "code": 400,
    "status": "error",
    "requestId": "d310b70bc329403f87f77f9203d50f89.128.16360828899123425",
    "success": false
}

Last updated

Was this helpful?