聯系人管理

新增聯系人

• API 地址：contact/add
• HTTP 方法：POST
• 授權方式：通用授權

請求參數

參數	類型	是否必須	參數說明
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 字符串

獲取單條聯系人

• API 地址：contact/get
• HTTP 方法：GET
• 授權方式：通用授權

請求參數

參數	類型	是否必須	參數說明
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)	數據以鍵值對的形式放置在此字段

查詢聯系人列表

• API 地址：contact/list
• HTTP 方法：GET
• 授權方式：通用授權

請求參數

參數	類型	是否必須	參數說明
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)	數據以 數組->鍵值對 的形式放置在此字段

修改聯系人

• API 地址：contact/update
• HTTP 方法：POST
• 授權方式：通用授權

請求參數

參數	類型	是否必須	參數說明
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

刪除聯系人

• API 地址：contact/delete
• HTTP 方法：POST
• 授權方式：通用授權

請求參數

參數	類型	是否必須	參數說明
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