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

Obtain the current service details of a hotline agent based on the instance ID and agent account name.

Operation description

The hotline agent details include information such as agent posture status, agent ID, and heartbeat signature. For more information, see Response parameters.

Queries per second (QPS) limit

Per-user invocation frequency: Rate Limiting is not applied.
API frequency: 100 queries per second (QPS).

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 ID of the customer request. Used for idempotency validation. You can generate it by using a 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 specified during account registration. It is unique within the instance.	username@example.com

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
Data	object	Agent service data.
Assigned	boolean	Indicates whether the agent is assigned. Valid values: false: Not assigned (no call). true: Assigned (in a call).	false
TenantId	integer	Tenant ID to which the agent belongs, corresponding to the instance ID in the input parameter.	ccc_xp_pre-cn-***
RestType	integer	Break type. Valid values: 1: Short break. 2: Meal break. 3: Meeting. 4: Coaching. 5: Training.	1
AgentStatus	integer	Agent status. Valid values: 1~6.	1
AgentStatusCode	string	Agent status code. Valid values: AgentCheckout: Agent logged off. AgentReady: Agent idle. AgentBreak: Agent on break. AgentAcw: Post-processing after a call. AgentBusyForCall: In a call.	AgentCheckout
Token	string	Heartbeat signature.	dnthF_oinHg7JMJDmKqex3Ux****
AgentId	integer	Agent ID.	2235****
Code	string	Status code.	Success
Success	boolean	Indicates whether the API call succeeded. Valid values: true: Succeeded. false: Failed.	true

Examples

Success response

JSON format

{
  "Message": "OK",
  "RequestId": "EE338D98-9BD3-4413-B165",
  "HttpStatusCode": 200,
  "Data": {
    "Assigned": false,
    "TenantId": 0,
    "RestType": 1,
    "AgentStatus": 1,
    "AgentStatusCode": "AgentCheckout",
    "Token": "dnthF_oinHg7JMJDmKqex3Ux****",
    "AgentId": 0
  },
  "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.