客服号管理相关接口
客服号管理相关接口
客服号操作
批量导入客服号
- 类型
API
URI
/group-dispatch-api/whatsapp/batchInsert
请求方式
POST、Content-Type: application/json
接口说明
批量导入客服号
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
whatsAppList | List | 是 | 客服号列表 |
data 参数说明
参数名 | 类型 | 是否必填 | 备注 |
---|---|---|---|
String | 是 | ||
avatar | String | 否 | 头像 |
name | String | 否 | 名称 |
publicKey | String | 是 | 账号公钥 |
privateKey | String | 是 | 账号私钥 |
msgPublicKey | String | 是 | 消息公钥 |
msgPrivateKey | String | 是 | 消息私钥 |
accountId | String | 是 | 账号 Id |
nextKeyId | String | 否 | nextKeyId |
registrationId | String | 否 | 注册 id |
deviceParams | String | 否 | 设备参数 |
whatsappType | Integer | 否 | whatsapp 账户类型 1 个人 2 商业,默认个人 |
- 请求示例:
{
"whatsAppList": [
{
"whatsApp": "861821726232",
"whatsappType": 1,
"name": "lee",
"avatar": "wwww.baiux.com/1.img",
"publicKey": "",
"privateKey": "",
"msgPublicKey": "",
"msgPrivateKey": "",
"accountId": "",
"nextKeyId": "",
"registrationId": "",
"deviceParams": ""
}
]
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data String 是 数据 响应示例
{
"data": "",
"code": 200,
"message": "success"
}
查询客服号信息
类型
API
URI
/group-dispatch-api/whatsapp/queryWhatsAppStatus
请求方式
GET、Content-Type: application/json
接口说明
查询所有的客服号信息
请求参数说明
无
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data List 是 数据
- data 响应参数说明
参数名 | 类型 | 是否必填 | 备注 |
---|---|---|---|
String | 是 | ||
status | int | 是 | 状态 0、离线 1、在线 2、封号 |
onlineStatus | int | 是 | 在线状态状态 1、上线中 2、在线 3、下线中 4、离线 |
- 响应示例
{
"data": [
{
"whatsApp": "861821371272",
"status": 1,
"onlineStatus": 1
}
],
"code": 200,
"message": "success"
}
批量上线客服号
类型
API
URI
/group-dispatch-api/whatsapp/batchOnline
请求方式
POST、Content-Type: application/json
接口说明
批量上线客服号
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
whatsAppList | List | 是 | 客服号列表 |
- whatsAppList 参数说明
参数名 | 类型 | 是否必填 | 备注 |
---|---|---|---|
override | boolean | 是 | 是否覆盖 |
String | 是 | ||
avatar | String | 否 | 头像 |
name | String | 否 | 名称 |
publicKey | String | 是 | 账号公钥 |
privateKey | String | 是 | 账号私钥 |
msgPublicKey | String | 是 | 消息公钥 |
msgPrivateKey | String | 是 | 消息私钥 |
nextKeyId | String | 否 | nextKeyId |
registrationId | String | 否 | 注册 id |
accountId | String | 否 | 账号 id |
deviceParams | String | 否 | 设备参数 |
whatsappType | Integer | 否 | whatsapp 账户类型 1 个人 2 商业,默认个人 |
- 请求示例:
{
"whatsAppList": [
{
"whatsApp": "861821726232",
"whatsappType": 1,
"override": false,
"name": "lee",
"avatar": "wwww.baiux.com/1.img",
"publicKey": "",
"privateKey": "",
"msgPublicKey": "",
"msgPrivateKey": "",
"accountId": "",
"nextKeyId": "",
"registrationId": "",
"deviceParams": ""
}
]
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data String 是 数据 响应示例
{
"data": "",
"code": 200,
"message": "success"
}
批量回收客服号
类型
API
URI
/group-dispatch-api/whatsapp/batchRecycle
请求方式
POST、Content-Type: application/json
接口说明
批量回收客服号
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
whatsAppList | List | 否 | 客服号 |
请求示例:
{
"whatsAppList": ["861821726232", "861821726231"]
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data String 是 数据 响应示例
{
"data": "",
"code": 200,
"message": "success"
}
同步客服号状态
配置 ID <CHANNEL_SYNC_STATUS>
类型
WebHook
URI
/callback/gsTask/syncWhatsAppStatus
请求方式
POST、Content-Type: application/json
接口说明
同步客服号状态
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
String | 是 | 客服号 | |
status | int | 是 | 状态 0、离线 1、在线 2、封号 |
onlineStatus | int | 是 | 在线状态状态 1、上线中 2、在线 3、下线中 4、离线 |
reason | String | 否 | 失败原因 |
- 请求示例:
{
"whatsApp": "8218132718231",
"status": 1,
"onlineStatus": 1,
"reason": ""
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data String 是 数据 响应示例
{
"data": "",
"code": 200,
"message": "success"
}
客服号注册
客服号注册(提交手机号)
- 类型
API
URI
/group-dispatch-api/register/submitPhone
请求方式
POST、Content-Type: application/json
接口说明
客服号注册
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
phone | String | 是 | 客服号(手机号) |
verifyType | int | 是 | 验证码类型 0、短信 1、语音 2、未接来电 3、内部验证码 |
accountType | int | 是 | 账号类型 1、个人 2、商业 |
areaCode | String | 是 | 地区码 |
countryCode | String | 是 | 国家码 |
- 请求示例:
{
"phone": "182172623211",
"verifyType": 1,
"accountType": 2,
"areaCode": "+86",
"countryCode": "CN"
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data int 是 任务 id 响应示例
{
"data": 12,
"code": 200,
"message": "success"
}
客服号注册(提交验证码)
- 类型
API
URI
/group-dispatch-api/register/submitVerifyCode
请求方式
POST、Content-Type: application/json
接口说明
客服号注册(验证码)
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
phone | String | 是 | 客服号(手机号) |
areaCode | String | 是 | 地区码 |
verifyCode | String | 是 | 验证码 |
- 请求示例:
{
"phone": "1821726232",
"verifyCode": "123456",
"areaCode": "+86"
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data String 是 数据 响应示例
{
"data": "",
"code": 200,
"message": "success"
}
同步客服号注册状态
配置 Id <CHANNEL_REGISTER_STATUS>
类型
WebHook
URI
/group-dispatch-api/register/syncStatus
请求方式
POST、Content-Type: application/json
接口说明
客服号注册状态同步
请求参数说明
字段 | 类型 | 是否必填 | 备注 |
---|---|---|---|
phone | String | 是 | 客服号(手机号) |
status | int | 是 | 1、成功 0、失败 |
- 请求示例:
{
"phone": "861821726232",
"status": "1"
}
响应参数说明
参数名 类型 是否必填 备注 code int 是 状态码 message String 是 描述 data String 是 数据 响应示例
{
"data": "",
"code": 200,
"message": "success"
}