查询企业联系人群组列表

查询企业联系人群组列表。

请求 URL

GET {base_url}/{api_path}/phonebook/list?access_token={access_token}

请求参数

表 1.
参数 是否必填 类型 说明
page 否 Integer 定义显示第几个页面。
page_size 否 Integer 定义每页显示几项查询结果。
sort_by 否 String 定义排序字段。

取值范围：

  • name
  • total
  • id
order_by 否 String 定义显示顺序。

取值范围：

  • asc：升序
  • desc：降序

响应参数

表 2.
参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
total_number Integer 企业联系人群组总数。
data Array<Phonebook_Info> 企业联系人群组信息。
Phonebook_Info
表 3.
参数 类型 说明
id Integer 企业联系人群组的唯一 ID。
name String 企业联系人群组名称。
total Integer 包含的企业联系人总数。
member_select String 联系人选择方式。
  • sel_all：选择所有企业联系人。
  • sel_specific：选择指定企业联系人。

示例

请求示例

GET /openapi/v1.0/phonebook/list?access_token=go18MODkNUAOReyKCnKzm6HEr6qTD1Pq HTTP/1.1  

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 2,
    "data": [
        {
            "id": 3,
            "name": "All Company Contacts_Phonebook",
            "total": 7,
            "member_select": "sel_all"
        },
        {
            "id": 5,
            "name": "Vendor",
            "total": 6,
            "member_select": "sel_specific"
        }
    ]
}