文档首页/ 云客服/ API参考/ 电销外呼/ 外呼结果接口/ 查询外呼结果
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

查询外呼结果

场景描述

调用该接口查询指定虚拟呼叫中心下指定外呼任务的外呼结果。

使用说明

  • 前提条件
    • 已经申请了开发者账号。
  • 使用限制
    • 查询时需传入正确的vdnId。
    • 虚拟呼叫中心vdnId和外呼任务campaignId之间应存在正确的关联关系。
    • 只查询呼叫完成的外呼结果。
  1. 建议优先使用【外呼结果回调】接口。
  2. 建议该接口并发<=10，且并发批次间隔在1s以上。

接口方法

该接口仅支持POST方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresult/{campaignId}

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

表1 URL中携带的参数说明

序号

参数名

参数类型

是否必选

说明

1

vdnId

int

True

虚拟呼叫中心ID。

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

2

campaignId

int

True

外呼任务Id

请求说明

表2 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

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

2

Authorization

String

True

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

序号

参数名

参数类型

是否必选

说明

1

sessionId

String

False

标识用户的ID，外呼结果中会回传用户（最大长度为32个字符）

2

customField

String

False

用户自定义字段

3

pageSize

int

False

分页查询结果，每页查询数据条数

取值范围：

  • showDetail=1,pageSize<=100。
  • showDetail=0,pageSize<=500。

4

pageNum

int

False

当前页码。

5

showDetail

int

False

是否展示详情。

  • 0：展示外呼数据最终的呼叫结果
  • 1：展示外呼数据的详细呼叫结果

默认是0。

6

beginTime

String

False

开始时间。（格式为：YYYY-MM-DD，开始时间必须早于结束时间，开始时间和结束时间之间最多相差30天。）

如果填写beginTime，那么就必须填写endTime。

7

endTime

String

False

结束时间。（格式为：YYYY-MM-DD，开始时间必须早于结束时间，开始时间和结束时间之间最多相差30天。）

如果填写endTime，那么就必须填写beginTime。

响应说明

表4 响应体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

2

resultDesc

String

描述。

3

returnCode

String

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

4

returnDesc

String

描述。

5

totalCount

int

外呼结果总数

6

data

JSONArray

结果json，详见表5。
表5 data参数说明

序号

参数名称

参数类型

描述

6.1

campaignId

String

外呼任务的id

6.2

sessionId

String

标识用户的ID

6.3

called

String

被叫号码

6.4

callTimeStr

String

呼叫时间，格式为：yyyy-mm-dd hh:mm:ss

6.5

callStatus

int

呼叫结果（5: 呼叫失败，6: 呼叫成功）

6.6

failCode

String

失败的原因码。

6.7

resultCode

String

失败的原因码对应的外显结果码。外显结果码可以自定义，失败原因码与外显结果码相互关联。

6.8

vdnId

int

外呼号码所属VDN ID。

6.9

callId

String

通话记录ID，用于与CTI平台的话单等通话数据关联。

6.10

recordPath

String

通话录音文件的存储路径。

说明：

该字段仅在使用接续时（SAAS组网），才返回值，其他情况返回为空。

触发事件

无

错误结果码

表6 错误原因码说明

序号

错误码

说明

1

0200001

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

2

0200007

外呼活动已经不存在。

3

0200008

开始时间和结束时间不是同时存在，或者同时不存在。

4

0200009

开始时间或者结束时间的格式不正确。

5

0200010

开始时间不是早于结束时间。

6

0200011

开始时间和结束时间相差的天数超过30天。

7

02000001

参数值为空

8

02000002

参数包含非法字符

9

02000003

参数长度不能大于规定长度

10

02000004

参数长度不能小于规定长度

11

02000005

参数长度需要介于规定长度之间

12

02000006

参数值类型不正确

13

02000007

参数值大小不正确

14

02000008

参数转换异常，请检查请求参数

15

02000009

参数组合不正确，请检查请求参数

16

02000010

hour和minute必须同时存在

17

02000011

参数个数不能大于规定个数

报文样例

  • 该接口的请求消息体举例如下： 
    {
    "sessionId": "1202_test013",
    "pageSize": 500,
    "pageNum": 1
}
  • 该接口的响应消息体举例如下： 
    {
  "resultCode":"0200000",
  "resultDesc":"Query Success!",
  "returnCode":"0200000",
  "returnDesc":"Query Success!",
  "totalCount": 2,
  "data": [
      {
        "campaignId": "3",
        "sessionId": "1202_test013",
        "called": "60584",
        "callTimeStr": "2020-08-30 20:00:00",
        "callStatus": 6,
        "failCode": "0",
        "resultCode": "OB99999",
        "vdnId": 11,
        "callId": "0023-134864174",
        "recordPath": "Y:/1/11/20200830/3408/0949218.V3"
      },
      {
        "campaignId": "3",
        "sessionId": "1202_test013",
        "called": "60584",
        "callTimeStr": "2020-08-30 20:05:00",
        "callStatus": 6,
        "failCode": "0",
        "resultCode": "OB99999",
        "vdnId": 11,
        "callId": "0023-134864893",
        "recordPath": "Y:/1/11/20200830/3408/0942113.V3"
      }
    ]
}
父主题： 外呼结果接口