Help Center/ Cognitive Engagement Center/ API Reference/ Telemarketing Outbound Call Interface Reference/ Outbound Call Data Interfaces/ Querying Outbound Numbers
Updated on 2023-09-27 GMT+08:00
View PDF
Share

Querying Outbound Numbers

Prerequisites

You have applied for a developer account.

Scenario

This interface is invoked to query numbers and their attributes in outbound call data of a specified task.

Method

This interface supports only the GET method.

URI

/rest/isales/v1/openapi/campaigns/{vdnId}/calldata/{campaignId}/{dataId}

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

campaignId

Integer

Yes

ID of an outbound campaign.

3

dataId

Integer

Yes

Outbound call data ID.

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.

No request body exists.

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 7.

2

resultDesc

String

Description.

3

returnCode

String

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

For details, see Table 7.

4

returnDesc

String

Description.

5

data

Object

Numbers and attributes of the data record.

For details, see Table 4.
Table 4 Parameter description of data

No.

Parameter

Type

Description

5.1

dataId

String

Outbound call data ID.

5.2

properties

List

Business attribute.

For details, see Table 5.

5.3

calledNos

List

Outbound number.

For details, see Table 6.
Table 5 Data description of properties

No.

Parameter

Type

Description

5.2.1

propCode

String

Attribute code.

5.2.2

propName

String

Attribute name.

5.2.3

propValue

The data type depends on the specific attribute type.

Attribute value.
Table 6 Data description of calledNos

No.

Parameter

Type

Description

5.3.1

calledNo

String

Outbound number.

5.3.2

type

String

Number type.

Triggered Event

None

Error Codes

Table 7 Error code description

No.

Error Code

Description

1

0200001

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

2

0200007

The outbound campaign 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.

Example

  • The following provides an example of the request body of this interface:

    None

  • The following provides an example of the response body of this interface: 
    {
    "returnCode": "0200000",
    "data": {
        "dataId": "11330737561851183104",
        "calledNos": [
            {
                "calledNo": "88881951",
                "type": null
            }
        ],
        "properties": [
            {
                "propValue": "12312",
"propName": "Attribute 1",
                "propCode": "1"
            },
            {
                "propValue": "123",
"propName": "Attribute 2",
                "propCode": "12"
            },
            {
                "propValue": null,
"propName": "Attribute 3",
                "propCode": "123"
            }
        ]
    },
    "resultCode": "0200000",
    "resultDesc": "query data success",
    "returnDesc": "query data success"
}