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

Querying the External Result List

Scenario

This interface is invoked to query external results. It is provided for the retry policy interface to create non-retry policies.

Usage Description

  • Prerequisites
    • The corresponding AK/SK authentication permission is available.
    • You have applied for a developer account.

Method

This interface supports only the GET method.

URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResults?pageSize={pageSize}&pageNum={pageNum}

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

No.

Parameter

Type

Mandatory or Not

Description

1

vdnId

Integer

Yes

VDN ID.

The value is an integer ranging from 1 to 9999.

2

pageSize

Integer

Yes

Number of records on a page. The value ranges from 1 to 50.

3

pageNum

Integer

Yes

Page number. The value is greater than 0.

Request Description

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.

Response Description

Table 3 Response body parameters

No.

Parameter

Type

Description

1

resultCode

String

Error code. The value 0200000 indicates success, and other values indicate failure.

For details, see Table 5.

2

resultDesc

String

Description.

3

totalCount

Integer

Total number of external results.

4

data

List

List of external results.

5

returnCode

String

Error code. The value 0200000 indicates success, and other values indicate failure.

For details, see Table 5.

6

returnDesc

String

Description.

Table 4 data

No.

Parameter

Type

Description

1

displayResult

String

External result.

2

resultCode

String

External result code.

3

defId

String

External result ID.

Error Codes

Table 5 Error code description

No.

Error Code

Description

1

0200001

Parameter error. For details about the error, see resultDesc.

2

02000001

Empty parameter.

3

02000002

The parameter contains invalid characters.

4

02000003

The parameter length cannot exceed the maximum length.

5

02000004

The parameter length cannot be less than the minimum length.

6

02000005

The parameter length must be within the specified range.

7

02000006

Incorrect parameter type.

8

02000007

Incorrect parameter value.

9

02000008

Parameter conversion error. Check the request parameters.

10

02000009

Incorrect parameter combination. Check the request parameters.

11

02000010

The hour and minute parameters must be set at the same time.

12

02000011

The number of parameters cannot exceed the specified number.

Example

  • The following provides an example of the response body of this interface:
    {
      "returnCode": "0200000",
      "data": [
        {
          "displayResult": "6: The call is not answered.",
          "resultCode": "002",
          "defId":"12345"
        }
      ],
      "resultCode": "0200000",
      "resultDesc": "query outboundResult success",
      "totalCount": 1,
      "returnDesc": "query outboundResult success"
    }