文档首页/ 云客服/ API参考/ 电销外呼/ 查询接口调用记录
更新时间:2023-09-27 GMT+08:00

查询接口调用记录

场景描述

该接口为查询第三方接口调用细节的接口,提供给需要查询接口调用记录的场景使用

使用说明

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

接口方法

该接口仅支持POST方法。

接口URI

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

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

offset

int

True

offset用于确定查询的起始页。

offset取值为:offset=limit*(page-1)

page为需要查询的起始页。

2

limit

int

True

表示每页的查询数量。取值范围:1~100

3

url

String

False

调用url

该参数有值,查询当前url的调用记录。

该参数为空时,查询所有接口调用记录。

4

beginTime

String

True

开始时间

格式:yyyy-MM-dd HH:mm:ss

5

endTime

String

True

结束时间

格式:yyyy-MM-dd HH:mm:ss

结束时间和开始时间间隔不大于7天

响应说明

表4 消息体参数说明

序号

参数名

参数类型

说明

1

resultCode

String

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

具体见下表6 错误原因码说明

2

resultDesc

String

描述。

3

result

OpenapiLog

场景类型列表

4

returnCode

String

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

具体见表6

5

returnDesc

String

描述。

表5 OpenapiLog

序号

参数名

参数类型

说明

1

id

String

日志id

2

operTime

Datetime

日志时间

3

url

String

调用url

4

request

Object

输入参数

5

resultCode

String

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

具体见表6

6

resultDesc

String

描述。

7

httpStatus

int

接口调用状态码

8

type

String

请求类型

错误结果码

表6 错误原因码说明

序号

错误码

说明

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

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

报文样例

  • 该接口的请求消息体举例如下:
    {"limit": 10,"offset": 0,"beginTime": "2022-08-20 15:55:55","endTime": "2022-08-23 15:55:55","url":""}
  • 该接口的响应消息体举例如下:
    {
      "result": [
        {
          "request": "{\"defId\":\"456\",\"vdnId\":2}",
          "httpStatus": 200,
          "resultCode": "0200000",
          "id": "166088991109059950708365448582",
          "resultDesc": "queryObsResultDetail success",
          "url": "/rest/isales/v1/openapi/campaigns/2/456/queryObsResultDetail",
          "operTime": "2022-08-19T14:18:31.000+00:00",
          "type": "GET"
        }
      ],
      "returnCode": "0200000",
      "resultCode": "0200000",
      "count": 1,
      "resultDesc": "queryCalllogs success",
      "returnDesc": "queryCalllogs success"
    }