2.1 坐席管理
2.1.1 创建坐席
基本信息
Path： /api/v1/config/openapi/agent/create/v2
Method： POST
接口描述：
创建坐席，默认返回分机号码和分机密码。创建后的坐席，需要加入到技能组才能进行外呼操作。
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| afterInterval | integer | 非必须 | 0 | 话后时长（单位：s） | 最小值: 0 |
| batchFlag | integer | 非必须 | 0 | 是否批量创建坐席， 0：不批量创建；1：批量连续创建 | 最大值: 1 最小值: 0 |
| batchSize | integer | 非必须 | 1 | 批量创建的数量 | 最大值: 1000 最小值: 1 |
| bindcode | string | 非必须 | 真实的电话号 | ||
| companyId | integer | 非必须 | 企业id | ||
| string | 非必须 | 邮箱 | |||
| isHidePhone | integer | 非必须 | 0 | 是否隐藏号码 0否 1是 | 最大值: 1 最小值: 0 |
| isaudio | integer | 非必须 | 1 | 支持语音:0:不支持；1：支持 | 最大值: 1 最小值: 0 |
| ismessage | integer | 非必须 | 1 | 支持即时消息；0：不支持；1：支持 | 最大值: 1 最小值: 0 |
| isrecord | integer | 非必须 | 1 | 是否录音：0：不启用；1：启用 | 最大值: 1 最小值: 0 |
| isvideo | integer | 非必须 | 0 | 支持视频:0:不支持；1：支持 | 最大值: 1 最小值: 0 |
| judge | integer | 非必须 | 1 | 是否服务评价：0：否；1：是 | 最大值: 1 最小值: 0 |
| name | string | 非必须 | 坐席姓名 | ||
| operatorId | string | 非必须 | 坐席工号 | ||
| operatorType | integer | 非必须 | 0 | 座席类型：0:普通座席；1：班长 | 最大值: 1 最小值: 0 |
| outcallflag | integer | 非必须 | 0 | 外呼标志 0：允许外呼 1：限制长话 2：禁止外呼 3：限制国际 | 最大值: 3 最小值: 0 |
| password | string | 非必须 | 坐席密码 默认随机6位密码，若传以传递的为准 | 最大长度: 32 最小长度: 6 | |
| showcaller | string | 非必须 | 主叫显示号码 | ||
| sipFlag | integer | 非必须 | 1 | 是否关联sip号码 0：不关联，1：关联 | 最大值: 1 最小值: 0 |
| ttscontent | string | 非必须 | 播放内容 | ||
| roleName | string | 非必须 | 角色名称（新增允许指定坐席角色名称，如果不指定，则从指定类型中随机选取一个） | ||
| bindSkillName | string | 非必须 | 绑定技能名称 | ||
| bindSkillLevel | integer | 非必须 | 0 | 绑定技能等级（值越大，优先级越高） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object [] | 非必须 | item 类型: object | ||
| ├─ operatorPassword | string | 非必须 | 坐席密码 | ||
| ├─ sipNumber | string | 非必须 | sip账号 | ||
| ├─ operatorId | string | 非必须 | 坐席工号 | ||
| ├─ sipPassword | string | 非必须 | 坐席密码 |
2.1.2 修改坐席
基本信息
Path： /api/v1/config/openapi/agent/edit/v2
Method： POST
接口描述：
修改坐席
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| afterInterval | integer | 非必须 | 话后空闲时长 | 最小值: 1 | |
| bindcode | string | 非必须 | 绑定的电话号 | ||
| companyId | integer | 非必须 | 企业id | ||
| name | string | 非必须 | 坐席名称 | ||
| operatorId | string | 必须 | 坐席工号 | ||
| operatorType | integer | 非必须 | 座席类型：0:普通座席1：班长 | 最大值: 1 最小值: 0 | |
| password | string | 非必须 | 坐席密码 | ||
| showcaller | string | 非必须 | 主叫显示号码 | ||
| sipnumber | string | 非必须 | 绑定sip账号，若unbindSip=1时，忽略该参数绑定 | ||
| status | integer | 非必须 | 是否启用 0：关闭，1：开通 | 最大值: 1 最小值: 0 | |
| ttscontent | string | 非必须 | 播放内容 | ||
| unbindSip | integer | 非必须 | 0或不传：不解绑；1：解绑坐席绑定的sip账号 | ||
| roleName | string | 非必须 | 绑定坐席角色名称 | ||
| isHidePhone | integer | 非必须 | 是否隐藏号码 0否 1是 | 最大值: 1 最小值: 0 | |
| isrecord | integer | 非必须 | 是否录音：0：不启用；1：启用 | 最大值: 1 最小值: 0 | |
| outcallflag | integer | 非必须 | 外呼标志 0：允许外呼 1：限制长话 2：禁止外呼 3：限制国际 | 最大值: 3 最小值: 0 | |
| mainGroupName | string | 非必须 | 主技能组名称（用于切换坐席主技能组） |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | |||
| ├─ operatorId | string | 非必须 | 坐席工号 | ||
| ├─ sipPassword | string | 非必须 | sipnumber的密码 | ||
| ├─ sipNumber | string | 非必须 | sipnumber | ||
| ├─ mainGroupName | string | 非必须 | 技能组名称 |
2.1.3 删除坐席
基本信息
Path： /api/v1/config/openapi/agent/del/v2
Method： POST
接口描述：
删除坐席
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| companyId | integer | 非必须 | 企业id | ||
| operatorIds | string [] | 必须 | 坐席工号列表 | item 类型: string | |
| ├─ | 非必须 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 |
2.1.4 查询坐席
基本信息
Path： /api/v1/config/openapi/agent/one/v2
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| companyId | integer | 非必须 | 企业id | ||
| operatorId | string | 必须 | 坐席工号 | ||
| mainGroupName | string | 非必须 | 主技能组名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | 返回消息 | ||
| code | integer | 必须 | 返回码 | ||
| data | object | 非必须 | |||
| ├─ id | integer | 非必须 | 坐席id | ||
| ├─ companyId | integer | 非必须 | 公司id | ||
| ├─ operatorId | string | 非必须 | 坐席工号 | ||
| ├─ name | string | 非必须 | 坐席名称 | ||
| ├─ operatorType | integer | 非必须 | 坐席类型 | ||
| ├─ showcaller | string | 非必须 | 显号 | ||
| ├─ priority | integer | 非必须 | 优先级 | ||
| ├─ sipid | integer | 非必须 | sipid | ||
| ├─ sipNumber | string | 非必须 | sip号码 | ||
| ├─ sipPassword | string | 非必须 | sip密码 | ||
| ├─ bindcode | string | 非必须 | 绑定号码 | ||
| ├─ ismemory | integer | 非必须 | 是否开启座席记忆：0：不开启；1：开启 | ||
| ├─ isaudio | integer | 非必须 | 支持语音:0:不支持；1：支持 | ||
| ├─ isvideo | integer | 非必须 | 支持视频:0:不支持；1：支持 | ||
| ├─ ismessage | integer | 非必须 | 支持即时消息；0：不支持；1：支持 | ||
| ├─ isHidePhone | integer | 非必须 | 是否隐藏号码 0否1是 | ||
| ├─ outcallflag | integer | 非必须 | 外呼标志：0：允许外呼；1：限制长话；2：禁止外呼；3：限制国际 | ||
| string | 非必须 | 邮箱 | |||
| ├─ ctime | integer | 非必须 | 创建时间 | ||
| ├─ utime | integer | 非必须 | 更新时间 | ||
| ├─ ttscontent | string | 非必须 | tts播报 | ||
| ├─ status | integer | 非必须 | 状态：1 开通，0关闭 | ||
| ├─ isrecord | integer | 非必须 | 是否录音 0 no 1 yes | ||
| ├─ maingroupid | integer | 非必须 | 主技能组id | ||
| ├─ judge | integer | 非必须 | 是否需要服务评价 0 否 1是 | ||
| ├─ afterInterval | integer | 非必须 | 话后时长 | ||
| ├─ mainGroupName | string | 非必须 | 主技能组名称 |
2.1.5 查询坐席-分页
基本信息
Path： /api/v1/config/openapi/agent/page
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| operatorId | string | 非必须 | 坐席工号 | ||
| pageNumber | integer | 非必须 | 1 | 页数 | 最小值: 1 |
| pageSize | integer | 非必须 | 10 | 页大小 | 最大值: 100 最小值: 10 |
| sipNumber | string | 非必须 | sip号码 | ||
| mainGroupName | string | 非必须 | 主技能组名称 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| msg | string | 必须 | |||
| code | integer | 必须 | |||
| data | object | 非必须 | |||
| ├─ result | object [] | 非必须 | item 类型: object | ||
| result├─ id | integer | 非必须 | 坐席id | result参数 | |
| result├─ companyId | number | 非必须 | 企业id | ||
| result├─ operatorId | string | 非必须 | 坐席工号 | ||
| result├─ name | string | 非必须 | 名称 | ||
| result├─ operatorType | integer | 非必须 | 坐席类型 | ||
| result├─ showcaller | string | 非必须 | 显号 | ||
| result├─ priority | integer | 非必须 | 优先级 | ||
| result├─ sipid | integer | 非必须 | |||
| result├─ sipNumber | string | 非必须 | sip号码 | ||
| result├─ sipPassword | string | 非必须 | sip密码 | ||
| result├─ bindcode | string | 非必须 | 绑定号码 | ||
| result├─ ismemory | integer | 非必须 | 是否开启座席记忆：0：不开启；1：开启 | ||
| result├─ isaudio | integer | 非必须 | 支持语音:0:不支持；1：支持 | ||
| result├─ isvideo | integer | 非必须 | 支持视频:0:不支持；1：支持 | ||
| result├─ ismessage | integer | 非必须 | 支持即时消息；0：不支持；1：支持 | ||
| result├─ isHidePhone | integer | 非必须 | 是否隐藏号码 0否1是 | ||
| result├─ outcallflag | integer | 非必须 | 外呼标志：0：允许外呼；1：限制长话；2：禁止外呼；3：限制国际 | ||
| result├─ email | string | 非必须 | |||
| result├─ ctime | integer | 非必须 | 创建时间 | ||
| result├─ utime | integer | 非必须 | 更新时间 | ||
| result├─ ttscontent | string | 非必须 | tts播报 | ||
| result├─ status | integer | 非必须 | 状态：1 开通，0关闭 | ||
| result├─ isrecord | integer | 非必须 | 是否录音 0 no 1 yes | ||
| result├─ maingroupid | integer | 非必须 | 主技能组id | ||
| result├─ judge | integer | 非必须 | 服务评价 | ||
| result├─ afterInterval | integer | 非必须 | 话后时长 | ||
| result├─ mainGroupName | string | 非必须 | 主技能组名称 | ||
| ├─ pageSize | integer | 非必须 | 页大小 | ||
| ├─ total | integer | 非必须 | 总记录数 | ||
| ├─ pageNumber | integer | 非必须 | 页数 | ||
| ├─ pageTotal | integer | 非必须 | 总页数 |
2.1.6 修改坐席密码
基本信息
Path： /api/v1/config/openapi/agent/editPwd
Method： POST
接口描述：
修改坐席密码
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
| Content-Type | application/json | 是 | ||
| token | ImixBz8ebhRDCmBKaq70jHMjU3xt1Pkai9SAsOFjN2z6RpX8cTPr1/gEFkssjRFY | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| abbreviate | string | 必须 | 企业缩写 | ||
| companyId | integer | 非必须 | 企业id | ||
| operatorId | string | 必须 | 坐席工号 | ||
| password | string | 必须 | 坐席密码 MD5摘要 | 加密方式32位小写 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
| code | integer | 必须 | 返回码 | ||
| msg | string | 必须 | 返回说明 |