API渠道接入
API渠道接入用于开发者通过开放的API接口将客户消息接入到在线客服。实现客户与客服间的实时聊天功能。
渠道信息配置
登录管理端，地址：https://{您的专属域名}/login 配置渠道信息。点击配置=>渠道管理=>API渠道，进入API渠道配置，按照步骤新建API渠道信息。步骤如下：
消息接入
开发须知：
调用本接口前，请先获取appid。传入数据需要加密加签，具体方式请参照：公共部分
消息接入地址：POST https://{您的专属域名}/chat/openapi/v1/apiChannel/sendMsg
请求参数：
| 参数名称 | 描述 | 备注 |
|---|---|---|
| token | 渠道令牌（短token） | 渠道身份表示，全局唯一 |
| externalId | 客户id | 客户身份消息，三个字段至少填一个 |
| phone | 客户手机 | 客户身份消息，三个字段至少填一个 |
| 客户邮箱地址 | 客户身份消息，三个字段至少选填一个 | |
| customerName | 用户姓名 | |
| createTime | 消息创建时间 | |
| msgType | 消息类型 | 1文本，2图片，3视频，4卡片 |
| msgContent | 消息内容 | |
| msgId | 消息编号 | Uuid |
返回参数：
| 参数名称 | 描述 | 备注 |
|---|---|---|
| code | 结果码 | 10000成功，20001:创建会话失败 |
| message | 结果描述 | |
| data | Item | - |
Item
| 参数名称 | 描述 | 备注 |
|---|---|---|
| sessionId | 会话id | |
| agentName | 客服名称 | |
| agentId | 客服id | - |
异步消息接收
系统会将客服消息发送到渠道配置的异步消息接收地址。
参数内容：
| 参数名称 | 描述 | 备注 |
|---|---|---|
| msgType | 消息类型 | 1普通消息，2机器人消息 |
| data | 消息内容 | 根据不同消息类型，返回不同的消息体 |
普通消息参数：
| 参数名称 | 描述 | 备注 |
|---|---|---|
| extenalId | 用户id | |
| phone | 用户手机 | |
| 邮箱地址 | ||
| msgFrom | 消息发送者id | |
| msgFromName | 消息发送者名称 | |
| msgId | 消息编号 | Uuid |
| time | 消息发送时间戳 | |
| chatType | 聊天类型[人工-聊天(0),系统-欢迎语(1),系统-访客超时未回复提示消息(10),系统-访客超时未回复-结束会话文案消息(20)] | |
| type | 消息类型[发起会话(chat_probe),聊天消息(chat),用户离开(chat_close),评价消息(evaluate),消息撤回(revoke)] | |
| content | 聊天内容 | |
| contentType | 消息内容类型（image:图片，audio:语音，file:文件，video:视频） | - |