微伴助手OpenAPI

导入客户信息

POST/open-api/external_user/import_info

通过客户 id 或客户 unionid，导入同步客户的信息，对系统中未存在的自定义字段报错处理，可调用添加自定义字段接口，对于已存在的客户信息字段请按照下文给予的字段进行传输导入。调用此接口需购买基础席位。

错误码	说明
20210	客户external_user_id错误
20211	客户unionid错误
20212	请提供客户external_user_id或客户external_user_unionid
20213	员工与客户无关联
20214	external_user_fields格式有误
20215	自定义字段不存在
20216	该值内容长度超过500, 请重新修改
20217	下拉框的选项值不存在
21801	最多允许批量修改10个自定义字段
21802	参数option_id，field_value，field_datetime不能同时为空
21803	存在无效的员工或外部联系人
21804	存在无效的field_id
21805	存在无效的option_id
21806	存在外部联系人和员工没有好友关系
21807	存在字段类型和传入的参数不正确
21808	时间格式不正确
21809	缺少参数
21810	自定义信息更新失败，请重试
21811	field_id为${field_id}的自定义字段不存在

请求参数

staff_id

string

客服员工id

必需

external_user_id

string

可选

客户id。external_user_id 和 external_user_unionid 必须选择一个填写

external_user_unionid

string

可选

客户unionid。external_user_id 和 external_user_unionid 必须选择一个填写

external_user_openid

string

可选

客户openid。密文企业选择 external_user_unionid 时需填写

phone_number

string

客户手机号

可选

age

string

客户年龄

可选

string

客户邮箱

可选

birthday

string

客户生日

可选

weibo

string

客户微博

可选

string

客户qq

可选

address

string

客户地址

可选

description

string

客户描述

可选

state

string

来源渠道

可选

external_user_fields

array [object {6}]

可选

客户信息自定义字段的列表，非系统基本字段之外的字段。external_user_field的列表。

field_name

string

自定义字段名称

必需

field_type

string

可选

自定义字段类型，"text"文本类型，"option_text"选项类型，"datetime"时间类型，"number"数值类型　四选一。默认"text"。

field_datetime

string

可选

自定义字段对应时间，比如"2021-09-01 16:03:59"，格式为YYYY-MM-DD HH:mm:ss；当field_type为"datetime"时，必须传入该字段。

option_name

string

可选

选项文本，当field_type为"option_text"时，必须传入该字段。

value

string

可选

自定义字段对应值，当field_type为"text"时必填，最大长度500

number_value

number

可选

字段类型为数值是对应的值，可以为小数，最多保留两位小数

{
  "staff_id": "zhangsan",
  "external_user_id": "wo8xjUCAAAGfqRyM0CGqryOsaKOYgEZE",
  "external_user_unionid": "oz9xvw_jfkmHMGWVSn5CatKSTOMU",
  "phone_number": "17718167093",
  "age": "18",
  "email": "123@qq.com",
  "birthday": "2000-01-01",
  "weibo": "harchy",
  "qq": "12345",
  "address": "上海浦东区陆家嘴xx大厦11层",
  "description": "活动添加客户，意向很高",
  "state": "测试渠道",
  "external_user_fields": [
    {
      "field_name": "测试时间2",
      "field_type": "datetime",
      "field_datetime": "2021-09-08 20:12:27"
    },
    {
      "field_name": "样例文本7",
      "field_type": "option_text",
      "option_name": "选项文本1"
    },
    {
      "field_name": "测试文本3",
      "field_type": "text",
      "value": "180cm"
    },
    {
      "field_name": "测试数值４",
      "field_type": "number",
      "value": 180.22
    }
  ]
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

object {0}

{
  "errcode": 0,
  "errmsg": "ok"
}

最后修改时间： 9 个月前