Help Center/ Customer Engagement Center/ API Reference/ Outbound Call Interface Reference/ Reserved Outbound Call Interfaces/ Querying the List of Reserved Outbound Call Tasks
Updated on 2025-11-13 GMT+08:00
View PDF
Share

Querying the List of Reserved Outbound Call Tasks

Prerequisites

  • You have applied for a developer account.

Scenario

This interface is invoked to query reserved outbound call tasks.

Method

This interface supports only the POST method.

URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/appoint/list

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 Parameter in the URL

No.

Parameter

Value Type

Mandatory

Description

1

vdnId

Integer

Yes

VCC ID.

The value is an integer ranging from 1 to 9999.

Request Description

Table 2 Request header parameters

No.

Parameter

Value 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 3 Request body parameters

No.

Parameter

Value Type

Mandatory

Description

1

calledNo

String

No

Called number.

2

userAccountList

Array

No

Business account of an agent or agent ID.

3

beginTime

TimeStamp

No

Start time.

4

endTime

TimeStamp

No

End time.

5

taskId

String

No

Task ID.

6

offset

Integer

Yes

Parameter for determining the start page of the query. Value of offset = Value of limit × (Value of page – 1)

7

limit

Integer

Yes

Number of query records on each page.

Response Description

Table 4 Response body parameters

No.

Parameter

Value Type

Description

1

resultCode

String

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

For details, see Table 6.

2

resultDesc

String

Description.

3

returnCode

String

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

For details, see Table 6.

4

returnDesc

String

Description.

5

totalCount

Integer

Total number of records in the returned list.

6

data

List

Table 5
Table 5 Parameter description of data

No.

Parameter

Value Type

Description

1

appointId

String

ID of a reserved outbound campaign.

2

callType

String
  1. Reservation for manual outbound calls
  2. Reservation for automatic outbound calls

3

appointTime

TimeStamp

Reservation time.

4

calledNo

String

Called number.

5

taskId

String

Task ID.

6

taskName

String

Task name.

7

taskStatus

String

Task status.

8

timeout

Boolean

Expired or not. The value true indicates the task has expired.

9

userAccount

String

Business account of an agent (or agent ID).

10

userName

String

Agent name.

11

beginTime

TimeStamp

Call start time.

12

endTime

TimeStamp

Call end time.

13

callFlag

String

Call status.

14

callerNo

String

Calling number.

15

failCode

String

Call result.

16

result

String

Call failure cause.

17

busiResult

String

Business result name.

18

createTime

TimeStamp

Task creation time.

Triggered Event

None

Error Codes

Table 6 Error code description

No.

Error Code

Description

1

0200001

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

2

0200006

Database operation error.

Example

  • The following provides an example of the request body of this interface: 
    {
    "limit" : 10,
    "offset" : 0,
    "taskId": "1106025109"

}
  • The following provides an example of the response body of this interface: 
    {
    "returnCode": "0200000",
    "data": [
        {
            "appointId": "174730253678826340158055543045",
            "callType": "2",
            "appointTime": 1747302523000,
            "calledNo": "66660001",
            "taskId": "1106025109",
            "taskName": "Preempted task",
            "taskStatus": "2",
            "timeout": true,
            "userAccount": "116",
            "userName": "116",
            "beginTime": 1747302513000,
            "endTime": 1747302523000,
            "callFlag": "2",
            "callerNo": "710002",
            "failCode": "00604",
            "result": "0101",
            "busiResult": "Reservation business result > aab",
            "createTime": 1747302536000
        }
    ],
    "resultCode": "0200000",
    "resultDesc": "success",
    "totalCount": 4,
    "returnDesc": "success"
}