Retrieves a list of AI agent voiceprints.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
ice:ListAIAgentVoiceprints |
none |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| VoiceprintId |
string |
No |
The unique voiceprint ID. If specified, this operation returns the details of a single voiceprint. If omitted, it returns a paginated list of all voiceprints under your account. |
vp_1699123456_8527 |
| PageNumber |
integer |
No |
The page number to return. Must be 1 or greater. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Valid values: 1 to 100. |
100 |
| RegistrationMode |
string |
No |
The registration mode for the voiceprint. The default value is Valid values:
|
Explicit |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The data returned. |
||
| RequestId |
string |
The request ID. |
******11-DB8D-4A9A-875B-275798****** |
| Voiceprints |
array<object> |
A list of voiceprint objects. |
|
|
object |
A voiceprint object. |
||
| VoiceprintId |
string |
The unique voiceprint ID. |
vp_1699123456_8527 |
| GmtCreate |
string |
The time the voiceprint was created. The time is in UTC and formatted according to the ISO 8601 standard. |
2025-07-28T10:03:58.000+00:00 |
| GmtModified |
string |
The time the voiceprint was last modified. The time is in UTC and formatted according to the ISO 8601 standard. |
2025-07-28T10:03:58.000+00:00 |
| TotalCount |
integer |
The total number of matching voiceprints. |
2 |
Examples
Success response
JSON format
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"Voiceprints": [
{
"VoiceprintId": "vp_1699123456_8527",
"GmtCreate": "2025-07-28T10:03:58.000+00:00",
"GmtModified": "2025-07-28T10:03:58.000+00:00"
}
],
"TotalCount": 2
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.