GetAgent-Artificial Intelligence Cloud Call Service(AICCS)-阿里云帮助中心

Query agent information in the Cloud Customer Service System by instance ID and agent account name, such as agent ID.

Operation description

Before invoking this API, confirm the AICCS instance information and the agent account name. For guidance on how to obtain these details, refer to the instructions in Request Parameters.
Deleted agents can also be queried. Check the Status parameter in the response. If its value is 2, it indicates that the agent has been deleted.

queries per second (QPS) Limit

Per-user invocation frequency: No Rate Limiting.
API frequency: 100 times/second.

Note

If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	Unique customer request ID. Used for idempotency validation. You can generate it using UUID.	46c1341e-2648-447a-9b11-70b6a298d94d
InstanceId	string	Yes	Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from Instance Management in the left-side navigation pane of the Artificial Intelligence Cloud Call Service console.	ccc_xp_pre-cn-***
AccountName	string	Yes	Agent account name, which is the phone number or mailbox entered during account registration. Unique within the instance.	username@example.com

Response elements

Element	Type	Description	Example
	object	result
RequestId	string	Request ID.	EE338D98-9BD3-4413-B165
HttpStatusCode	integer	HTTP status code.	200
Data	object	Agent data.
Status	integer	Agent status. Valid values: 0: Normal 1: Freeze 2: Delete Note Only agents with a Normal status can perform Business Activities.	0
TenantId	integer	Tenant ID to which the agent belongs, corresponding to the instance ID in the request parameters.	0
GroupList	array<object>	Skill group information to which the agent belongs.
	object	Skill group information.
Description	string	Skill group description.	自动化技能组
DisplayName	string	Display name of the skill group.	自动化技能组
SkillGroupId	integer	Skill group ID.	123456
ChannelType	integer	Skill group channel type.	1
Name	string	Skill group name.	自动化技能组
DisplayName	string	Agent display name shown externally.	XX测试
AgentId	integer	Agent ID.	222222
AccountName	string	Agent account name, which is the phone number or mailbox entered during account registration. Unique within the instance.	username@example.com
Code	string	Status code. A return value of Success indicates that the request succeeded.	Success
Success	boolean	Indicates whether the API invocation succeeded. Valid values: true: Succeeded. false: Failed.	true

Examples

Success response

JSON format

{
  "RequestId": "EE338D98-9BD3-4413-B165",
  "HttpStatusCode": 200,
  "Data": {
    "Status": 0,
    "TenantId": 0,
    "GroupList": [
      {
        "Description": "自动化技能组",
        "DisplayName": "自动化技能组",
        "SkillGroupId": 123456,
        "ChannelType": 1,
        "Name": "自动化技能组"
      }
    ],
    "DisplayName": "XX测试",
    "AgentId": 222222,
    "AccountName": "username@example.com"
  },
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
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.