Help Center/ Cognitive Engagement Center/ API Reference/ Agent Workbench Interface Reference/ Agent Bidirectional Calls/ Sending an ITA Bidirectional Call Result Notification (statusnotify)
Updated on 2023-09-27 GMT+08:00
View PDF

Sending an ITA Bidirectional Call Result Notification (statusnotify)

Scenario

This interface is invoked by the ITA to push bidirectional call CDR data to the AICC after a call ends.

Method

POST

URI

https://Domain name/apiaccess/rest/cc-management/v1/ita/twopartiescall/statusnotify (For example, the domain name is service.besclouds.com.)

Request Description

Table 1 Request header parameters

No.

Parameter

Type

Mandatory or Not

Description

1

AppKey

String

No

App key on the ITA side, which is the user ID.

2

Host

String

Yes

Internet host and port number of the requested resource.

  • hostname indicates the IP address or domain name of the AXB service.
  • port indicates the port number.

3

Content-Type

String

Yes

Media type of the request body sent to the recipient (server).

4

X-Sdk-Date

String

Yes

Time when a request is initiated.

5

Authorization

String

Yes

Authentication field. For details, see ITA documents.
Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1

callID

String

Yes

Unique call ID, which is used to download recording files.

2

remark

String

Yes

Remark when a call is initiated. This is a reserved field. (Currently, the value is the tenant space ID.)

3

startTime

String

No

Time when a call is initiated, accurate to seconds.

The format is YYYYMMDDHHmmss.

4

finishTime

String

No

Call end time.

5

callDuration

String

No

Call duration, in seconds. This parameter is for reference only.

The call duration is calculated from the time when the call is set up.

6

callerAnswerTime

String

No

Time when the calling party answers the call.

7

calledAnswerTime

String

No

Time when the called party answers the call.

8

releaseCause

String

No

Cause value carried by the call end event.

9

appKey

String

No

Customer resource allocation ID.

10

telA

String

No

Original calling number.

11

telX

String

No

Terminated service number.

12

telB

String

No

Original called number.

13

calledDisplay

String

No

CLIP called number.

Response Description

  • Status code: 200

    After the message is received, the system returns a 200 OK message. Ensure that the value of Content-Type in the response is application/json; charset=UTF-8.

  • Status code: 400

    Incorrect request. Check the request path and parameters.

  • Status code: 401

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 404

    The requested content is not found. Check the request path.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Request example:

POST /twopartiescall/statusnotify HTTP/1.1
Request:
AppKey: CMCCGX_0001
X-Sdk-Date: 20210512T115430Z
Content-Type: application/json;charset=UTF-8
Host: 10.10.10.10:9003
Authorization: SDK-HMAC-SHA256 Access=1******2F4J8Q5T, SignedHeaders=appkey;content-type;host;x-sdk-date, Signature=77c4******62f48bcb4873e1d9ad9c1acc34b9b

{
	"appKey": "CMCCGX_0001",
        "remark": "2022091800",
	"telA": "1580****001",
	"telX": "184****0497",
	"telB": "158****0002",
	"calleeDisplay": "158****0001",
	"startTime": "20210512115422",
	"callerAnswerTime": "20210512115422",
	"calledAnswerTime": "20210512115422",
	"finishTime": "20210512115430",
	"callID": "cmccgx20210512195422",
	"releaseCause": "1",
	"callDuration": 8
}

Response example:

HTTP/1.1 200 OK 
Date: Mon, 12 Nov 2007 15:55:01 GMT 
Content-Length: xxx 
Content-Type: application/json; charset=UTF-8 
{ 
}