Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Real-Time Data Query/ Real-Time Interfaces for VDNs/ Querying the Call track Data in a Specific VDN
Updated on 2023-09-27 GMT+08:00
View PDF

Querying the Call track Data in a Specific VDN

Description

This interface is invoked to query call track data in a specified VDN based on the call ID.

Interface Method

The request method must be set to POST. This interface supports only the POST method.

Request URL

https://ip:port/rest/cmsapp/v1/openapi/vdn/querycalltracedetail

In the URL, ip indicates the IP address of the NSLB server, and port indicates the HTTPS port number of the CC-CMS service mapped on the NSLB server.

Request Description

Table 1 Parameters in the request header

No.

Parameter

Type

Mandatory

Description

1

Content-Type

String

Yes

The value is fixed to application/json; charset=UTF-8.

2

Authorization

String

Yes

For details about the generation mode, see C2 Monitoring, System Outbound Call, CDR, and Knowledge Base Interface Authentication.
Table 2 Parameters in the request message body

No.

Parameter

Type

Mandatory

Description

1

ccId

Integer

Yes

ID of a call center.

The value ranges from 1 to 65535.

2

vdn

Integer

Yes

ID of a VDN.

The value ranges from 1 to 5000.

3

callId

string

Yes

Call ID.

4

logDate

long

Yes

Query time, which is used to parse the month and query the specified table. The value is a timestamp in milliseconds.

Response Message

Table 3 Parameters in the response message body

No.

Parameter

Type

Description

1

resultCode

string

Query result. The options are as follows:

  • 0100000: success
  • Other values: failure
  • For details about the failure causes, see Error Code Reference.

2

resultDesc

array<tbilllog>

Object array in the returned result after a successful query.

For details about the parameters of this object, see Table 4.
Table 4 Parameters of resultDesc

No.

Parameter

Type

Description

2.1

callId

string

Call ID.

2.2

mediaType

Integer

Media type. For details, see Table 1.

2.3

callIdNum

Integer

CDR sequence number.

Sequence number of multiple CDRs generated for a call. The value starts from 1 and indicates the first CDR. The value -1 indicates the last CDR.

2.4

callerNo

string

Calling number.

2.5

calleeNo

string

Called number.

2.6

waitBegin

long

Waiting start time in millisecond-level timestamp.

2.7

ackBegin

long

Response start time in millisecond-level timestamp.

2.8

callBegin

long

Start time of a call in millisecond-level timestamp.

2.9

callEnd

long

End time of a call in millisecond-level timestamp.

2.10

subCcNo

Integer

ID of a call center in a network call center.

2.11

deviceType

Integer

Type of a device that processes calls. For details, see Table 1.

2.12

deviceNo

string

ID of the device that processes the current call.

  • For an agent device, the device ID is the agent ID.
  • For a queue or virtual device, the device ID is the queue ID configured on the configuration console or the ID of the network shared device corresponding to the virtual device.
  • For other device types, the value is an internal ID.

2.13

deviceIn

string

Device description.

2.14

callType

Integer

Call type. For details, see Table 1.

2.15

releaseCause

Integer

Call release cause code. For details, see Cause Code.

2.16

EnterReason

Integer

Reason why a call accesses a device. For details, see Table 1.

2.17

LeaveReason

Integer

Reason why a call is disconnected from a device. For details, see Table 1.

2.18

CurrentSkillID

string

ID of the skill queue that processes the current call.

2.20

subMediaType

Integer

Submedia type. For details, see Table 1.

Message Example

  • Request header 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters 
    {
    "ccId":1,
    "vdn":170,
    "callId": "1678978542-92",
    "logDate": "1615717765000"
}
  • Response parameters 
    {
    "resultCode":"0100000",
    "resultDesc":
        [{
            "callId": "1678978542-92",
            "mediaType": "1",
            "subMediaType|: "1",
            "callIdNum": "-1",
            "callerNo": "80000888",
            "calleeNo": "624192",
            "waitBegin": "1615717765000",//Start time of call waiting
            "ackBegin": "1615717765000",//Time when a call is answered
            "callBegin": "1615717765000",//Start time of a call
            "callEnd": "1615717765000",//End time of a call
            "subCcNo": "0",
            "deviceType": "1",
            "deviceNo": "1",
            "deviceIn": "1",
            "callType": "1",
            "releaseCause": "1", //Valid only when callIdNum is set to -1
            "EnterReason": "11",
            "LeaveReason": "11",
            "CurrentSkillID": "0", //ID of the skill queue that is processing a call
             "mediaType":53,  //Media type
             "subMediaType":1  //Submedia type
        }]
}