访客消息接口·一洽客服系统
目录
1. 给访客推送消息
1.给访客推送消息
通过此接口开发者可以向指定访客推送一条留言消息。
接口地址
http请求方式: POST
https://${apiServer}/staffMsg/pushMsgToVisitor/${appId}/1.1?accessToken=${accessToken}
访问限制
每个账号24小时内限制请求50000次
get参数说明
参数 | 是否必须 | 说明 |
---|---|---|
accessToken | 是 | 接口调用凭证 |
Post数据说明
json数据:
参数 | 类型 | 是否必须 | 说明 |
---|---|---|---|
metaData | string | 是 | 要推送消息的访客会员信息,目前仅支持给会员访客发送消息。 会员metaData生成规则:会员信息接入 如果当前一洽系统内不存在此会员访客,会自动创建一个客户crm信息。 |
visitorId | string | 是 | visitorId和metaData 选择传一个, 如果同时传了两个参数,会优先使用metaData |
pushMessage | string | 是 | 最大长度:10000 要给访客推送的消息内容。支持html格式。 |
briefContent | string | 否 | 最大长度:50 推送消息显示的摘要信息。如果不传此值,会自动截取pushMessage的前50个字符。 |
staffLogName | string | 是 | 给访客推送消息的客服账号。 客服的登陆名:手机号或者邮箱账号。如果一洽客服平台中不存在此账号,则发送消息失败 |
效果示例:
示例:
{
"metaData":"4mPGh3/F5PoQvFgvDuM45IemXOAiW2pV8hUbxCWd8OjDJ6aRTTk4FVfao4BQtf7MQkUq7S8jUj+Z8FYfUsCnIk1+HyG7dlOFjwz5O++Z828Oj2fU6AG1km0w+hsbtur1Kn3/fJ0VPcatLQEaeIc5JyGriBXue0zw6PcmuC4aj00=",
"pushMessage":"这是一条推送消息,推送消息发送后,如果是访客在会话中,访客会立刻收到此消息,如果访客不在线会通过离线消息接口进行推送,访客再次打开对话窗口时会首先查看此推送消息。",
"briefContent":"这是推送消息的摘要信息",
"staffLogName":"18948777432"
}
返回说明
返回数据格式:json
正确返回示例:
{"errcode":0,"errmsg":"success"}
错误返回示例:
{"errcode":104,"errmsg":"accessToken错误"}