2. 应用管理接口


2.1 绑定

接口功能:号码绑定接口

请求方向:第三方应用平台 → 小号平台(服务端)。

请求方法:POST

请求 URI:http://{BaseUrl}/api/bind

请求消息体:

参数名 类型 最大长度 是否可选 解 释
telx String 11 可选 虚拟小号, 长度为 11 位的手机号码, 不传的时候会自动选择一个号码
tela String 15 必选 被叫号码
expiration Int 11 可选 单位为秒
record String 1 可选 可选值 0 或 1, 1 代表录音,0 代表不录音, 默认为录音
region String 32 可选 区号, 设置后会获取指定区号的号码
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

响应消息:

{
  "success": true,
  "code": 200,
  "msg": "绑定成功",
  "data": {}
}

2.2 解绑

接口功能:号码解绑接口

请求方向:第三方应用平台 → 小号平台(服务端)。

请求方法:POST

请求 URI:http://{BaseUrl}/api/unbind

请求消息体:

参数名 类型 最大长度 是否可选 解 释
subid String 32 必选 绑定关系 id
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

响应消息:

{
  "success": true,
  "code": 200,
  "msg": "解绑成功",
  "data": {}
}

2.3 获取小号列表

接口功能:查询应用下面所有的小号

请求方向:第三方应用平台 → 小号平台(服务端)。

请求方法:POST

请求 URI:http://{BaseUrl}/query/number

请求消息体:

参数名 类型 最大长度 是否可选 解 释
page String 10 可选 按照每页 100 条进行分页,小号数量超过 100 条则需要分页获取,默认值为 1
pagenum String 10 可选 每页条数,默认 20 条
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

响应消息:

{
  "success": true,
  "code": 200,
  "msg": "",
  "data": {
    "count": 100,
    "pagecount": 2,
    "page": 1,
    "list": [
      {
        "number": "17130700000",
        "area": "",
        "regioncode": "0771",
        "begin": "2018-04-25 20:15:21"
      }
    ]
  }
}

// count:号码总数
// number:为虚拟小号
// area:区域
// regioncode:代表区号
// begin: 小号开始时间
// page: 代表当前是第几页

2.4 查询号码绑定日志

接口功能:查询号码的绑定日志

请求方向:第三方应用平台 → 小号平台(服务端)。

请求方法:POST

请求 URI:http://{BaseUrl}/query/bindlog

请求消息体:

参数名 类型 最大长度 是否可选 解 释
number String 11 可选 虚拟小号
timestart String 10 可选 查询的开始时间
timeend String 10 可选 查询的结束时间
page String 10 可选 页数
pagenum String 10 可选 每页条数,默认 20 条
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

响应消息:

{
  "success": true,
  "code": 200,
  "msg": "",
  "data": {
    "count": 100,
    "pagecount": 2,
    "list": [
      {
        "number": "17100000000",
        "tela": "17100000001",
        "op": "",
        "optime": "2018-05-16 11:03:39",
        "subid": "5af19948-bbb7-4dc2-a9cb-50be3e1a0000",
        "recording": "0",
        "expiration": ""
      }
    ],
    "page": 1
  }
}

// number:虚拟小号
// tela: 绑定的号码
// op 操作
// optime 操作的时间
// subid:绑定标志
// recording: 0代表不录音,1代表录音
// expiration:绑定结束时间

2.5 查询号码的通话记录

接口功能:查询号码的通话记录

请求方向:第三方应用平台 → 小号平台(服务端)。

请求方法:POST

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

请求消息体:

参数名 类型 最大长度 是否可选 解 释
calling String 15 可选 主叫号码
called String 15 可选 被叫号码
timestart String 10 可选 查询的开始时间
timeend String 10 可选 查询的结束时间
page String 10 可选 页数
pagenum String 10 可选 每页条数,默认 20 条
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

响应消息:

{
  "success": true,
  "code": 200,
  "msg": "",
  "data": {
    "count": 1,
    "pagecount": 2,
    "list": [
      {
        "xnumber": "17100000000",
        "calling": "17100000001",
        "called": "17100000002",
        "StartTime": "2018-05-16 11:03:39",
        "endTime": "",
        "ReleaseReason": "...",
        "callid": "...",
        "Duration": "20",
        "subid": "",
      }
    ],
    "page": 1
  }
}

// xnumber: 虚拟小号
// calling: 主叫号码
// called: 被叫号码
// Starttime: 通话开始时间
// endTime 通话结束时间
// ReleaseReason: 结束原因
// callid: 通话唯一id
// Duration: 通话时长
// subid: 绑定关系id
文档更新时间: 2021-06-03 10:00   作者:admin