1 点击呼叫

接口功能: A 手机(营销人员)<---平台--->B 手机(客户)

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/voice/dial

请求消息体:

参数名 类型 最大长度 是否可选 解 释
callerNbr String 20 必选 主叫号码
calleeNbr String 20 必选 被叫号码
maxduration Int 可选 最大通话时长,单位(分钟), 如果接口没有设置, 则使用号码设置的最大通话时长,默认值为 0, 表示不限制
uuid String 200 可选 自定义的唯一 id, 允许是数字, 字母和下划线, 中划线, + = /, 支持 base64
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

参数说明:

参数名不区分大小写

响应消息:

{
  "success": true,
  "code": 200,
  "msg": ""
}





2 通话记录接口

接口功能: 返回当前应用的通话记录列表

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/cdr/lists

请求消息体:

参数名 类型 最大长度 是否可选 解 释
timestart Int 11 可选 查询的开始时间, 格式如下: 1591242125
timeend Int 11 可选 查询的结束时间, 格式如下: 1591242199
callerNbr String 20 可选 查询通话记录的主叫号码
calleeNbr String 20 可选 查询通话记录的被叫号码
page Int 11 可选 当前页数
pagenum Int 11 可选 每页查询的数量,最大为 100

参数说明:

参数名不区分大小写

响应消息:

{
  "success": true,
  "msg": "",
  "code": 200,
  "data": {
    "count": 205,
    "pagecount": 21,
    "page": 1,
    "list": [
      {
        "callIdentifier": "CAE-20200527202311-12015692",
        "bindNum": "+8697171483**",
        "caller": "+8697171483**",
        "callee": "+86130809211**",
        "Duration": "0",
        "callerStartTime": "2020-05-27 20:23:11",
        "callerAlertingTime": "2020-05-27 20:23:23",
        "callerAnswerTime": "",
        "ulFailReason": "520",
        "calleeStartTime": "",
        "calleeAlertingTime": "",
        "calleeAnswerTime": "",
        "callEndTime": "2020-05-27 20:23:23",
        "isRecord": "0",
        "recordUrl": "http://v-record.mixcom.cn/record/download?icid=CAE-20200527202311-12015692&appkey=691aa6a934e6962b589ca7c22ebe****&sign=2c534e8518e084836be4c657d8f298062d81****"
      },
      {
        "callIdentifier": "CAE-20200527202152-12005561",
        "bindNum": "+8697175363**",
        "caller": "+8697175363**",
        "callee": "+86130809211**",
        "Duration": "0",
        "callerStartTime": "2020-05-27 20:21:52",
        "callerAlertingTime": "2020-05-27 20:22:17",
        "callerAnswerTime": "",
        "ulFailReason": "520",
        "calleeStartTime": "",
        "calleeAlertingTime": "",
        "calleeAnswerTime": "",
        "callEndTime": "2020-05-27 20:22:17",
        "isRecord": "0",
        "recordUrl": "http://v-record.mixcom.cn/record/download?icid=CAE-20200527202152-12005561&appkey=691aa6a934e6962b589ca7c22ebe****&sign=fd9452bfa981f9505a03cd706a94f3ac7aec****"
      }
    ]
  }
}

// success 为true表示成功, false表示失败
// data为具体返回的数据
// data中count为数据的总的数量
// data中pagecount为分页的总的数量
// data中page为当前所在的页数
// data中list为具体数据, 数据格式客参照通话记录推送的格式说明





3 详细账单接口

接口功能: 返回当前应用的计费的数据列表

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/billing/lists

请求消息体:

参数名 类型 最大长度 是否可选 解 释
timestart Int 11 可选 查询的开始时间, 格式如下: 1591242125
timeend Int 11 可选 查询的结束时间, 格式如下: 1591242199
page Int 11 可选 当前页数
pagenum Int 11 可选 每页查询的数量,最大为 100

参数说明:

参数名不区分大小写

响应消息:

{
  "success": true,
  "msg": "",
  "code": 200,
  "data": {
    "count": 205,
    "pagecount": 21,
    "page": 1,
    "list": [
      {
        "charge": "-0.1",
        "price": "0.1",
        "caller": "+86187108061**",
        "called": "+86185919882**",
        "number": "+8697171476**",
        "uniqueid": "CAE-20200527195518-12012464",
        "duration": "8",
        "minute": "1",
        "starttime": "2020-05-27 19:55:40"
      },
      {
        "charge": "-0.1",
        "price": "0.1",
        "caller": "+86183925567**",
        "called": "+86158092328**",
        "number": "+8697171496**",
        "uniqueid": "CAE-20200527195429-12021939",
        "duration": "24",
        "minute": "1",
        "starttime": "2020-05-27 19:55:00"
      }
    ]
  }
}

