tencent cloud

Feedback

Tencent Cloud AI Digital Human

Customer Resource Query Anchor API

Last updated: 2024-07-18 18:21:31

API Description

Query all anchors owned by customers within their permissions and anchor avatars through AppKey and AccessToken.
Note:
This API is gradually being phased out. Use the Query Image Asset Information - Query Anchor API for queries.

Calling Protocol

HTTPS + JSON
POST     /v2/ivh/videomaker/broadcastservice/getanchor
Header   Content-Type: application/json;charset=utf-8

Request Parameters

Parameters
Type
Mandatory
Description
GetAllResource
bool
Yes
When set to false, it retrieves resources specific to the current AppKey; when set to true, it retrieves all resources associated with the current user.
VirtualmanTypeCode
string
No
Digital human type code:
real_man_2d: 2D Premium Anchor
real_man_3d: 3D Anchor

Response Parameter

Parameters
Type
Mandatory
Description
VirtualmanResources
Array of [VirtualmanResource]
Yes
Resources of the digital human within customers' permissions

VirtualmanResource

Parameters
Type
Mandatory
Description
AppKey
string
Yes
Requested AppKey
Virtualmans
Array of [Virtualman]
 
Resources of the digital human corresponding to this AppKey

Virtualman

Parameters
Type
Mandatory
Description
AnchorName
string
Yes
Anchor Name
AnchorCode
string
Yes
Anchor Code
HeaderImage
string
Yes
Digital human avatar image URL
VirtualmanType
string
Yes
Digital human type
VirtualmanTypeCode
string
Yes
Digital human type code
Tag
string
Yes
Digital human model tags, categorized into three types:
1. Basic
2. Standard
3. Advanced
Currently, the tag only affects the horizontal and vertical positioning of anchors. See the API Video Production API - Advanced Version.

Request Sample

{
"Header": {},
"Payload": {
"GetAllResource": true,"VirtualmanTypeCode": "real_man_2d"
}
}

Response Sample

{
"Header": {
"Code": 0,
"Message": "",
"RequestID": "123"
},
"Payload": {
"VirtualmanResources": [
{
"AppKey": "22222",
"Virtualmans": [
{
"AnchorName": "Yani",
"HeaderImage": "url",
"AnchorCode": "yani","VirtualmanTypeCode": "real_man_2d",
"VirtualmanType": "2D Real Person"
}
]
}
]
}
}
 
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon