DocsICP FilingConsole
Documentation
Home Page Artificial Intelligence Cloud Call Service Developer Reference API Reference (2019-10-15) API catalog Traffic management SendHotlineHeartBeat

SendHotlineHeartBeat

Updated at:
Copy as MD
Product
My Favorites

Send a hotline heartbeat request based on the instance ID, agent account name, and heartbeat signature.

Operation description

Queries per second (QPS) limit

  • Per-user invocation frequency: No rate limiting.

  • 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 for the customer request. 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 in the Instance Management section of the left-side navigation pane in 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
Token

string

Yes

Heartbeat signature.

You can obtain the token by invoking the StartHotlineService API.

0079e7a845e373****

Response elements

Element

Type

Description

Example

object

result

Message

string

Description of the status code.

xxxx
RequestId

string

Request ID.

EE338D98-9BD3-4413-B165
Code

string

Status code. A return 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": "xxxx",
  "RequestId": "EE338D98-9BD3-4413-B165",
  "Code": "Success",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description
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.

Previous：MakeDoubleCallNext：StartCall