UpdateAgent
Modify agent information in the Cloud Customer Service System based on the instance ID and agent account name. You can modify the agent's display name and the skill groups to which the agent belongs.
Operation description
Before invoking this API, we recommend that you confirm your Artificial Intelligence Cloud Call Service (AICCS) instance ID. For guidance on how to obtain it, see the description of Request Parameters.
After the update, you can invoke the GetAgent API to confirm whether the update meets your expectations.
Currently, only the display name and assigned skill groups can be modified.
Queries per second (QPS) limits
Per-user invocation frequency: No rate limiting.
API-wide invocation frequency: 100 queries per second.
Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID. |
46c1341e-2648-447a-9b11-70b6a298d94d |
| InstanceId |
string |
Yes |
AICCS instance ID. |
ccc_xp_pre-cn-*** |
| AccountName |
string |
Yes |
The agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance. Note
Update is not supported. |
username@example.com |
| DisplayName |
string |
Yes |
Agent's display name. |
XX测试 |
| SkillGroupId |
array |
No |
Skill groups to which the agent belongs. |
|
|
integer |
No |
Skill group. |
2345**** |
|
| SkillGroupIdList |
array |
No |
List of skill groups to which the agent belongs. |
|
|
integer |
No |
List of skill groups. Separate multiple skill groups with commas (,). |
2321****,4567**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
result |
||
| Message |
string |
Description of the status code. |
OK |
| RequestId |
string |
Request ID. |
EE338D98-9BD3-4413-B165 |
| HttpStatusCode |
integer |
HTTP status code. |
200 |
| Code |
string |
Status code. A value of "Success" indicates a successful call. |
Success |
| Success |
boolean |
Indicates whether the API call succeeded. Valid values:
|
true |
Examples
Success response
JSON format
{
"Message": "OK",
"RequestId": "EE338D98-9BD3-4413-B165",
"HttpStatusCode": 200,
"Code": "Success",
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | InvalidOperation | The operation is invalid. | |
| 500 | NoAgentFound | The specified agent does not exist. | |
| 500 | NoTenantFound | The specified tenant does not exist. | |
| 500 | SystemError | A system error occurred. Please contact the administrator. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.