// success 为true表示成功, false表示失败
// data为具体返回的数据
// data中count为数据的总的数量
// data中pagecount为分页的总的数量
// data中page为当前所在的页数
// data中list为具体数据

// charge 表示实际扣费
// price 表示单价
// caller 表示主叫号码
// called 表示被叫号码
// number 表示中间号码
// uniqueid 表示唯一的id
// duration 表示通话时长
// minute 表示实际的计费时长
// starttime 表示通话开始的时间





4 日结报表数据

接口功能: 返回当前应用每日的报表数据

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/report/day

请求消息体:

参数名 类型 最大长度 是否可选 解 释
daystart String 10 可选 查询的开始日期, 格式如下: 2020-06-01
dayend String 10 可选 查询的结束日期, 格式如下: 2020-07-01
page Int 11 可选 当前页数
pagenum Int 11 可选 每页查询的数量,最大为 100

参数说明:

参数名不区分大小写

响应消息:

{
  "success": true,
  "msg": "",
  "code": 200,
  "data": {
    "count": 1,
    "pagecount": 1,
    "page": 1,
    "list": [
      {
        "day": "2020-06-09",
        "num": "12",
        "answercall": "0",
        "totalcall": "0",
        "money": "0"
      }
    ]
  }
}

// success 为true表示成功, false表示失败
// data为具体返回的数据
// data中count为数据的总的数量
// data中pagecount为分页的总的数量
// data中page为当前所在的页数
// data中list为具体数据

// day 表示日期
// num 表示总的通话分钟数
// answercall 总的接通次数
// totalcall 总的呼叫次数
// money 总的费用





5 月结报表数据

接口功能: 返回当前应用指定年份的报表数据

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/report/month

请求消息体:

参数名 类型 最大长度 是否可选 解 释
year String 10 可选 格式如下: 2020

参数说明:

参数名不区分大小写

响应消息:

{
  "success": true,
  "msg": "",
  "code": 200,
  "data": {
    "list": [
      {
        "month": "2020-03",
        "num": "3000",
        "answercall": "2000",
        "totalcall": "4000",
        "money": "-300.0000"
      },
      {
        "month": "2020-04",
        "num": "3000",
        "answercall": "2000",
        "totalcall": "4000",
        "money": "-300.0000"
      },
      {
        "month": "2020-05",
        "num": "3000",
        "answercall": "2000",
        "totalcall": "4000",
        "money": "-300.0000"
      }
    ]
  }
}
// success 为true表示成功, false表示失败
// data为具体返回的数据
// data中list为具体数据

// month 表示月份
// num 表示该月总的通话分钟数
// answercall 该月总的接通次数
// totalcall 该余额总的呼叫次数
// money 该月总的费用





6 查询账户余额

接口功能: 返回当前应用对应的账户的余额

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/balance/get

请求消息体:

无参数

响应消息:

{
  "success": true,
  "msg": "",
  "code": 200,
  "data": "-642.75"
}
// success 为true表示成功, false表示失败
// data为具体返回的金额





7 充值扣款记录接口

接口功能: 返回当前应用对应的账户的充值扣款记录

请求方向: 第三方应用平台 → 一键呼叫平台(服务端)

请求方法: POST

请求 URI: http://{BaseUrl}/recharge/lists

请求消息体:

参数名 类型 最大长度 是否可选 解 释
timestart Int 11 可选 查询的开始时间, 格式如下: 1591242125
timeend Int 11 可选 查询的结束时间, 格式如下: 1591242199
page Int 11 可选 当前页数
pagenum Int 11 可选 每页查询的数量,最大为 100

参数说明:

参数名不区分大小写

响应消息:

{
  "success": true,
  "msg": "",
  "code": 200,
  "data": {
    "count": 10,
    "pagecount": 1,
    "page": 1,
    "list": [
      {
        "dealtime": "2020-06-02 15:12:41",
        "type": "3",
        "money": "5.0000",
        "remark": "测试",
        "desc": "充值"
      },
      {
        "dealtime": "2020-06-02 15:02:10",
        "type": "2",
        "money": "-10.0000",
        "remark": "测试",
        "desc": "扣款"
      }
    ]
  }
}

// success 为true表示成功, false表示失败
// data为具体返回的数据
// data中count为数据的总的数量
// data中pagecount为分页的总的数量
// data中page为当前所在的页数
// data中list为具体数据

// dealtime 表示交易发生的时间
// type 表示类型, 2为扣款, 3为充值
// money 表示交易发生的金额
// remark 交易的备注
// desc type类型的文字说明
文档更新时间: 2021-08-07 04:14   作者:admin