更新时间:2023-12-19 GMT+08:00

查询租户下外呼任务列表接口

场景描述

查询租户下外呼任务列表接口,返回任务信息。

注意:该接口需要配套部署isales服务模块。

接口方法

设置成“POST”。该接口仅支持POST方法,不支持PUT、GET和DELTE等方法。

请求URL

https://ip:port/rest/cmsapp/v1/openapi/fromisales/querytasks

其中,公有云环境请联系管理员获取,ip为CC-CMS服务器地址,port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务,ip请填写NSLB的服务器地址,port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

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

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式

表2 消息体参数说明

参数名

数据类型

是否必选

说明

ccId

int

False

呼叫中心编号,取值范围:1~65535

  • 集成环境,默认值为系统管理员登录AICC系统后,通过配置中心 > 系统管理 > CMS系统配置查看的呼叫中心编号。若该配置为空,取值数据库t_cms_sysparam表中的sys_key="default_cc_id",sys_type="cms_system_config"对应的数据。
  • 独立部署环境,默认值为系统管理员登录AICC系统后,通过配置中心 > 系统管理 > 参数配置查看“默认呼叫中心标识”的值。

vdn

int

True

虚拟呼叫中心编号。取值范围:1~5000

limit

int

False

分页大小。不选默认10,最大查询100条

offset

int

False

分页起始位。不选默认0

响应消息

表3 消息体参数说明

参数名

数据类型

说明

resultCode

string

查询结果。取值如下:

  • "0100000":成功
  • 其他:失败

失败的原因说明请参见错误码参考

resultDesc

array

查询成功后,返回结果信息的对象数组。

响应消息体参数请参考表4

表4 响应消息体参数说明

参数名

数据类型

说明

count

int

任务总数。

tasks

JSONArray

任务列表。

tasks对象参数说明请参考表5

表5 tasks对象参数说明

参数名

数据类型

说明

taskId

String

任务Id。

taskName

String

任务名称。

taskType

String

任务类型。

1:智能外呼

2:预测外呼

3:自动外呼

4:人工外呼

5:预览外呼

beginDate

String

开始时间,CC-iSales前台用户写入的时间

endDate

String

结束时间,CC-iSales前台用户写入的时间

status

String

任务状态。

2:执行中

3:暂停

4:完成

样例报文

  • 请求头:
    Content-Type: application/json;charset=UTF-8
    Authorization: ******************
  • 请求参数:
    {
        "ccId": "89",
        "vdn":92,
        "limit":10,
        "offset":0
    }
  • 响应参数:
    {
        "resultCode": "0100000",
        "resultDesc": {
            "count": 14,
            "tasks": [
                {
                    "beginDate": "2021-02-03",
                    "taskType": "4",
                    "endDate": "2021-02-04",
                    "taskName": "1",
                    "taskId": "1088825198",
                    "status": "1"
                },
                {
                    "beginDate": "2021-02-04",
                    "taskType": "4",
                    "endDate": "2021-02-28",
                    "taskName": "2",
                    "taskId": "1312452402",
                    "status": "1"
                }
    .......
            ]
        }
    }