客户管理
客户导入
批量新增、修改或删除客户中心中的客户资料。请求体中 update 和 delete 至少包含一个;单次 update、delete 各最多 1000 条。 新增或更新时,foreignId 与 phone 至少传一个。有 foreignId 时以 foreignId 作为客户资料唯一标识;没有 foreignId 时以 phone 作为唯一标识。同一批次不允许出现重复的 foreignId 或 phone。 删除时,foreignId 与 phone 至少传一个;有 foreignId 时优先按 foreignId 删除,否则按 phone 删除。 客户信息自定义字段导入:在“客户管理-设置-客户信息”中已配置、启用并显示的字段,可以使用字段名称作为属性名传入;未启用字段会被忽略。时间控件字段值必须为毫秒时间戳,数字字段值必须为数字。 客户信息变更事件方向相反:当七鱼系统使用者主动修改访客名片,或访客访问行为触发系统自动修改访客名片时,七鱼会向企业在管理后台配置的“访客名片接口URL”发起 POST 回调。回调 query 参数包含 time、checksum,body 为访客名片对象,字段包括 name、phone、address、vipLevel、foreign_id、remarks、first_contact_time、last_contact_time、first_session_time、last_session_time、customField、tagsDetail。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| update | object[] | 否 | 需要新增或更新的客户资料列表。每条记录的 foreignId 与 phone 至少传一个;有 foreignId 时以 foreignId 为唯一标识,否则以 phone 为唯一标识。同一批次不允许重复 foreignId 或 phone。 | |
| └name | string | 否 | 访客姓名;传入时不能为空,长度不能超过 64 个字符。 | 示例客户 |
| └phone | string | 否 | 电话号码。与 foreignId 至少传一个;未传 foreignId 时作为客户资料唯一标识。 | 13800000000 |
| string | 否 | 访客邮箱 | user@example.com | |
| └address | string | 否 | 地址 | 示例地址 |
| └leader | int64 | 否 | 负责人客服 ID,可在“在线系统-设置-会话流程-访客分配-分配规则-ID查询”中查询;传 -1 表示清除负责人。 | 10001 |
| └firstContactTime | int64 | 否 | 首次联系时间,必须为毫秒时间戳。 | 1483009843582 |
| └lastContactTime | int64 | 否 | 最后联系时间,必须为毫秒时间戳。 | 1483957441234 |
| └plateNumber | string | 否 | 示例自定义扩展字段。实际可传“客户信息字段”中已配置、启用并显示的字段名称;时间控件字段值须为毫秒时间戳,数字字段值须为数字。 | 浙A00001 |
| └foreignId | string | 否 | 用户 uid 或外部 ID。与 phone 至少传一个;传入时作为客户资料唯一标识,优先级高于 phone。 | external-user-1 |
| delete | object[] | 否 | 需要删除的客户资料列表。每条记录的 foreignId 与 phone 至少传一个;有 foreignId 时优先按 foreignId 删除,否则按 phone 删除。 | |
| └foreignId | string | 否 | 用户 uid 或外部 ID。与 phone 至少传一个;传入时优先按 foreignId 删除。 | external-user-1 |
| └phone | string | 否 | 电话号码。与 foreignId 至少传一个;未传 foreignId 时按 phone 删除。 | 13800000000 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 同步结果提示;负责人客服 ID 无效时返回警告信息,无警告时可能不返回该字段 | 以下负责人(客服ID)无效,已忽略:10001 |
错误码
| 状态码 | 描述 |
|---|---|
| 14001 | AppKey 不存在 |
| 14002 | checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体 JSON 格式错误;update 和 delete 均为空 |
| 14500 | 服务内部异常 |
回调
customerInfoChangeEvent
postEndpoint
/openapi/crm/syncCrmInfocurl -X POST "https://qiyukf.com/openapi/crm/syncCrmInfo?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{}'{
"code": 200,
"message": "以下负责人(客服ID)无效,已忽略:10001"
}{
"code": 14001,
"message": "AppKey 不存在"
}{
"code": 14002,
"message": "checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "请求体 JSON 格式错误;update 和 delete 均为空"
}{
"code": 14500,
"message": "服务内部异常"
}这篇文档有帮助吗?