搜索特定企业联系人
从企业联系人列表中搜索特定的企业联系人。
请求 URL
GET {base_url}/{api_path}/company_contact/search?access_token={access_token}
请求参数
参数 | 是否必填 | 类型 | 说明 |
---|---|---|---|
page | 否 | Integer | 定义显示第几个页面。 注: 如果没有设置此参数,则默认返回第一页。
|
page_size | 否 | Integer | 定义每页显示几项查询结果。 最大值:10000 注: 如果没有设置此参数,则默认每页返回 10000
项结果。
|
sort_by | 否 | String | 定义排序字段。 取值范围:
|
order_by | 否 | String | 定义显示顺序。 取值范围:
|
search_value | 否 | String | 搜索关键字。 |
响应参数
参数 | 类型 | 说明 |
---|---|---|
errcode | Integer | 返回错误码。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息。
|
errmsg | String | 返回信息。
|
total_number | Integer | 搜索到的企业联系人总数量。 |
data | Array<Contact_Info> | 企业联系人信息。 |
- Contact_Info
-
表 3. 参数 类型 说明 id Integer 企业联系人的唯一 ID。 contact_name String 企业联系人名称。 company String 公司。 email String 邮箱。 phonebook_list Array<Phonebook_List> 所属的企业联系人群组。 remark String 备注。 business String 办公号码。 business2 String 办公号码 2。 mobile String 手机号码。 mobile2 String 手机号码 2。 home String 家庭号码。 home2 String 家庭号码 2。 business_fax String 公司传真。 home_fax String 家庭传真。 other String 其他号码。
- Phonebook_List
-
表 4. 参数 类型 说明 id Integer 企业联系人群组的唯一 ID。 name String 企业联系人群组名称。
示例
请求示例
GET /openapi/v1.0/company_contact/search?search_value=jay&access_token=9ZG6kC6xo4EfkVDIvEgtbhED59VVycwH HTTP/1.1
Host: yeastardocs.example.yeastarcloud.com
响应示例
HTTP/1.1 200 OK
{
"errcode": 0,
"errmsg": "SUCCESS",
"total_number": 1,
"data": [
{
"id": 4,
"contact_name": "Jay Prichett",
"company": "Closet",
"email": "jayprichett@icloud.com",
"business": "001-5503308",
"mobile": "15735810000",
"phonebook_list": [
{
"id": 5,
"name": "Vendor"
},
{
"id": 3,
"name": "All Company Contacts_Phonebook"
}
]
}
]
}