Querying Call Result Data

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

View PDF

Scenario

This interface is invoked to query CDR data and satisfaction information from Elasticsearch.

Method

POST

URI

https://Domain name/apiaccess/rest/dataprocess/v1/openapp/queryCallManualDetailInfo

For example, the domain name is service.besclouds.com.

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory or Not	Description
1	X-APP-Key	String	No	App key ID. Obtain the value from the APP Service > APP Management page.
2	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)

**Table 2** Request body parameters
No.	Parameter	Type	Mandatory or Not	Description
1	subCcNo	String	Yes	Call center ID
2	vdn	String	Yes	Tenant VDN ID
3	callId	String	No	If the value of callId is not empty, beginDate and endDate are optional. If the value of callId is empty, either beginDate or endDate must be set.
4	callerNo	String	No	Calling number
5	calleeNo	String	No	Called number
6	beginDate	String	No	If the value of callId is not empty, beginDate and endDate are optional. If the value of callId is empty, either beginDate or endDate must be set.
7	endDate	String	No	If the value of callId is not empty, beginDate and endDate are optional. If the value of callId is empty, either beginDate or endDate must be set.
8	callType	String	No	Call type 0: inbound call 1: outbound call 2: predicted outbound call 3: previewed outbound call 4: preempted outbound call 10: bidirectional call 11: collaborative call 12: click-to-dial call
9	mediaType	String	No	Multimedia type 2: voice click-to-dial 5: voice 18: video click-to-dial 19: video 53: multimedia
10	evaluationValue	String	No	Satisfaction evaluation value The options are the satisfaction levels configured on the Configuration Center > Workbench Configuration > Satisfaction Survey page.

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	total	String	No	Total number of returned results
1.2	results	object	No	Returned results
1.2.1	logDate	String	No	Daily settlement time
1.2.2	callerNo	String	No	Calling number
1.2.3	calleeNo	String	No	Called number
1.2.4	callId	String	No	Call ID
1.2.5	callType	String	No	Call type 0: inbound call 1: outbound call 2: predicted outbound call 3: previewed outbound call 4: preempted outbound call 10: bidirectional call 11: collaborative call 12: click-to-dial call
1.2.6	mediatype	String	No	Multimedia type 2: voice click-to-dial 5: voice 18: video click-to-dial 19: video 53: multimedia
1.2.7	waitBegin	String	No	Call waiting start time
1.2.8	ackBegin	String	No	Call answering start time
1.2.9	callBegin	String	No	Call start time
1.2.10	callEnd	String	No	Call end time
1.2.11	vdn	String	No	Tenant VDN ID
1.2.12	leaveReason	String	No	Reason why a call is disconnected from a device
1.2.13	evaluationValue	String	No	Satisfaction evaluation value The options are the satisfaction levels configured on the Configuration Center > Workbench Configuration > Satisfaction Survey page.

Status code: 400
Incorrect request. Check the request path and parameters.
Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Status code: 404
The requested content is not found. Check the request path.
Status code: 500
Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Query CDR data and satisfaction information from Elasticsearch.

Request header:

X-TenantSpaceID:202101134979  
Authorization:Bearer 3b5d****23c9  
X-app-key:b7bd****cb8c

Request parameters:

{
    "subCcNo": "0",
    "vdn": "0",
    "callId": "0",
    "callerNo": "0",
    "calleeNo": "",
    "beginDate": "1658102400000",
    "endDate": "1658188800000",
    "callType": "0",
    "mediaType": "10",
    "evaluationValue": "10"

}

Response parameters:

{
    "total":2,
    "results":[
    {
        "callId":"1669464198-17002955",
        "vdn":1,
        "evaluationValue":"1",
        "callBegin":"100010"
     },
    {
        "callId":"1669463446-17002406",
        "vdn":1,
        "evaluationValue":"5",
        "callBegin":"100010"
    }
    ]
}

Parent topic: DataProcess Interface Reference

Previous topic: DataProcess Interface Reference

Next topic: Other Interfaces Reference