扩展页接口文档

概述

扩展页的 URL 地址及页面内容均由 外部系统 决定，开发完毕后配置到帮我吧后台即可。具体配置方法可参考上一篇系统配置。

请求信息

项目	说明
请求链接	`https://www.crm.com/bangwo8crmApi`（示例，实际地址由第三方决定）
请求方法	`GET`
协议建议	建议支持 HTTPS，因为帮我吧登录默认是 HTTPS 的

注意：链接地址由第三方系统决定，以上仅为示例。

请求参数

名称	类型	注释
`userId`	string	系统默认用户标识
`type`	string	用户来源，标识客户从哪个渠道来寻求服务（详见下方类型对照表）
`field_xx`	string	设置了其他字段作为推送字段时，该参数有值。参数名称为帮我吧自定义字段的唯一标识
`supportAccount`	string	客服的帮我吧账号。外部系统如需区分是哪个账号获取客户信息，会用到该参数
`authCode`	string	帮我吧后台外部系统配置处生成的密钥，用于接口验证
`sessionId`	string	会话 ID。无论客户通过什么渠道寻求服务，客户与客服的一次完整沟通即为一个会话，该参数唯一标识本次会话

用户来源（type）对照表

取值	说明
`weChatId`	微信原生
`webChatId`	网页
`clientId`	帮我吧客户端
`phoneNumber`	呼叫中心
`serviceAccount`	公司的服务账号
`ticketPhoneNumber`	工单电话
`ticketMailBox`	工单邮箱

重要说明

参数编码：field_xx 参数会被 URL Encode 后传输，其他参数不编码

参数接收：以上参数根据外部系统系统实际需要接收对应的参数即可，无需全部处理

验证机制：authCode 用于验证请求来自帮我吧，外部系统系统需校验该密钥的有效性

会话标识：sessionId 用于标识一次完整的客户服务会话，可用于关联多次交互

请求示例

https://www.crm.com/bangwo8crmApi?userId=12345&type=webChatId&supportAccount=kefu001&authCode=abc123&sessionId=xyz789&field_1=%E5%85%AC%E5%8F%B8%E5%90%8D%E7%A7%B0

通用说明

数据传输：建议全程使用 HTTPS 确保数据安全

密钥管理：authCode 需与帮我吧后台配置的通信密钥保持一致

字段扩展：field_xx 为动态参数，具体字段标识取决于帮我吧后台配置的推送字段

概述#

请求信息#

请求参数#

用户来源（type）对照表#

重要说明#

请求示例#