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

查询OBS外呼结果码

场景描述

该接口为查询OBS外呼服务器的结果码接口，为设置外呼结果码的。

使用说明

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

接口方法

该接口仅支持GET方法。

接口URI

https://ip:port/rest/isales/v1/openapi/campaigns/{vdnId}/queryOBSResultCode?pageSize={pageSize}&pageNum={pageNum}

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

表1 URL中携带的参数说明

序号

参数名

参数类型

是否必选

说明

1

vdnId

int

True

虚拟呼叫中心ID。

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

2

pageNum

int

True

页码，取值大于0

3

pageSize

int

True

表示每页的查询数量。

取值范围：1～50

请求说明

表2 请求消息头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

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

2

Authorization

String

True

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

响应说明

表3 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见表5。

2

resultDesc

String

描述。

3

totalCount

int

OBS外呼服务器的结果码的总数

4

obsCodes

LIST

外呼结果码集合

5

returnCode

String

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

具体见表5。

6

returnDesc

String

描述。
表4 obsCodes

序号

参数名

参数类型

说明

1

obsCodeDesc

String

OBS外呼结果码描述

2

obsCode

String

OBS外呼结果码。

错误结果码

表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

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

报文样例

  • 该接口的响应消息体举例如下： 
    {
  "obsCodes": [
    {
      "obsCodeDesc": "The switch is busy.",
      "obsCode": "00605"
    },
    {
      "obsCodeDesc": "The call is rejected.",
      "obsCode": "00604"
    },
    {
      "obsCodeDesc": "The called party does not answer the call.",
      "obsCode": "00603"
    },
    {
      "obsCodeDesc": "No resource available on the ACD.",
      "obsCode": "00602"
    },
    {
      "obsCodeDesc": "The ACD times out.",
      "obsCode": "00606"
    }
  ],
  "returnCode": "0200000",
  "resultCode": "0200000",
  "resultDesc": "query queryOBSResultCode Success!",
  "totalCount": 120,
  "returnDesc": "query queryOBSResultCode Success!"
}

相关文档