客户管理接口
获取客户列表
请求参数:
名称 | 类型 | 是否必须 | 备注 |
token | string | 是 | 调用接口凭证 |
current | Number | 是 | 当前页数 |
pageSize | Number | 是 | 每页数据条数 |
userId | string | 否 | 员工的userId(该参数为空时,返回所有客户数据,不为空时,返回当前员工下的客户数据) |
TIP
- pageSize 每页数据条数, 不能超过1000。
返回示例:
返回参数说明:
名称 | 类型 | 必定存在 | 备注 |
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data.unionId | string | 否 | 客户unionId |
data.externalUserId | string | 是 | 客户id |
data.name | string | 是 | 客户姓名 |
data.avatar | string | 否 | 客户头像 |
data.gender | number | 是 | 客户性别 0 -未知 1 -男性 2 -女性 |
data.type | number | 是 | 客户的类型,1 表示该客户是微信用户,2 表示该客户是企业微信用户 |
data.followUser.userId | string | 是 | 员工在企业微信中的userId |
data.followUser.name | string | 是 | 员工姓名 |
data.followUser.avatar | string | 否 | 员工头像 |
data.followUser.remark | string | 是 | 当前员工给当前客户打的备注信息 |
data.followUser.state | string | 否 | 企业自定义的state参数,用于区分不同的添加渠道,不超过30个字符 |
data.followUser.createTimestamp | number | 是 | 客户添加该员工时间戳(毫秒) |
data.followUser.tags.groupName | string | 是 | 该成员添加此客户所打标签的分组名称(标签功能需要企业微信升级到2.7.5及以上版本) |
data.followUser.tags.tagName | string | 是 | 该成员添加此客户所打标签名称 |
data.followUser.tags.type | string | 是 | 该成员添加此客户所打标签类型, 1-企业设置, 2-用户自定义 |
data.followUser.tags.tagId | string | 否 | 该成员添加此客户所打企业标签的id,仅企业设置(type为1)的标签返回 |
data.followUser.remarkMobiles | string[] | 是 | 该成员对此客户备注的手机号码 |
total | number | 是 | 客户总数 |
获取客户详情
请求参数:
名称 | 类型 | 是否必须 | 备注 |
token | string | 是 | 调用接口凭证 |
unionId | string | 否 | 客户unionId |
externalUserId | string | 否 | 客户的externalUserId |
TIP
- unionId 和 externalUserId, 必须存在一个,当同时存在时以unionId为准
返回示例:
返回参数说明:
名称 | 类型 | 必定存在 | 备注 |
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
data.unionId | string | 否 | 客户unionId |
data.externalUserId | string | 是 | 客户id |
data.name | string | 是 | 客户姓名 |
data.avatar | string | 否 | 客户头像 |
data.gender | number | 是 | 客户性别 0 -未知 1 -男性 2 -女性 |
data.type | number | 是 | 客户的类型,1 表示该客户是微信用户,2 表示该客户是企业微信用户 |
data.followUser.userId | string | 是 | 员工在企业微信中的userId |
data.followUser.name | string | 是 | 员工姓名 |
data.followUser.avatar | string | 否 | 员工头像 |
data.followUser.remark | string | 是 | 当前员工给当前客户打的备注信息 |
data.followUser.createTimestamp | number | 是 | 客户添加该员工时间戳(毫秒) |
data.followUser.state | string | 否 | 企业自定义的state参数,用于区分不同的添加渠道,不超过30个字符 |
data.followUser.tags.groupName | string | 是 | 该成员添加此客户所打标签的分组名称(标签功能需要企业微信升级到2.7.5及以上版本) |
data.followUser.tags.tagName | string | 是 | 该成员添加此客户所打标签名称 |
data.followUser.tags.type | string | 是 | 该成员添加此客户所打标签类型, 1-企业设置, 2-用户自定义 |
data.followUser.tags.tagId | string | 否 | 该成员添加此客户所打企业标签的id,仅企业设置(type为1)的标签返回 |
data.followUser.remarkMobiles | string[] | 是 | 该成员对此客户备注的手机号码 |
修改客户备注
请求示例:
请求参数:
名称 | 类型 | 是否必须 | 备注 |
token | stirng | 是 | 调用接口凭证 |
userId | string | 是 | 企业员工userId |
unionId | string | 是 | 客户unionId |
remark | string | 否(最多20个字符) | 备注信息 |
description | string | 否(最多150个字符) | 描述 |
TIP
- remark和description 不可同时为空。
- 批量更新目前最多支持50条。
返回示例:
返回参数说明:
参数 | 类型 | 必定存在 | 备注 |
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
fail_list.userId | string | 是 | 设置备注失败userId |
fail_list.unionId | string | 是 | 设置备注失败的unionId |
fail_list.remark | string | 否 | 设置失败的备信息 |
fail_list.description | string | 否 | 设置失败的描述信息 |
fail_list.errcode | string | 是 | 企业微信返回的错误码 |
fail_list.errmsg | string | 是 | 企业微信返回的错误信息 |
WARNING
fail_list 为设置备注失败的列表,全部设置成功,则不返回该字段。
错误码:
错误码 | 说明 |
-1 | 备注长度超过限制 |
-2 | 描述长度超过限制 |
添加跟进记录
请示地址:
请求示例:
参数说明:
参数 | 类型 | 是否必须 | 备注 |
follow_list.unionId | string | 是 | 客户的unionId |
follow_list.userId | string | 是 | 成员userId |
follow_list.text.content | string | 是 | 跟进记录内容 |
follow_list.text.timestamp | number | 否 | 跟进记录时间 |
TIP
- follow_list 每次最多支持500条。
返回示例:
参数说明:
参数 | 类型 | 必定存在 | 备注 |
errcode | number | 是 | 返回码 |
errmsg | string | 是 | 对返回码的文本描述内容 |
follow_list.unionId | string | 是 | 客户的unionId |
follow_list.userId | string | 是 | 成员userId |
follow_list.text.content | string | 是 | 跟进记录内容 |
follow_list.text.timestamp | number | 否 | 跟进记录时间 |
WARNING
fail_list 为设置备注失败的列表,全部设置成功,则不返回该字段。