Querying Call Information in a Specified VDN

Description

This interface is invoked to query call information in a specified VDN based on the calling number, called number, and time segment.

This interface is invoked to query only the inbound call information of 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/openapi/vdn/querycalls

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
Parameter	Type	Mandatory	Description
ccId	Integer	Yes	ID of a call center. The value ranges from 1 to 65535.
vdn	Integer	Yes	ID of a VDN. The value ranges from 1 to 5000.
callerNo	String	No	Calling number. The value can be empty, indicating that all calling numbers are queried. The value consists of digits and must comply with the number rules.
calleeNo	String	No	Called number. The value can be empty, indicating that all called numbers are queried. The value consists of digits and must comply with the number rules.
beginDate	Long	Yes	Start time of a query period. The value is a timestamp in milliseconds. The time cannot be earlier than 00:00:00 of the previous day. The data source is time zone 0. During query, the time zone needs to be converted based on the specific time zone. For example, GMT+8 is 8 hours ahead the GMT time.
endDate	Long	Yes	End time of a query period. The value is a timestamp in milliseconds. The time cannot be later than 23:59:59 on the current day. The data source is time zone 0. During query, the time zone needs to be converted based on the specific time zone. For example, GMT+8 is 8 hours ahead the GMT time.
limit	Integer	No	Number of query records on each page. The maximum value is 100.
offset	Integer	No	offset specifies the start page of the query. The value range of offset is as follows: The value of offset is equal to limit x (page – 1). The value is greater than or equal to 0. page indicates the start page to be queried.

Response Message

**Table 3** Parameters in the response message body
Parameter	Type	Description
resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
resultDesc	Object	Object in the returned result after a successful query. For details about the parameters of this object, see Table 4.

**Table 4** Parameters of resultDesc
Parameter	Type	Description
data	Array <callinDetial>	Object array in the returned result. For details about the parameters of this object, see Table 5.
count	Integer	Number of data records that can be queried.

**Table 5** Parameters of data
Parameter	Type	Description
logDate	Long	Time when data is imported to the database. The value is a timestamp in milliseconds.
callerNo	String	Calling number.
calleeNo	String	Called number.
callId	String	Call ID.
callType	Integer	Call type. For details, see Description of Call Types.
waitBegin	Long	Waiting start time in millisecond-level timestamp.
ackBegin	Long	Response start time in millisecond-level timestamp.
callBegin	Long	Start time of a call in millisecond-level timestamp.
callEnd	Long	End time of a call in millisecond-level timestamp.
vdn	Integer	ID of a VDN.
leaveReason	Integer	Reason why a call is disconnected from a device. For details, see Table 1.
mediaType	Integer	Media type. For details, see Table 1.
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,
    "callerNo": "12345",
    "calleeNo": "23131", 
    "beginDate": "14511111111", 
    "endDate": "14522222222", 
    "limit": 10,
    "offset": 0
}

Response parameters

{
    "resultCode":"0100000",
    "resultDesc":{
        "data":[
            {
                "logDate": "1615717765000", //Statistics collection time
                "callerNo": "1212", //Calling number
                "calleeNo": "12121212",//Called number
                "callId": "167789709-33", //Call ID
                "callType": "1",//Call type
                "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
                "vdn": 170, //VDN ID
                "leaveReason": "1", //Reason why a call is disconnected from a device
                "mediaType":53,  //Media type
               "subMediaType":1  //Submedia type
             }
        ],
        count: 5
    }
}

Parent topic: Real-Time Interfaces for VDNs

Previous topic: Querying Information About Calls of a Specified Access Code

Next topic: (V2) Querying Call Information in a Specified VDN