Querying Private Call Details of a Specified Agent

Updated on 2023-09-27 GMT+08:00

View PDF

Scenario

This interface is used to query private call details of a specified agent.

Interface Method

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

Internal Encapsulation Interfaces

BMS interface: /ccbms/ws/monitor/callinfo

Request URL

https://ip:port/rest/cmsapp/v1/openapi/calldata/querydetailcallinfo

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 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
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.
callId	String	Yes	Call ID, which is the private call ID of a specified agent. The value contains a maximum of 20 characters. For details about how to obtain the value, see Querying Private Calls of a Specified Agent.

Response Message

**Table 3** Parameters in the message body
Parameter	Type	Description
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.
resultCode	String	Query result. The options are as follows: 0100000: success Other values: failure For details about the failure causes, see Error Code Reference.
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.
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 or resultDatas
Parameter	Type	Description
cb	Long	Internal ID.
time	Long	Time when a call enters the platform.
dsn	Integer	Call task ID.
handle	Integer	Number of times that a call task control block is reused.
server	Integer	ID of a media server that processes calls.
keyId	String	Business ID of a call.
callingNum	String	Calling number.
calledNum	String	Called number.
mid	Integer	Module ID.
trunkNo	Integer	Trunk ID.
priority	Integer	User level.
deviceType	Integer	Device type. For details, see Table 1.
deviceNo	Integer	Device ID. 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.
callData	String	Call data.
callDataLen	Integer	Valid length of call data.
callSkill	String	Call skill description.
partyNum	Integer	Number of devices involved in a call track.
callFeature	String	Call feature. For details, see Table 1.
orgiCalledNum	String	Original called number. If the called number changes before the call accesses the system, this parameter records the number of the first called party.
mediaType	String	Call media type. For details, see Table 1.
place	Integer	User location (call access place).
waitTime	Long	Queuing time, in seconds.
totalTalkingTimes	Long	Call duration, in seconds.
logonTimes	Long	Total sign-in duration, in seconds.

Message Example

Request header

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

Request parameters

{   
    "ccId":1,
    "vdn":1,
    "callId":"1453723531-574" 
}

Response parameters

{
    "result": "0",
    "resultDatas": {
        "trunkNo": 582,
        "deviceType": 2,
        "deviceNo": 1177,
        "dsn": 49,
        "callData": "",
        "totalTalkingTimes": 116,
        "cb": 1,
        "keyId": "",
        "callingNum": "88881363",
        "calledNum": "650550",
        "orgiCalledNum": "",
        "callDataLen": 0,
        "callSkill": "defaultAudioSkill",
        "partyNum": 2,
        "callFeature": 0,
        "place": 0,
        "waitTime": 0,
        "logonTimes": 127,
        "handle": 0,
        "time": 1606120429,
        "mediaType": "MEDIA_TYPE_PHONE",
        "server": 0,
        "mid": 5,
        "priority": 0
    },
    "resultDesc": {
        "trunkNo": 582,
        "deviceType": 2,
        "deviceNo": 1177,
        "dsn": 49,
        "callData": "",
        "totalTalkingTimes": 116,
        "cb": 1,
        "keyId": "",
        "callingNum": "88881363",
        "calledNum": "650550",
        "orgiCalledNum": "",
        "callDataLen": 0,
        "callSkill": "defaultAudioSkill",
        "partyNum": 2,
        "callFeature": 0,
        "place": 0,
        "waitTime": 0,
        "logonTimes": 127,
        "handle": 0,
        "time": 1606120429,
        "mediaType": "MEDIA_TYPE_PHONE",
        "server": 0,
        "mid": 5,
        "priority": 0
    }
}

Parent topic: Real-Time Interfaces for Call Details

Previous topic: Querying Basic Information About a Call with a Specified Call ID

Next topic: Querying CDRs of a Specified Call ID