文档首页/ 云客服/ API参考/ 外呼类接口参考/ 预约外呼接口/ 查询预约外呼任务列表
更新时间：2025-11-13 GMT+08:00
查看PDF
分享

查询预约外呼任务列表

前置条件

  • 已经申请了开发者账号。

场景描述

通过该接口查询预约外呼任务。

接口方法

该接口仅支持POST方法。

接口URL

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

其中，ip为CC-iSales服务器地址，port为CC-iSales服务器的HTTPS端口号。

表1 URL中携带的参数说明

序号

参数名

参数类型

是否必选

说明

1

vdnId

int

True

虚拟呼叫中心ID。

取值的类型为整数，取值范围为1～9999。

请求说明

表2 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
表3 请求消息体参数说明

序号

参数名

参数类型

是否必选

说明

1

calledNo

String

False

被叫号码

2

userAccountList

Array

False

座席业务帐号或者坐席工号

3

beginTime

TimeStamp

False

开始时间

4

endTime

TimeStamp

False

结束时间

5

taskId

String

False

任务id

6

offset

int

True

offset用于确定查询的起始页。offset取值为：offset=limit*(page-1)

7

limit

int

True

表示每页的查询数量。

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

原因码。0200000表示成功，其他表示失败。

具体见表6。

2

resultDesc

String

描述。

3

returnCode

String

原因码。0200000表示成功，其他表示失败。

具体见表6。

4

returnDesc

String

描述。

5

totalCount

int

返回列表中结果总条数。

6

data

List

表5 data参数说明
表5 data参数说明

序号

参数名

参数类型

说明

1

appointId

String

预约活动ID

2

callType

String
  1. 预约手动外呼
  2. 预约自动外呼

3

appointTime

TimeStamp

预约时间

4

calledNo

String

被叫号码

5

taskId

String

任务id

6

taskName

String

任务名称

7

taskStatus

String

任务状态

8

timeout

boolean

是否过期 true：过期

9

userAccount

String

员工业务账号（或座席工号）

10

userName

String

座席名称

11

beginTime

TimeStamp

呼叫执行时间

12

endTime

TimeStamp

呼叫结束时间

13

callFlag

String

呼叫状态

14

callerNo

String

主叫号码

15

failCode

String

呼叫结果

16

result

String

呼叫失败原因

17

busiResult

String

业务结果名称

18

createTime

TimeStamp

预约任务创建时间

19

remark

String

备注信息

触发事件

无

错误结果码

表6 错误原因码说明

序号

错误码

说明

1

0200001

参数异常，异常详情在resultDesc中描述。

2

0200006

数据库操作异常。

报文样例

  • 该接口的请求消息体举例如下： 
    {
    "limit" : 10,
    "offset" : 0,
    "taskId": "1106025109"

}
  • 该接口的响应消息体举例如下： 
    {
    "returnCode": "0200000",
    "data": [
        {
            "appointId": "174730253678826340158055543045",
            "callType": "2",
            "appointTime": 1747302523000,
            "calledNo": "66660001",
            "taskId": "1106025109",
            "taskName": "预占",
            "taskStatus": "2",
            "timeout": true,
            "userAccount": "116",
            "userName": "116",
            "beginTime": 1747302513000,
            "endTime": 1747302523000,
            "callFlag": "2",
            "callerNo": "710002",
            "failCode": "00604",
            "result": "0101",
            "busiResult": "预约业务结果>aab",
            "createTime": 1747302536000
        }
    ],
    "resultCode": "0200000",
    "resultDesc": "success",
    "totalCount": 4,
    "returnDesc": "success"
}
父主题： 预约外呼接口

相关文档