客户管理
第三方同步 CRM 信息(一知外呼)
一知外呼机器人(第三方)导入客户信息时同步 CRM 信息到七鱼系统。仅支持更新操作,禁止删除。使用一知专用 appKey 鉴权。需传入 tenantId 和 userNumber。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| appKey | string | 是 | 应用 AppKey | |
| time | int64 | 是 | 请求时间戳(秒) | |
| checksum | string | 是 | 请求签名校验和 | |
| checksumAlgorithm | int32 | 否 | 签名算法:0 - 默认(SHA1),1 - SHA256 |
请求体
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| tenantId | int64 | 是 | 租户 ID | 12345 |
| userNumber | string | 是 | 用户号码 | xxx-xxx-xxx-xxx |
| update | object[] | 是 | 要更新/新增的 CRM 信息列表 | |
| └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 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| code | int32 | 状态码,200 表示成功 | 200 |
| message | string | 同步结果提示;负责人客服 ID 无效时返回警告信息,无警告时可能不返回该字段 | 以下负责人(客服ID)无效,已忽略:10001 |
错误码
| 状态码 | 描述 |
|---|---|
| 14002 | appKey 不匹配;checksum 校验失败 |
| 14003 | 请求时间戳与服务器时间误差超过 10 分钟 |
| 14004 | 请求体 JSON 格式错误;update 数据为空;tenantId 或 userNumber 为空;包含禁止的 delete 字段 |
| 14500 | 服务内部异常 |
postEndpoint
/openapi/crm/thirdParty/syncCrmInfocurl -X POST "https://qiyukf.com/openapi/crm/thirdParty/syncCrmInfo?appKey=string&time=0&checksum=string" \ -H "Content-Type: application/json" \ -d '{ "tenantId": 12345, "userNumber": "xxx-xxx-xxx-xxx", "update": [ {} ] }'{
"code": 200,
"message": "以下负责人(客服ID)无效,已忽略:10001"
}{
"code": 14002,
"message": "appKey 不匹配;checksum 校验失败"
}{
"code": 14003,
"message": "请求时间戳与服务器时间误差超过 10 分钟"
}{
"code": 14004,
"message": "请求体 JSON 格式错误;update 数据为空;tenantId 或 userNumber 为空;包含禁止的 delete 字段"
}{
"code": 14500,
"message": "服务内部异常"
}这篇文档有帮助吗?