您使用的浏览器过于陈旧,无法正常浏览,建议您 升级浏览器 以获取最佳显示效果。

服务端开发文档

企业顾客数据对接

概述

美洽顾客中心可以接入企业顾客数据进行更新管理。
对接主要通过接口方式,美洽在顾客对话接入的时候,主动去调用企业接口获取顾客信息更新至顾客中心。

配置

企业需先在美洽工作台->设置->顾客管理->顾客名片API配置进行相关配置才可使用该功能。

配置说明
    URL: 企业对外的域名url,需要美洽这边可以访问,如:http://meiqia.com
    AppID: 接口验证提供给美洽的ID
    AppSecret: 与ID对应的Secret,用于验证
    同步选项:对于两边都有的字段数据,该选项决定以哪边的数据为准

接口说明

美洽规定对接接口路径 /get_client_info,即美洽会采用POST {URL}/get_client_info 方式去企业拉取数据(URL即为企业配置中的域名url)。请求参数会以json格式作为请求体发送过去。

请求示例:
POST http://meiqia.com/get_client_info
{
    "appid": "meiqia",
    "appsecret": "meiqia-test",
    "client_id": "1"
}

参数说明:
    appid、appsecret为企业配置数据,主要用于企业对该接口访问的验证。
    client_id:企业对于顾客的唯一标识。

企业client_id与美洽顾客id进行绑定的操作参考如下文档说明:
meiqia-js-sdk#同步顾客身份
meiqia-android-sdk#绑定自定义-id-并设置上线

接口返回示例:
接口应返回如下所示的json格式数据。
{
    "code": 0,              // 0表示成功,其他表示失败
    "msg": "error msg",     // 失败时可以返回相应的error信息
    "client_id":            // 企业顾客id
    "data": [                   // data 用户数据
        {"key": "name", "value":"meiqia"},
        {"key": "age", "value": "25"},
        ...
    ]
}

返回参数说明:
    code: Int类型,必须,标识接口调用是否成功。0表示成功,其他表示失败。
    msg: String类型,非必须,失败时可以返回对应错误信息。
    client_id: String类型,必须,企业顾客唯一标识。
    data: Array类型,必须,包含用户详细信息的数据,数组中每条记录代表一个字段详细数据。
    
data记录字段说明:
    <k-v>格式的数据,目前仅支持key、value两个字段,后续会扩展多个字段以控制该属性的排序展示等。
    key: String类型,必须,属性名字
    value: String类型,必须,属性的值

其他

该接口不仅可以同步顾客名片已有字段的属性值,也可以进行新增属性的添加同步。
对于新增字段,同步时会自动在顾客名片字段中新增相应字段并默认为显示,这里新增字段会受到顾客名片最多50个字段的限制。

顾客中心部分默认字段说明:

key说明
name姓名
age年龄
gender性别(value值只能是"男"或"女")
tel电话
qqQQ
weixin微信
weibo微博
address地址
email邮箱
comment备注
contact联系人