Updated on 2023-09-27 GMT+08:00

Call Status Event Callback

Scenario

This interface is invoked to push a call status event.

Method

POST

URL

The URL is customized by the customer.

The connection callback URL of bidirectional calls can be configured only on the GUI. A tenant administrator can choose Configuration Center > Expansion Management > Bidirectional Call to set Connection Callback URL.

Request Description

  • Request header parameters

    None

  • Request body parameters
    Table 1 Request body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    callSerialNo

    String

    Yes

    Call SN.

    Length limit: string (50)

    2

    serviceNo

    String

    Yes

    Agent ID.

    3

    called

    String

    Yes

    Customer phone number.

    4

    callData

    String

    No

    Call data.

Response Description

Response code: 200

  • Response message
    Table 2 Response body parameters

    No.

    Parameter

    Type

    Mandatory or Not

    Description

    1

    retCode

    String

    Yes

    Result code. The value 0 indicates success, and other values indicates failure.

    2

    retMsg

    String

    Yes

    Description of a failure cause.

Example

Request parameters:

{
callSerialNo=1197235857187927062, 
serviceNo=, 
called=88880067, 
callData=
}

Response parameters:

{ 
    "retCode": "0",
    "retMsg": "success"
}