美洽API开放接口说明

美洽 API 通常用于将客服系统与业务后台、CRM、工单系统或小程序进行集成,常见能力包括:
1. 用户管理
– 创建或更新访客/客户资料
– 查询客户信息
– 绑定业务用户 ID、手机号、订单号等
2. 会话管理
– 创建会话
– 查询会话记录
– 获取当前客服、会话状态
– 转接、关闭会话
3. 消息能力
– 发送文本、图片、文件等消息
– 获取历史消息
– 接收新消息回调
4. 客服与坐席
– 查询客服列表
– 查询在线状态
– 分配或转接客服
5. 工单/服务单
– 创建工单
– 查询、更新工单状态
– 获取工单处理记录
6. Webhook 回调
– 新访客
– 新消息
– 会话创建或结束
– 工单状态变更
– 客服接入或转接
接入前需要确认
不同美洽产品和账号版本的接口可能不同,建议先确认:
– 使用的是 美洽开放 API、Web SDK、微信/小程序 SDK,还是客服工作台接口
– 是否已开通开放平台/API 权限
– 应用的 `AppKey`、`AccessToken` 或签名密钥
– 接口环境:正式环境还是测试环境
– 回调地址是否支持 HTTPS
– 是否有 IP 白名单、权限范围和调用频率限制
常见请求结构
实际字段和 URL 需要以美洽官方文档为准,一般形式如下:
“`http
POST /api/xxx
Host: api.xxx.com
Authorization: Bearer {access_token}
Content-Type: application/json
“`
请求示例:
“`json
{
“user_id”: “U10001”,
“name”: “张三”,
“mobile”: “13800000000”,
“source”: “小程序”
}
“`
返回示例:
“`json
{
“code”: 0,
“message”: “success”,
“data”: {
“id”: “xxx”
}
}
“`
Webhook 基本处理方式
你的服务端需要提供一个公网 HTTPS 地址,例如:
“`text
POST https://your-domain.com/webhook/meiqia
“`
收到回调后应:
1. 校验签名或 Token;
2. 判断事件类型;
3. 处理消息或业务逻辑;
4. 快速返回 HTTP 200;
5. 对耗时任务使用异步队列处理;
6. 做好重复回调和失败重试处理。
开发注意事项
– 不要把 `AppKey`、Token 或密钥写入前端代码。
– 不建议直接调用美洽内部接口或工作台接口,这类接口可能随时变化。
– 生产环境应实现签名校验、请求幂等、日志记录和限流。
– 客户手机号、聊天内容等属于敏感信息,应进行脱敏和权限控制。
– 发送消息、关闭会话等操作通常需要额外权限。
如果你需要的是具体接口文档,请提供以下任意信息,我可以继续整理成可直接开发的版本:
– 美洽官方文档链接;
– 你要实现的功能,例如“发送客服消息”“查询聊天记录”“创建工单”;
– 使用语言,例如 Java、PHP、Python、Node.js;
– 当前接口返回的错误信息。