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

Operation description

The Data parameter returned by this API is the token required to initiate a heartbeat.
If the agent takes a break, you can pause the hotline service by invoking the SuspendHotlineService API.

Queries per second (QPS) limit

Per-user invocation frequency: No rate limiting.
API frequency: 100 queries per 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 ID for the customer request. Used for idempotency validation and can be generated 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. 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	string	Token required to initiate a heartbeat, returned after a successful request.	0079e7a845e373****
Code	string	Status code. A value of "Success" indicates that the request succeeded.	Success
Success	boolean	Indicates whether the API call succeeded. true: Succeeded. false: Failed.	true

Examples

Success response

JSON format

{
  "Message": "OK",
  "RequestId": "EE338D98-9BD3-4413-B165",
  "HttpStatusCode": 200,
  "Data": "0079e7a845e373****",
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
500	NoAgentFound	The specified agent 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.