聯(lián)系人管理
新增聯(lián)系人
- API 地址：
contact/add - HTTP 方法：POST
- 授權(quán)方式：通用授權(quán)
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 是否必須 | 參數(shù)說(shuō)明 |
|---|---|---|---|
| op_user | string(40) | 是 | 操作用戶ID。可通過(guò) 用戶列表 接口獲取 |
| force_add | boolean | 否 | 如存在重復(fù)聯(lián)系人是否強(qiáng)制保存，默認(rèn)為 false 不強(qiáng)制（不強(qiáng)制的情況下如存在重復(fù)會(huì)返回錯(cuò)誤） |
| POST流 | json(map) | 是 | POST 方法提交的流數(shù)據(jù)，字段與值的鍵值對(duì)，例如 { "contactName":"楊志永" }字段可通過(guò) 元數(shù)據(jù) 接口獲取 |
返回?cái)?shù)據(jù)示例
{
"error_code": 0,
"error_msg": "調(diào)用成功",
"data": {
"contact_id": "xxx"
}
}
返回?cái)?shù)據(jù)說(shuō)明
| 字段 | 類型 | 字段說(shuō)明 |
|---|---|---|
| contact_id | string(40) | 新增聯(lián)系人的唯一ID，為 40 位 hash 字符串 |
獲取單條聯(lián)系人
- API 地址：
contact/get - HTTP 方法：GET
- 授權(quán)方式：通用授權(quán)
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 是否必須 | 參數(shù)說(shuō)明 |
|---|---|---|---|
| op_user | string(40) | 是 | 操作用戶ID。可通過(guò) 用戶列表 接口獲取 |
| contact_id | string(40) | 是 | 要獲取的聯(lián)系人ID |
| fields | string | 是 | 要獲取的字段列表，多個(gè)字段以逗號(hào)（,）分隔 字段可通過(guò) 元數(shù)據(jù) 接口獲取 |
返回?cái)?shù)據(jù)示例
{
"error_code": 0,
"error_msg": "調(diào)用成功",
"data": {
"contactName": "楊志永",
"phone": "021-34240127"
}
}
返回?cái)?shù)據(jù)說(shuō)明
| 字段 | 類型 | 字段說(shuō)明 |
|---|---|---|
| data | json(map) | 數(shù)據(jù)以鍵值對(duì)的形式放置在此字段 |
查詢聯(lián)系人列表
- API 地址：
contact/list - HTTP 方法：GET
- 授權(quán)方式：通用授權(quán)
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 是否必須 | 參數(shù)說(shuō)明 |
|---|---|---|---|
| op_user | string(40) | 是 | 操作用戶。可通過(guò) 用戶列表 接口獲取 |
| fields | string | 是 | 要查詢的字段列表，多個(gè)字段以逗號(hào)（,）分隔 字段請(qǐng)通過(guò) 元數(shù)據(jù) 接口獲取 |
| qname | string | 否 | 查詢主顯字段（name_field），支持使用星號(hào)模糊匹配，如 *企能軟件 將查詢以企能軟件結(jié)尾的客戶。如需更復(fù)雜的查詢請(qǐng)參考 高級(jí)查詢接口 |
| page_no | int | 否 | 頁(yè)碼，默認(rèn) 1 |
| page_size | int | 否 | 頁(yè)大小，默認(rèn) 20，最大 200 |
返回?cái)?shù)據(jù)示例
{
"error_code": 0,
"error_msg": "調(diào)用成功",
"total_size": 10000,
"page_size": 20,
"page_no": 1,
"data": [
{ "contactId": "xxx", "contactName": "楊志永", "phone": "021-34240127" },
{ "contactId": "xxx", "contactName": "楊志永", "phone": "021-34240127" }
]
}
返回?cái)?shù)據(jù)說(shuō)明
| 字段 | 類型 | 字段說(shuō)明 |
|---|---|---|
| total_size | int | 總記錄數(shù) |
| page_size | int | 查詢的頁(yè)大小 |
| page_no | int | 查詢的頁(yè)碼 |
| data | json(array) | 數(shù)據(jù)以 數(shù)組->鍵值對(duì) 的形式放置在此字段 |
修改聯(lián)系人
- API 地址：
contact/update - HTTP 方法：POST
- 授權(quán)方式：通用授權(quán)
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 是否必須 | 參數(shù)說(shuō)明 |
|---|---|---|---|
| op_user | string(40) | 是 | 操作用戶ID。可通過(guò) 用戶列表 接口獲取 |
| contact_id | string(40) | 是 | 要修改的聯(lián)系人ID |
| force_update | boolean | 否 | 如更新的字段值存在重復(fù)聯(lián)系人是否強(qiáng)制保存，默認(rèn)為 false 不強(qiáng)制（不強(qiáng)制的情況下如存在重復(fù)會(huì)返回錯(cuò)誤） |
| POST流 | json(map) | 是 | POST 方法提交的流數(shù)據(jù)，字段與值的鍵值對(duì)，例如 { "phone":"021-54590135" }字段請(qǐng)通過(guò) 元數(shù)據(jù) 接口獲取 |
返回?cái)?shù)據(jù)示例
{
"error_code": 0,
"error_msg": "調(diào)用成功",
"data": {
"contact_id": "xxx"
}
}
返回?cái)?shù)據(jù)說(shuō)明
| 字段 | 類型 | 字段說(shuō)明 |
|---|---|---|
| contact_id | string(40) | 被修改的聯(lián)系人ID |
刪除聯(lián)系人
- API 地址：
contact/delete - HTTP 方法：POST
- 授權(quán)方式：通用授權(quán)
請(qǐng)求參數(shù)
| 參數(shù) | 類型 | 是否必須 | 參數(shù)說(shuō)明 |
|---|---|---|---|
| op_user | string(40) | 是 | 操作用戶ID。可通過(guò) 用戶列表 接口獲取 |
| contact_id | string(40) | 是 | 要?jiǎng)h除的聯(lián)系人ID |
| cascade_delete | string | 否 | 級(jí)聯(lián)刪除選項(xiàng)，詳情參照 級(jí)聯(lián)刪除 |
返回?cái)?shù)據(jù)示例
{
"error_code": 0,
"error_msg": "調(diào)用成功",
"data": {
"contact_id": "xxx"
}
}
返回?cái)?shù)據(jù)說(shuō)明
| 字段 | 類型 | 字段說(shuō)明 |
|---|---|---|
| contact_id | string(40) | 被刪除的聯(lián)系人ID |