七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
客户管理

第三方同步 CRM 信息(一知外呼)

一知外呼机器人(第三方)导入客户信息时同步 CRM 信息到七鱼系统。仅支持更新操作,禁止删除。使用一知专用 appKey 鉴权。需传入 tenantId 和 userNumber。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和
checksumAlgorithmint32否签名算法:0 - 默认(SHA1),1 - SHA256

请求体

名称类型必填描述示例值
tenantIdint64是租户 ID12345
userNumberstring是用户号码xxx-xxx-xxx-xxx
updateobject[]是要更新/新增的 CRM 信息列表
└namestring否访客姓名;传入时不能为空,长度不能超过 64 个字符。示例客户
└phonestring否电话号码。与 foreignId 至少传一个;未传 foreignId 时作为客户资料唯一标识。13800000000
└emailstring否访客邮箱user@example.com
└addressstring否地址示例地址
└leaderint64否负责人客服 ID,可在“在线系统-设置-会话流程-访客分配-分配规则-ID查询”中查询;传 -1 表示清除负责人。10001
└firstContactTimeint64否首次联系时间,必须为毫秒时间戳。1483009843582
└lastContactTimeint64否最后联系时间,必须为毫秒时间戳。1483957441234
└plateNumberstring否示例自定义扩展字段。实际可传“客户信息字段”中已配置、启用并显示的字段名称;时间控件字段值须为毫秒时间戳,数字字段值须为数字。浙A00001
└foreignIdstring否用户 uid 或外部 ID。与 phone 至少传一个;传入时作为客户资料唯一标识,优先级高于 phone。external-user-1

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messagestring同步结果提示;负责人客服 ID 无效时返回警告信息,无警告时可能不返回该字段以下负责人(客服ID)无效,已忽略:10001

错误码

状态码描述
14002appKey 不匹配;checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体 JSON 格式错误;update 数据为空;tenantId 或 userNumber 为空;包含禁止的 delete 字段
14500服务内部异常
postEndpoint
/openapi/crm/thirdParty/syncCrmInfo
POST
/openapi/crm/thirdParty/syncCrmInfo
curl -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": "服务内部异常"
}

这篇文档有帮助吗?