2.11 sip号码管理
2.11.1 创建sip号
基本信息
Path: /api/v1/config/openapi/sip/create
Method: POST
接口描述:
创建sip号 分手动添加和自动添加两种方式
请求参数
Headers
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
| abbreviate | string | 必须 | 企业缩写 | |
| ccsdirectcallflag | integer | 必须 | 是否支持硬话机外呼 0不支持 1支持 | |
| addManully | integer | 必须 | sip号是否为手动添加 0自动 1手动 | |
| sipId | string | 非必须 | 手动添加的sip号,仅在手动添加时需要传值,格式须为87开头的字符串数字 | |
| sipPassword | string | 非必须 | 手动添加的sip密码,当手动添加时必填 | |
| num | integer | 非必须 | 自动创建的个数,自动创建时必填 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
| msg | string | 必须 | 返回消息 | |
| code | integer | 必须 | 返回码 | |
| data | object [] | 非必须 | 创建成功的sip号列表 | |
| ├─ sipNumber | string | 非必须 | 成功添加的sip号 | |
| ├─ sipPassword | string | 非必须 | 成功添加的sip密码 |
2.11.2 修改sip信息
基本信息
Path: /api/v1/config/openapi/sip/edit
Method: POST
接口描述:
修改sip号相关信息
请求参数
Headers
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 公司缩写 | ||
| oldSipId | string | 必须 | 老的sip号 | ||
| ccsdirectcallflag | integer | 非必须 | 是否支持硬化机(0:不支持,1:支持) | ||
| sipId | string | 非必须 | 新的sip号 | ||
| sipPassword | string | 非必须 | sip密码 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 信息提示 | ||
| code | integer | 必须 | 操作状态0为成功 |
2.11.3 删除sip号
基本信息
Path: /api/v1/config/openapi/sip/del
Method: POST
接口描述:
删除sip号,如果有sip号已经被坐席绑定那么删除失败。
请求参数
Headers
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 公司缩写 | ||
| sipIds | string[] | 必须 | sipId的列表 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 信息提示 | ||
| code | integer | 必须 | 操作状态0为成功 |
2.11.4 查询单个sip号
基本信息
Path: /api/v1/config/openapi/sip/one
Method: POST
接口描述:
查询单个sip号详情
请求参数
Headers
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| sipId | string | 必须 | sip号码 |
返回数据:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
| msg | string | 必须 | 返回消息 | |
| code | integer | 必须 | 返回码 | |
| data | object [] | 非必须 | 创建成功的sip号列表 | |
| ├─ id | integer | 非必须 | 唯一id | |
| ├─ sipId | string | 非必须 | sip号码 | |
| ├─ sipPassword | string | 非必须 | sip注册密码 | |
| ├─ utime | integer | 非必须 | 更新时间(秒级时间戳) | |
| ├─ associated | integer | 非必须 | 是否被关联(0:未关联,1:已关联) | |
| ├─ sipDomain | string | 非必须 | sip注册地址 | |
| ├ ccsdirectcallflag | integer | 非必须 | ccs是否支持硬话机外呼(0:不允许;1:允许) |
2.11.5 查询sip号列表
基本信息
Path: /api/v1/config/openapi/sip/page
Method: POST
接口描述:
批量查询sip号信息
请求参数
Headers
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| pageNumber | integer | 非必须 | 当前页码 | ||
| pageSize | integer | 非必须 | 每页显示条数 |
返回数据:
| 名称 | 类型 | 是否必须 | 默认值 | 备注 |
| msg | string | 必须 | 返回消息 | |
| code | integer | 必须 | 返回码 | |
| data | object [] | 非必须 | 创建成功的sip号列表 | |
| ├─ pageSize | integer | 非必须 | 分页大小 | |
| ├─ total | integer | 非必须 | 总记录数 | |
| ├─ pageNumber | integer | 非必须 | 页数 | |
| ├─ pageTotal | integer | 非必须 | 总页数 | |
| ├─ result | object [] | 具体的sip信息列表 | ||
| result├─ id | integer | 非必须 | id | |
| result├─ sipId | string | 非必须 | sip号码 | |
| result├─ sipPassword | string | 非必须 | sip注册密码 | |
| result├─ utime | integer | 非必须 | 更新时间(秒级时间戳) | |
| result├─ associated | integer | 非必须 | 是否被关联(0:未关联,1:已关联) | |
| result├─ sipDomain | string | 非必须 | sip注册地址 | |
| result├─ ccsdirectcallflag | integer | 非必须 | ccs是否支持硬话机外呼(0:不允许;1:允许) |