一. 调用说明
1.1 创建生成API Key；
1.2 调用如下接口时需要在请求Headers头中增加参数APIKEY = {您创建生成的API Key}，请求接口地址：https://channel-receive.meetbot.biz；
1.3 响应格式
示例：
{
"code": 0,
"message": "",
"result": {{Object}},
"traceId": "",
"success": true
}二. API导入专属客户接口
2.1 请求接口
请求方式：POST
接口地址：/consultant/allocation/add/user
2.2 参数
| 字段 | 名称 | 类型 | 长度 | 必填 | 说明 | |
|---|---|---|---|---|---|---|
| userMobile | 客户手机号,必填 | String | - | 是 | 等同于“在线客服-客服工作台”中用户的手机号 | |
| allocationUser | 专属客服的账号，手机号邮箱任意填其中一个 | String | - | 是 | 该客服用于登陆的账号，可以是登陆的手机号，也可以是登陆的账号邮箱号，如果两者都有，任意填其中一个都能定位该专属客服 | |
| labelList | 个人标签，非必填 | List<String> | - | 是 | 必须这个专属客服拥有的个人标签，如果为空或者不存在的个人标签则不添加；个人标签无法用于群发 | |
| whatsappMobile | whatsapp手机号，非必填 | String | - | 否 | 绑定whatsapp的手机号，值为携带区号前缀的手机号，以+号开头，举例+8613655889727 | |
| assignmentType | 赋值类型，非必填 | String | - | 否 | 如果whatsapp传值该字段也必须传值，该值有两种，RESERVE:保留，UPDATE:更新，对于RESERVE类型：对于已有会话号码的客户，不改变其会话号码，保留原值，对于会话号码为空的客户，指定其会话号码为本次选择的，对于UPDA类型：对于所有本次请求的客户，更新指定其会话号码为本次选择的 | |
| tags | 标签列表 | List | - | 否 | 给该客户打上对应的客户标签。 | |
| tags.tagName | 标签名 | String | - | 是 | 对应客户标签里标签名称。该名称必须在标签系统中存在，不存在则会报错。“FB标签”为系统标签，本接口不支持导入。“WhatsApp客户亲密度”标签分类下的标签均为系统标签，本接口不支持导入。“取消订阅[系统]”较为特殊，本接口允许导入，但是tags.tagValue只允许填写“已退订WhatsApp”。 | |
| tags.tagValue | 标签值 | String | - | 是 | 对应客户标签里的标签值。当该标签值不存在时，会创建标签值。当tags.tagName为“取消订阅[系统]”时，本字段必须填写“已退订WhatsApp”。 | |
| tags.replaceIfPresent | 是否覆盖之前已有标签值 | Boolean | - | 否 | 默认值true。当客户已经拥有该标签名下任何标签值，如果该字段为true，则会使用本次标签名、标签值覆盖之前标签值，如果该字段为false，则会跳过打标签流程。 |
请求示例：
{
"userMobile":"8613012345678",
"allocationUser":"13912345678",
"labelList":["abcd","bcd"],
"whatsappMobile":"+8615229066117",
"assignmentType":"RESERVE",
"tags":[
{
"tagName":"标签1",
"tagValue":"值1",
"replaceIfPresent":true
},
{
"tagName":"标签2",
"tagValue":"值3",
"replaceIfPresent":false
},
{
"tagName":"取消订阅[系统]",
"tagValue":"已退订WhatsApp"
}
]
}2.3 响应报文
成功：
{
"code": 0,
"message": "",
"result": true,
"success": true
}错误码列表
| 错误码 | 错误信息 | 错误原因 |
|---|---|---|
| 0 | 成功 | |
| 70001 | Api Key invalid! | 未在Headers头中传入正确的ApiKey |
| 80001 | 专属顾问账号不存在 | 专属顾问账号不存在 |
| 80002 | 专属顾问账号不属于该店铺 | 专属顾问账号不属于该店铺 |
| 80003 | 标签不存在 | 标签不存在 |
| 80004 | 手机号格式错误 | 手机号格式错误 |
| 80005 | whatsapp mobile手机号格式错误 | whatsapp mobile手机号格式错误 |
| 80006 | whatsapp mobile手机号未传值 | whatsapp mobile手机号未传值 |
| 80007 | assignmentType未传值 | assignmentType未传值 |
| 80008 | assignmentType传值错误 | assignmentType传值错误 |
| 80009 | whatsapp账号不存在 | whatsapp账号不存在 |
| 80014 | 标签格式错误 | 存在标签名或标签值为空的情况 |
| 80015 | 标签不存在 | 输入不存在的标签名 |
| 999 | 系统错误 | 系统错误 |
