文档首页/ 云客服/ API参考/ 电销外呼/ 外呼结果接口/ 查询单个外呼结果详情
更新时间:2024-09-24 GMT+08:00
分享

查询单个外呼结果详情

接口功能

调用该接口查询指定虚拟呼叫中心下指定通话的外呼结果详情。

使用说明

  1. 前提条件

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

  2. 使用限制

    – 查询时需传入正确的vdnId。

    – 虚拟呼叫中心vdnId和通话callId之间应存在正确的关联关系。

请求方法

该接口仅支持GET方法。

请求URL

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/callresultdetail/{callId}

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

表1 URL中携带的参数说明

参数名

数据类型

选取原则

说明

vdnId

int

必选

虚拟呼叫中心ID。

取值的类型为整数,取值范围为1~9999。

callId

String

必选

通话记录ID。通过查询外呼结果或者外呼结果回调接口中返回的callId字段获取。

请求消息

表2 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

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

2

Authorization

String

True

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

无请求消息体。

响应消息

该接口的响应消息体举例如下:
{
   "returnCode": "0200000", 
   "data": {
                "callId": "1644464743-1388",
                "called": "88881955",
                "callEndTime": "2022-02-10 11:45:51",
                "vdnId": 8,
                "callStatus": "6",
                "failCode": "00000",
                "resultCode": "OB99999",
                "callBeginTime": "2022-02-10 11:45:47",
                "recordPath": "https://south-aicc-develop.obs.cn-south-                                                                                                                                                                                                                                                          1.myhuaweicloud.com:443/isales/record/A68CA32800B9684811D698D1B61C1A0661511E7AD042DEE5304254DDB9DCED00/ec96a62d-f56c-4f4e-8f5e-30e7a29f38e5?AccessKeyId=ERUDBXB5GOMYURMPLKBO&Expires=1644484560&Signature=uztQO%2FxI8GOSW2GZJWCBCm8AyAg%3D",
                "ackBeginTime": "2022-02-10 11:45:43" 
            },
   "resultCode": "0200000",
   "resultDesc": "Query Success!",
   "returnDesc": "Query Success!"
}

该接口的响应消息体参数说明如表2 响应体参数说明所示。

表3 响应体参数说明

参数名

数据类型

说明

resultCode

String

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

resultDesc

String

描述。

returnCode

String

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

returnDesc

String

描述。

data

JSONObject

结果json,详见表4

表4 data参数说明

参数名称

数据类型

描述

called

String

被叫号码

ackBeginTime

String

外呼开始时间,即振铃开始时间,格式为:yyyy-mm-dd hh:mm:ss

callBeginTime

String

通话开始时间,即接通开始时间,格式为:yyyy-mm-dd hh:mm:ss

callEndTime

String

通话结束时间,即挂机时间,格式为:yyyy-mm-dd hh:mm:ss

callStatus

int

呼叫结果(5: 呼叫失败,6: 呼叫成功)

failCode

String

失败的原因码。

resultCode

String

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

vdnId

int

外呼号码所属VDN ID。

callId

String

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

recordPath

String

通话录音文件OBS的URL路径。

说明:

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

表5 错误原因码说明

序号

错误码

说明

1

0200001

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

2

0200007

通话记录ID不存在。

3

02000001

参数值为空

4

02000002

参数包含非法字符

5

02000003

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

6

02000004

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

7

02000005

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

8

02000006

参数值类型不正确

9

02000007

参数值大小不正确

10

02000008

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

11

02000009

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

12

02000010

hour和minute必须同时存在

13

02000011

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

相关文档