Querying Details About a Single Outbound Call Result

Function

This interface is invoked to query the outbound call result details of a specified call in a specified VDN.

Usage Description

Prerequisites
You have applied for a developer account.
Restrictions
vdnId must be correctly set for query.

The VDN ID (vdnId) is correctly associated with the call ID (callId).

Request Method

This interface supports only the GET method.

Request URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresultdetail/{callId}

In the URL, ip indicates the IP address of the CC-iSales server, and port indicates the HTTPS port number of the CC-iSales server.

**Table 1** Parameters in the URL
Parameter	Type	Mandatory or Not	Description
vdnId	Integer	Yes	VDN ID. The value is an integer ranging from 1 to 9999.
callId	String	Yes	Call record ID. The value is obtained from the callId field returned by the interface described in Querying Outbound Call Results or Calling Back Outbound Call Results.

Request

**Table 2** Request header parameters
No.	Parameter	Type	Mandatory or Not	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.

No request body exists.

Response

The following provides an example of the response body of this interface:

{
   "returnCode": "0200000", 
   "data": {
                "callId": "1644464743-1388",
                "called": "88881955",
                "callEndTime": "2022-02-10 11:45:51",
                "vdnId": 8,
                "callStatus": "6",
                "failCode": "00000",
                "resultCode": "OB99999",
                "callBeginTime": "2022-02-10 11:45:47",
                "recordPath": "https://south-aicc-develop.obs.cn-south-                                                                                                                                                                                                                                                          1.myhuaweicloud.com:443/isales/record/A68CA32800B9684811D698D1B61C1A0661511E7AD042DEE5304254DDB9DCED00/ec96a62d-f56c-4f4e-8f5e-30e7a29f38e5?AccessKeyId=ERUDBXB5GOMYURMPLKBO&Expires=1644484560&Signature=uztQO%2FxI8GOSW2GZJWCBCm8AyAg%3D",
                "ackBeginTime": "2022-02-10 11:45:43" 
            },
   "resultCode": "0200000",
   "resultDesc": "Query Success!",
   "returnDesc": "Query Success!"
}

Table 3 describes the parameters in the response body of this interface.

**Table 3** Response body parameters
Parameter	Type	Description
resultCode	String	Error code. The value 0200000 indicates success, and other values indicate failure.
resultDesc	String	Description.
returnCode	String	Error code. The value 0200000 indicates success, and other values indicate failure.
returnDesc	String	Description.
data	JSON object	Result in JSON format. For details, see Table 4.

**Table 4** Parameter description of data
Parameter	Type	Description
called	String	Called number.
ackBeginTime	String	Start time of an outbound call, which is the start time of ringing. The format is yyyy-mm-dd hh:mm:ss.
callBeginTime	String	Call start time, which is the time when the call is connected. The format is yyyy-mm-dd hh:mm:ss.
callEndTime	String	Call end time, which is the time when the call is released. The format is yyyy-mm-dd hh:mm:ss.
callStatus	Integer	Call result. The value 5 indicates that the call fails, and the value 6 indicates that the call is successful.
failCode	String	Failure cause code.
resultCode	String	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.
vdnId	Integer	ID of the VDN to which an outbound number belongs.
callId	String	Call record ID, which is used to associate with call data such as CDRs on the CTI.
recordPath	String	URL of a call recording file in the OBS. NOTE: The value of this field is returned only when the connection is used (in SaaS networking). In other cases, this field is left empty.

**Table 5** Error code description
No.	Error Code	Description
1	0200001	Parameter error. For details about the error, see resultDesc.
2	0200007	The call record ID does not exist.
3	02000001	Empty parameter.
4	02000002	The parameter contains invalid characters.
5	02000003	The parameter length cannot exceed the maximum length.
6	02000004	The parameter length cannot be less than the minimum length.
7	02000005	The parameter length must be within the specified range.
8	02000006	Incorrect parameter type.
9	02000007	Incorrect parameter value.
10	02000008	Parameter conversion error. Check the request parameters.
11	02000009	Incorrect parameter combination. Check the request parameters.
12	02000010	The hour and minute parameters must be set at the same time.
13	02000011	The number of parameters cannot exceed the specified number.