Access Token
您需要在【设置 / 开发者 / APIs】中获取工作台的 Access Token，后续调用以下 APIs 时都需要使用 Token。目前 Token 的有效期是永久，重复获取将导致上次获取的 Token 失效。
$ curl -s https://api.meiqia.com/v1/conversations/<conv_id> -H Authorization:Bearer <access_token>
添加客服
基本信息
Path： /unified-api/datagateway/v1/agents
Method： POST
接口描述：创建客服
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 必须 | 邮箱 | |||
| group_id | integer | 必须 | 所属分组ID | format: int64 | |
| password | string | 必须 | 密码 | ||
| realname | string | 非必须 | 真实姓名 | ||
| role_token | string | 必须 | 角色token | ||
| serving_limit | integer | 必须 | 在线客服服务上线 | format: int64 | |
| serving_types | string [] | 必须 | 账号类型(数组):conv(在线客服)，call(呼叫客服)，ticket(工单客服) | item 类型: string | |
| ├─ | 非必须 | ||||
| work_num | string | 非必须 | 工号 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| id | integer | 非必须 | 客服ID | format: int64 |
获取客服列表
基本信息
Path： /unified-api/datagateway/v1/agents/list
Method： POST
接口描述：获取客服列表
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| string | 非必须 | 客服邮箱 | |||
| with_deleted | boolean | 非必须 | 是否包含已删除的客服 |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| agents | object [] | 非必须 | item 类型: object | ||
| ├─ avatar | string | 非必须 | 头像 | ||
| ├─ cellphone | string | 非必须 | |||
| ├─ created_on | string | 非必须 | 创建时间 | format: date-time | |
| ├─ deleted_at | string | 非必须 | 删除时间 | format: date-time | |
| string | 非必须 | 客服邮箱 | |||
| ├─ email_activated | integer | 非必须 | 邮件是否激活 | format: int64 | |
| ├─ enterprise_id | integer | 非必须 | 企业ID | format: int64 | |
| ├─ group_id | integer | 非必须 | 分组ID | format: int64 | |
| ├─ id | integer | 非必须 | format: int64 | ||
| ├─ nickname | string | 非必须 | 昵称 | ||
| ├─ privilege | string | 非必须 | 权限 | ||
| ├─ public_cellphone | string | 非必须 | |||
| ├─ public_email | string | 非必须 | |||
| string | 非必须 | ||||
| ├─ rank | integer | 非必须 | format: int64 | ||
| ├─ read_feature_id | integer | 非必须 | format: int64 | ||
| ├─ realname | string | 非必须 | 真实姓名 | ||
| ├─ serving_limit | integer | 非必须 | 服务上限 | format: int64 | |
| ├─ serving_type | integer | 非必须 | format: int64 | ||
| ├─ serving_types | string [] | 非必须 | 账号类型 | item 类型: string | |
| ├─ | 非必须 | ||||
| ├─ signature | string | 非必须 | |||
| ├─ status | string | 非必须 | 在线状态 | ||
| ├─ telephone | string | 非必须 | |||
| ├─ token | string | 非必须 | |||
| ├─ weixin | string | 非必须 | |||
| ├─ work_num | string | 非必须 | 工号 |
删除客服
基本信息
Path： /unified-api/datagateway/v1/agents/{agentID}
Method： DELETE
接口描述：删除客服
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| agentID |
获取客服详情
基本信息
Path： /unified-api/datagateway/v1/agents/{agentID}
Method： GET
接口描述：获取客服详情
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| agentID |
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| avatar | string | 非必须 | 头像 | ||
| cellphone | string | 非必须 | |||
| created_on | string | 非必须 | 创建时间 | format: date-time | |
| deleted_at | string | 非必须 | 删除时间 | format: date-time | |
| string | 非必须 | 客服邮箱 | |||
| email_activated | integer | 非必须 | 邮件是否激活 | format: int64 | |
| enterprise_id | integer | 非必须 | 企业ID | format: int64 | |
| group_id | integer | 非必须 | 分组ID | format: int64 | |
| id | integer | 非必须 | format: int64 | ||
| nickname | string | 非必须 | 昵称 | ||
| privilege | string | 非必须 | 权限 | ||
| public_cellphone | string | 非必须 | |||
| public_email | string | 非必须 | |||
| string | 非必须 | ||||
| rank | integer | 非必须 | format: int64 | ||
| read_feature_id | integer | 非必须 | format: int64 | ||
| realname | string | 非必须 | 真实姓名 | ||
| serving_limit | integer | 非必须 | 服务上限 | format: int64 | |
| serving_type | integer | 非必须 | format: int64 | ||
| serving_types | string [] | 非必须 | 账号类型 | item 类型: string | |
| ├─ | 非必须 | ||||
| signature | string | 非必须 | |||
| status | string | 非必须 | 在线状态 | ||
| telephone | string | 非必须 | |||
| token | string | 非必须 | |||
| weixin | string | 非必须 | |||
| work_num | string | 非必须 | 工号 |
更新客服
基本信息
Path： /unified-api/datagateway/v1/agents/{agentID}
Method： PUT
接口描述：更新客服
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 是 |
路径参数
| 参数名称 | 示例 | 备注 |
|---|---|---|
| agentID |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| group_id | integer | 非必须 | 所属分组ID | format: int64 | |
| realname | string | 非必须 | 真实姓名 | ||
| role_token | string | 非必须 | 角色token | ||
| serving_limit | integer | 非必须 | 在线客服服务上线 | format: int64 | |
| serving_types | string [] | 非必须 | 账号类型(数组):conv(在线客服)，call(呼叫客服)，ticket(工单客服) | item 类型: string | |
| ├─ | 非必须 | ||||
| work_num | string | 非必须 | 工号 |
