更新时间:2023-09-27 GMT+08:00

创建外显结果

场景描述

该接口为创建外呼结果接口,提供给重试策略接口创建不重试策略使用。

使用说明

  • 前提条件
    • 有对应的Ak/Sk鉴权权限。
    • 已经申请了开发者账号。

接口方法

该接口仅支持POST方法。

接口URI

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

其中,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

resultCode

String

False

结果定义码,长度小于8个字符。

2

displayResult

String

True

结果外显编码。

3

obsCodes

List<String>

True

结果码定义列表,该列表可通过接口“查询OBS外呼结果码”获取。

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见表5

2

resultDesc

String

描述。

3

defId

String

创建的外显结果ID。

4

returnCode

String

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

具体见表5

5

returnDesc

String

描述。

错误结果码

表5 错误原因码说明

序号

错误码

说明

1

0200001

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

2

02000001

参数值为空

3

02000002

参数包含非法字符

4

02000003

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

5

02000004

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

6

02000005

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

7

02000006

参数值类型不正确

8

02000007

参数值大小不正确

9

02000008

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

10

02000009

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

11

02000010

hour和minute必须同时存在

12

02000011

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

报文样例

  • 该接口的请求消息体举例如下:
    {"resultCode":"007", "displayResult":"就是不接电话7", "obsCodes":["00602","00606"]}
  • 该接口的响应消息体举例如下:
    {
      "defId": "1645244637",
      "returnCode": "0200000",
      "resultCode": "0200000",
      "resultDesc": "createObResult Success!",
      "returnDesc": "createObResult Success!"
    }