API Center/Active Push Notification of Agent Ringing Events
 

Active Push Notification of Agent Ringing Events

POST

user configured HTTP push address

When the agent's phone is ringing, information will be proactively pushed to the user-configured address. As the ringing event is time-sensitive, it is recommended that the user promptly respond with an HTTP CODE 200 to our request upon receipt and handle the business logic asynchronously. If our push fails, we will retry immediately, with a maximum of three push attempts.
 
Push Parameters
Parameters Description Type
array Array structure Array
callId Call id,which can be used to identify multiple push notifications within a single call. String
type Ringing event type：1,Agent Ringing Event During Transfer in Normal Voice Group Call Task，2,Agent Ringing Event During Transfer in Call Center，3,API-Invoked Phone Ringing Event Integer
taskId task Id Integer
called Called number String
calledInfo Called Information String
seatGroupName The agent group associated with the current ringing event String
noAnswerSipList List of agent accounts that experienced ringing during this call (excluding the current agent) Array
sipAccount Currently ringing agent String
callinEventTime Event time (UTC+8 Timezone, Format: yyyy-MM-dd HH:mm:ss) String
 
Push Sample
Request URL:
    User configured http push address
Request Method:
    POST
Request Headers:
    Content-Type: application/json;charset=UTF-8
Request Body:
[{
    "callId": "250918183554315000287",
    "called": "9113500000002",
    "noAnswerSipList": ["1344C025cb_002"],
    "calledInfo": null,
    "type": 1,
    "sipAccount": "1344C025cb_001",
    "callinEventTime": "2025-09-18 18:35:00",
    "taskId": 561235,
    "seatGroupName": "1344C025cb-SEAT001"
}]
 
Response Sample
Http response 200 is successful. The platform does not verify the response content.
CC SDK Integration
--

Feedback

Was this page helpful?