侧边栏

文档首页


CRM扩展

数据接口

呼叫能力

Android IM SDK手册(暂停使用)

iOS IM SDK手册(暂停使用)

Android SIP SDK手册

iOS SIP SDK手册

客户端标准版快速集成

帮我吧远程SDK版本

网页在线客服集成

微信接入

帮我吧文档:数据接口:客户管理:联系人自定义字段

JSON格式

名称 类型 注释
id int 自定义字段id,系统自动分配
url varchar 自定义字段的资源url
name varchar 自定义字段名字
key varchar 自定义字段的唯一标识
type int 自定义字段类型,取值为:1-下拉列表,2-单行文本,3-多行文本,4-正整数,5-小数,6-复选框,7-正则表达式,8-日期(格式为:2018-02-03),12-附件,17-电话类型的文本
system tinyint 是否为系统字段,取值为:1-系统字段,0-自定义字段
custom_field_options array 下拉列表的选项,如果字段类型是下拉列表,该字段会有值。

JSON示例

{

   "id": 1,
   "url": "https://www.bangwo8.com/api/v1/users/user_fields/1.json",
   "name": "产品类型",
   "key": "field_10",
   "type": "1",
   "system": "0",
   "custom_field_options": [//key为下拉选项的ID
     {
       "key": "231",
       "value": "在线客服模块"
     },
     {
       "key": "232",
       "value": "呼叫中心模块"
     },
     {
       "key": "233",
       "value": "工单模块"
     }
  ]
 

}

查询联系人自定义字段列表

GET /api/v1/users/user_fields.json

调用者权限

管理员

调用示例

curl https://www.bangwo8.com/api/v1/users/user_fields.json -u {account}:{password}

返回值示例

Status: 200 OK

{
  "user_fields":[
   {
    "id": 1,
    "name": "产品类型",
    "key": "field_10",
    "type": "1",
    "system":"0",
    "custom_field_options": [
      {
       "key": "231",
       "value": "在线客服模块"
      },
      {
       "key": "232",
       "value": "呼叫中心模块"
      },
      {
       "key": "233",
       "value": "工单模块"
      }
     ]
    },
    ...
  ]
}

页面工具