搜索特定企业联系人

从企业联系人列表中搜索特定的企业联系人。

请求 URL

GET {base_url}/{api_path}/company_contact/search?access_token={access_token}

请求参数

参数 是否必填 类型 说明
page Integer 定义显示第几个页面。
注: 如果没有设置此参数,则默认返回第一页。
page_size Integer 定义每页显示几项查询结果。

最大值:10000

注: 如果没有设置此参数,则默认每页返回 10000 项结果。
sort_by String 定义排序字段。

取值范围

  • id
  • contact_name
  • company
  • email
  • business
  • mobile
  • home
  • business_fax
order_by String 定义显示顺序。

取值范围

  • asc:升序
  • desc:降序
search_value String 搜索关键字。

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0:请求成功。
  • 非零值:请求失败。
注: 更多错误码和错误信息说明,请参见 错误码 & 错误信息
errmsg String 返回信息。
  • SUCCESS:请求成功。
  • FAILURE:请求失败。
total_number Integer 搜索到的企业联系人总数量。
data Array<Contact_Info> 企业联系人信息。
Contact_Info
参数 类型 说明
id Integer 企业联系人的唯一 ID。
contact_name String 企业联系人名称。
company String 公司。
email String 邮箱。
phonebook_list Array<Phonebook_List> 所属的企业联系人群组。
organization String 组织。
job_title String 职位。
position String 岗位。
industry String 行业。
supervisor String 上级。
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
参数 类型 说明
id Integer 企业联系人群组的唯一 ID。
name String 企业联系人群组名称。

示例

请求示例

GET /openapi/v1.0/company_contact/search?search_value=jay&access_token=9ZG6kC6xo4EfkVDIvEgtbhED59VVycwH HTTP/1.1  
Host: 192.168.5.150:8088

响应示例

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"
                }
            ]
        }
    ]
}