Querying Basic Information About a Call with a Specified Call ID

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

View PDF

Scenario

This interface is invoked to query basic information about a call with a specified call ID. (CTI 3.6 does not support this interface.)

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/querybasecallinfo

Request URL

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

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. The value contains a maximum of 20 characters. The value is in the format of Call start time-Call ID. Call start time is a timestamp in milliseconds. An example is 1659513159000-546750.

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
time	Date	Time when a call enters the platform. The unit is millisecond.
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	Unique ID of a call.
callingNum	String	Calling number.
calledNum	String	Called number.
mid	Integer	UAP module ID.
trunkNo	Integer	Trunk ID.
priority	Integer	User level.
deviceType	Integer	Type of the device that is being processed. For details, see Table 1.
deviceNo	Integer	ID of the device that is processing a 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.
callSkill	Integer	Skill queue description.
partyNum	Integer	Number of devices involved in a call track.
callFeature	Integer	Call feature. For details, see Table 1.
orgiCalledNum	Integer	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	Integer	Media type. For details, see Table 1.
place	Integer	User location (call access place).
waitTime	Long	Waiting time in a queue.
totalTalkingTimes	Long	Call duration.
logonTimes	Long	Total sign-in duration.
serviceType	Integer	Business type.
callInCause	Integer	Reason for an inbound call.
enterReason	Integer	Reason for accessing the device. For details, see Table 1.
mediaBillType	String	Multimedia report type.

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",
    "resultCode": "0100000",
    "resultDatas": {
        "time": 1606115215000,
        "dsn": 0,
        "handle": 0,
        "server": 0,
        "keyId": "",
        "callingNum": "88881364",
        "calledNum": "650550",
        "mid": 5,
        "trunkNo": 582,
        "priority": 0,
        "deviceType": 2,
        "deviceNo": 1177,
        "callSkill": "defaultAudioSkill",
        "partyNum": 1,
        "callFeature": 0,
        "orgiCalledNum": "",
        "mediaType": 5,
        "place": 0,
        "waitTime": 0,
        "totalTalkingTimes": 275,
        "logonTimes": 284,
        "serviceType": 2,
        "callInCause": 65535,
        "enterReason": 0,
        "mediaBillType":0
    },
    "resultDesc": {
        "time": 1606115215000,
        "dsn": 0,
        "handle": 0,
        "server": 0,
        "keyId": "",
        "callingNum": "88881364",
        "calledNum": "650550",
        "mid": 5,
        "trunkNo": 582,
        "priority": 0,
        "deviceType": 2,
        "deviceNo": 1177,
        "callSkill": "defaultAudioSkill",
        "partyNum": 1,
        "callFeature": 0,
        "orgiCalledNum": "",
        "mediaType": 5,
        "place": 0,
        "waitTime": 0,
        "totalTalkingTimes": 275,
        "logonTimes": 284,
        "serviceType": 2,
        "callInCause": 65535,
        "enterReason": 0,
        "mediaBillType":0
    }
}

Parent topic: Real-Time Interfaces for Call Details

Previous topic: Real-Time Interfaces for Call Details

Next topic: Querying Private Call Details of a Specified Agent