Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Bidirectional Calls/ Callback Interface/ Release Event Callback
Updated on 2023-09-27 GMT+08:00
View PDF

Release Event Callback

Scenario

This interface is invoked to push a call release event.

Method

POST

URL

The URL is customized by the customer.

The release callback URL for bidirectional calls can be configured using either of the following methods:
  • Configuration on the GUI: A tenant administrator chooses Configuration Center > Expansion Management > Bidirectional Call to set Hang-up Callback URL.
  • Configuration using the bidirectional call creation interface (V1.0.0): The request parameter callBackUrl can be transferred when the call creation interface (V1.0.0) is invoked.

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

    caller

    String

    No

    Phone number bound to the agent who initiates the call.

    5

    callerPresent

    String

    No

    CLIP number.

    6

    callData

    String

    No

    Call data.

    7

    createCallTime

    String

    No

    Time when a call is initiated.

    8

    alertingTime

    String

    No

    Ringing time of a subscriber.

    9

    talkingTime

    String

    No

    Call connection time.

    10

    releaseTime

    String

    No

    Call release time.

    11

    talkDuration

    String

    No

    Call duration.

    12

    recordfile

    String

    No

    Path to the voice recording file.

    13

    locationId

    String

    No

    Voice recording node.

    14

    releaseReason

    String

    No

    Call release cause code. The options are as follows:

    • 0: The call ends and the called party hangs up.
    • 1: The call ends and the calling party hangs up.
    • 2: The outgoing call fails to be made to the calling party.
    • 3: The called party fails to be called.
    • 4: The calling party does not answer the call.
    • 5: The called party does not answer the call.
    • xxx: Other exceptions occur.

    15

    agentAlertingTime

    String

    No

    Ringing time of an agent.

    16

    agentTalkingTime

    String

    No

    Call connection time of an agent.

    17

    agentReleaseTime

    String

    No

    Time when an agent releases the call.

    18

    agentTalkDuration

    String

    No

    Call duration of an agent.

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:

{
 agentAlertingTime=2022/02/22,10:04:29:004, 
 agentReleaseTime=2022/02/22,10:04:29:004, 
 agentTalkDuration=2022/02/22,10:04:29:004, 
 agentTalkingTime=2022/02/22,10:04:29:004, 
 alertingTime=2022/02/22,10:04:29:004, 
 callData=null, 
 callSerialNo=1197765398201387012, 
 called=88880067, 
 caller=960003, 
 callerPresent=960003, 
 createCallTime=2022/02/22,10:04:28:823, 
 locationId=0, 
 nonce=-1482421808053124529, 
 recordfile=Y:/2/mobileAgent/20220222/1645524268-824.wav, 
 releaseReason=0, 
 releaseTime=2022/02/22,10:04:36:318, 
 serviceNo=null, 
 signature=+lk3***************************tO50=, 
 talkDuration=0, 
 talkingTime=2022/02/22,10:04:30:418, 
 timestamp=1645524163326
 }

Response parameters:

{ 
    "retCode": "0",
    "retMsg": "success"
}
Parent topic: Callback Interface