联系人管理

新增联系人

请求参数

参数 类型 是否必须 参数说明
op_user string(40) 操作用户ID。可通过 用户列表 接口获取
force_add boolean 如存在重复联系人是否强制保存,默认为 false 不强制(不强制的情况下如存在重复会返回错误)
POST流 json(map) POST 方法提交的流数据,字段与值的键值对,例如 { "contactName":"杨志永" }
字段可通过 元数据 接口获取

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "contact_id": "xxx"
  }
}

返回数据说明

字段 类型 字段说明
contact_id string(40) 新增联系人的唯一ID,为 40 位 hash 字符串

获取单条联系人

请求参数

参数 类型 是否必须 参数说明
op_user string(40) 操作用户ID。可通过 用户列表 接口获取
contact_id string(40) 要获取的联系人ID
fields string 要获取的字段列表,多个字段以逗号(,)分隔
字段可通过 元数据 接口获取

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "contactName": "杨志永",
    "phone": "021-34240127"
  }
}

返回数据说明

字段 类型 字段说明
data json(map) 数据以键值对的形式放置在此字段

查询联系人列表

请求参数

参数 类型 是否必须 参数说明
op_user string(40) 操作用户。可通过 用户列表 接口获取
fields string 要查询的字段列表,多个字段以逗号(,)分隔
字段请通过 元数据 接口获取
qname string 查询主显字段(name_field),支持使用星号模糊匹配,如 *企能软件 将查询以企能软件结尾的客户。如需更复杂的查询请参考 高级查询接口
page_no int 页码,默认 1
page_size int 页大小,默认 20,最大 200

此接口暂不支持排序参数,默认顺序为记录创建时间由近到远,如需使用排序请参考 高级查询接口

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "total_size": 10000,
  "page_size": 20,
  "page_no": 1,
  "data": [
    { "contactId": "xxx", "contactName": "杨志永", "phone": "021-34240127" },
    { "contactId": "xxx", "contactName": "杨志永", "phone": "021-34240127" }
  ]
}

返回数据说明

字段 类型 字段说明
total_size int 总记录数
page_size int 查询的页大小
page_no int 查询的页码
data json(array) 数据以 数组->键值对 的形式放置在此字段

修改联系人

请求参数

参数 类型 是否必须 参数说明
op_user string(40) 操作用户ID。可通过 用户列表 接口获取
contact_id string(40) 要修改的联系人ID
force_update boolean 如更新的字段值存在重复联系人是否强制保存,默认为 false 不强制(不强制的情况下如存在重复会返回错误)
POST流 json(map) POST 方法提交的流数据,字段与值的键值对,例如 { "phone":"021-54590135" }
字段请通过 元数据 接口获取

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "contact_id": "xxx"
  }
}

返回数据说明

字段 类型 字段说明
contact_id string(40) 被修改的联系人ID

删除联系人

请求参数

参数 类型 是否必须 参数说明
op_user string(40) 操作用户ID。可通过 用户列表 接口获取
contact_id string(40) 要删除的联系人ID
cascade_delete string 级联删除选项,详情参照 级联删除

返回数据示例

{
  "error_code": 0,
  "error_msg": "调用成功",
  "data": {
    "contact_id": "xxx"
  }
}

返回数据说明

字段 类型 字段说明
contact_id string(40) 被删除的联系人ID

© WiseCRM365 上海企能软件科技有限公司    |    编辑本页