Querying CDRs of a Specified Call ID

Updated on 2023-12-19 GMT+08:00

View PDF

Scenario

This interface is invoked to query CDRs by call SNs.

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/calldata/querycalldetailbyid

In a public cloud environment, ip indicates the IP address of the CC-CMS server, and port indicates the HTTPS port number of the CC-CMS server. Contact the administrator to obtain the values.

In a non–public cloud environment where the NSLB service is configured, 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	Value Type	Mandatory	Description
1	Content-Type	String	Yes	The value is fixed at 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 message body
No.	Parameter	Value Type	Mandatory	Description
1	ccId	Integer	Yes	ID of a call center. The value ranges from 1 to 65535.
2	isCallin	String	Yes	Whether a call is an inbound call. The options are as follows: true: inbound call false: outbound call
3	callId	String	Yes	Call ID.

Response Description

**Table 3** Parameters in the message body
No.	Parameter	Value Type	Description
1	result	String	Query result. The options are as follows: 0: success Other values: failure For details about the failure causes, see Error Code Reference. NOTE: This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.
2	resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
3	resultDatas	Object	Object in the returned result after a successful query. For details about the parameters of this object, see Table 4. NOTE: This field is reserved for compatibility with interface response parameters in 8.13 and earlier versions.
2	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/resultDatas
No.	Parameter	Value Type	Description
2.1	vdn	Integer	ID of a VDN.
2.2	callId	String	Call ID.
2.3	callerNo	String	Calling number.
2.4	calleeNo	String	Called number.
2.5	callType	Integer	Call type. For details, see Table 1.
2.6	agentId	Integer	Agent ID.
2.7	skillId	Integer	Skill queue ID.
2.8	anonyCall	Integer	Anonymous call identifier. (This parameter is valid only for inbound calls.)
2.9	queueWaitTime	Integer	Queue waiting duration, in seconds.
2.10	ivrCallTime	Integer	IVR call duration, in seconds.
2.11	ackTime	Integer	Ring duration, in seconds.
2.12	callTime	Integer	Call duration, in seconds.
2.13	releaseCause	Integer	Call release cause code. For details, see Cause Code.
2.14	beginTime	String	Call start time. (This parameter is valid only for predicted and preempted outbound calls.) The format is yyyy-MM-dd HH:mm:ss.
2.15	endTime	String	Call end time. (This parameter is valid only for predicted and preempted outbound calls.) The format is yyyy-MM-dd HH:mm:ss.
2.16	result	String	Call result. (This parameter is valid only for predicted and preempted outbound calls.) 0000: The OBS successfully makes an outbound call before the call is transferred to the automatic flow. 0900: The OBS successfully makes an outbound call before the call is transferred to an agent. 0101: The outbound call fails. -1: No number can be called in the current task. 0601: The call is returned.
2.17	resultCode	String	Call result code. (This parameter is valid only for predicted and preempted outbound calls.) This parameter indicates an external result code corresponding to the failure cause code. The external result code can be customized. The failure cause code is associated with the external result code.
2.18	busiResult	String	Outbound call business result code. (This parameter is valid only for predicted and preempted outbound calls.) For details about how to configure the iSales frontend page, see the operation guide.
2.19	busiSubStatus	String	Outbound call business result sub-status code. (This parameter is valid only for predicted and preempted outbound calls.) For details about how to configure the iSales frontend page, see the operation guide.

Message Example

Request header

Content-Type: application/json;charset=UTF-8
Authorization: ******************

Request parameters

{
    "queryParam":
    {
        "ccId":1, 
        "isCallin":"true", 
        "callId":"1000000000-0001"
    }
}

Response parameters

{
    "result": "0",
    "resultCode": "0100000",
    "resultDatas": {
        "vdn": 1,
        "callId": "1000000000-0001",
        "callerNo": "10000",
        "calleeNo": "10001",
        "callType": 0,
        "agentId ": 100,
        "skillId": 1,
        "anonyCall": 0,
        "queueWaitTime": 10,
        "ivrCallTime": 0,
        "ackTime": 5,
        "callTime": 30,
        "releaseCause": 0
    },
    "resultDesc": {
        "vdn": 1,
        "callId": "1000000000-0001",
        "callerNo": "10000",
        "calleeNo": "10001",
        "callType": 0,
        "agentId ": 100,
        "skillId": 1,
        "anonyCall": 0,
        "queueWaitTime": 10,
        "ivrCallTime": 0,
        "ackTime": 5,
        "callTime": 30,
        "releaseCause": 0
    }
}

Parent topic: Real-Time Interfaces for Call Details

Previous topic: Querying Private Call Details of a Specified Agent

Next topic: Historical Data Query