分机管理接口

新建分机

URL

  1. POST {BASE_URL}/callcenter/extension

请求参数

参数 有效值范围 必填 说明
type 整数，分机类型枚举值 √ 分机类型
user 6~12数字 SIP 注册用户名，仅用于 type==1的情况
password 6~12字母数字位字符串 SIP 注册用密码，仅用于 type==1的情况
ipaddr <ip>[:port] SIP 网关IP地址与端口，默认5060，仅用于 type==2的情况
telnum 电话号码 仅用于 type==3 的情况

type参数

分机类型

枚举值 说明
1 SIP 终端。如IP电话、软电话。
2 SIP 网关。
3 电话。普通电话，如手机、固话。

!!! warning 目前仅仅支持 1

回复参数

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data JSON 对象 返回数据对象，参见data对象属性列表

data对象属性列表

属性 有效值范围 说明
id UUID HEX 字符串 新建的分机的 ID
type 见分机类型 分机类型
user SIP 注册用户名 注：注册成功的user是：应用的编号做为前缀+用户传的user参数
user 6~12字母数字位字符串 SIP 注册用密码
ipaddr <ip>[:port] SIP 网关IP地址与端口，默认5060
telnum 电话号码 电话号码

新建分机示例

请求:

  1. POST {BASE_URL}/新建分机 HTTP/1.1
  2. Content-Type: application/json
  3. Accept-Type: application/json
  5. {
  6.     "user":"78541",
  7.     "password":"123456",
  8.     "type":1
  9. }

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.     "id": "8a2bc67258d1c8720158d1f85aec000b",
  10.     "type": "1",
  11.     "user": "1000178541",
  12.     "password": "123456",
  13.     "ipaddr": null,
  14.     "telnum": null
  15.   }
  16. }

删除分机

请求

URL

  1. DELETE {BASE_URL}/callcenter/extension/{extension_id}

请求参数列表

无

回复

回复参数列表

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data JSON 对象 null

删除分机示例

请求:

  1. DELETE {BASE_URL}/callcenter/extension/40288aca5886052a0158863f63d60000 HTTP/1.1

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": null
  9. }

无

列出分机

请求

URL

  1. GET {BASE_URL}/callcenter/extension[/{extension_id}]

请求参数列表

参数 有效值范围 必填 默认值 说明
pageNo 有效页数 否 1 当获取多个时有效，第几页
pageSize 小于2000 否 20 当获取多个时有效，每一页的记录数

回复

回复参数列表

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data 分机数据或分页数据 见示例和参数详解

参数详解

分机元素属性列表
参数 有效值范围 说明
type 整数，分机类型枚举值 分机类型
user 6~12字母数字位字符串 SIP 注册用户名，仅用于 type==1的情况
password 6~12字母数字位字符串 SIP 注册用密码，仅用于 type==1的情况
ipaddr <ip>[:port] SIP 网关IP地址与端口，默认5060，仅用于 type==2的情况
telnum 电话号码 仅用于 type==3 的情况

请求单个:

  1. GET {BASE_URL}/callcenter/extension/40288aca586222110158622286590000 HTTP/1.1

响应单个:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.     "id": "40288aca586222110158622286590000",
  10.     "type": "1",
  11.     "user": "hahaha",
  12.     "password": "123456",
  13.     "ipaddr": null,
  14.     "telenum": null
  15.   }
  16. }

请求多个:

  1. GET {BASE_URL}/callcenter/extension?pageNo=1&pageSize=10 HTTP/1.1

响应多个:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.     "pageSize": 10, //每一页的记录数
  10.     "startIndex": 1, //从第几条开始
  11.     "totalCount": 8, //总记录数
  12.     "totalPageCount": 1, //总页数
  13.     "currentPageNo": 1, //当前页数
  14.     "result": [
  15.           {"id": "40288aca586222110158622286590000","type": "1","user": "hahaha","password": "123456","ipaddr": null,"telenum": null},
  16.           {"id": "40288aca587659820158765c56d30002","type": "1","user": "hahaha23","password": "123456","ipaddr": null,"telenum": null},
  17.           {"id": "40288aca587659820158765c4aa60001","type": "1","user": "hahaha2","password": "123456","ipaddr": null,"telenum": null},
  18.           {"id": "40288aca587659820158765c305f0000","type": "1","user": "hahaha1","password": "123456","ipaddr": null,"telenum": null},
  19.           {"id": "40288aca587659820158765c64e80003","type": "1","user": "hahaha234","password": "123456","ipaddr": null,"telenum": null},
  20.           {"id": "40288aca587659820158765c70010004","type": "1","user": "hahaha2345","password": "123456","ipaddr": null,"telenum": null},
  21.           {"id": "40288aca587659820158765c7b280005","type": "1","user": "hahaha23456","password": "123456","ipaddr": null,"telenum": null},
  22.           {"id": "40288aca587659820158765c83df0006","type": "1","user": "hahaha234567","password": "123456","ipaddr": null,"telenum": null}
  23.         ]
  24.   }
  25. }