Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Monitoring and Statistics Collection/ Historical Data Query/ Querying Information About Missed Calls in a Specified VDN
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Information About Missed Calls in a Specified VDN

Scenario

This interface is invoked to query information about all missed calls in a specified VDN.

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/callin/queryMissedCalls

If the CC-CMS is directly connected instead of passing through the NSLB, set ip to the IP address of the CC-CMS server and port to the HTTPS port number of the CC-CMS server.

If the CC-CMS passes through the NSLB, set ip to the IP address of the NSLB server and port to the HTTPS port number of the CC-CMS service mapped on the NSLB.

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 body

No.

Parameter

Type

Mandatory

Description

1

vdn

Integer

Yes

VDN ID. The value ranges from 1 to 5000.

2

offset

Number

Yes

Parameter for determining the start page of the query.

Value of offset = Value of limit x (Value of page – 1)

3

limit

Number

Yes

Number of queried records. A maximum of 5000 records can be queried at a time.

4

beginTime

String

No

Start time for the query (zero-zone time).

The format is yyyy-MM-dd HH:mm:ss.

5

endTime

String

No

End time for the query (zero-zone time).

The format is yyyy-MM-dd HH:mm:ss.

Response Description

Table 3 Response parameters

Parameter

Type

Mandatory

Description

returnCode

String

Yes

Query result. The options are as follows:

  • 0: success
  • Other values: failure

total

Number

Yes

Total number of missed calls.

missedCalls

MissedCall[]

Yes

List of details about missed calls. For details, see Table 4.

returnDesc

String

No

Query result description.
Table 4 Parameters of MissedCall

Parameter

Type

Mandatory

Description

callId

String

Yes

Call ID.

callerNo

String

Yes

Calling number.

calleeNo

String

Yes

Called number.

waitBegin

Datetime

Yes

Call waiting start time.

callEnd

Datetime

Yes

Call end time.

mediaType

Integer

No

Media type. For details, see Table 1.

subMediaType

Integer

No

Submedia type. For details, see Table 1.

Message Example

  • Request header: 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • Request parameters: 
    {
 "vdn":159,
 "offset":0,
 "limit":3,
 "beginTime":"2022-11-17 00:13:43",
 "endTime":"2022-11-17 23:44:13"
}
  • Response parameters: 
    {
    "returnCode": "0",
    "total": 2,
    "missedCalls": [
        {
            "callId": "1668048253-16797218",
            "callerNo": "1659960139858526939",
            "calleeNo": "6300111010",
            "waitBegin": "2022-11-17 23:44:13",
            "callEnd": "2022-11-17 23:44:25",
             "mediaType":53,
             "subMediaType":1
        },
        {
            "callId": "1668050023-1859",
            "callerNo": "88880990",
            "calleeNo": "31045665",
            "waitBegin": "2022-11-17 00:13:43",
            "callEnd": "2022-11-17 00:13:47",
             "mediaType":53,
             "subMediaType":1
        }
    ],
    "returnDesc": "query success"
}
Parent topic: Historical Data Query