Query Information of a Phonebook

Query the detailed information of a phonebook.

Request URL

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

Request parameters

Table 1.
Parameter Required Type Description
id Yes Integer The unique ID of the phonebook.
Note: You can query the phonebook's ID using Search Specific Phonebooks.

Response parameters

Table 2.
Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
data Object<Phonebook_DetailInfo> The list of the phonebook's detailed information.
Table 3.
Parameter Type Description
id Integer Phonebook ID.
name String Phonebook name.
member_select String The member selection method.
  • sel_all: All company contacts are selected.
  • sel_specific: Specific company contacts are selected.
contacts_list Array<Contacts_List> The list of company contact's information.
total Integer The total of company contacts contained in the phonebook.
Table 4.
Parameter Type Description
id Integer The unique ID of the company contact.
contact_name String The name of the company contact.
company String Company.
email String Email address.
business String Business number.
business2 String Business number 2.
mobile String Mobile number.
mobile2 String Mobile number 2.
home String Home number.
home2 String Home number 2.
home_fax String Home fax.
business_fax String Business fax.
other String Other number.
remark String Remark.


Request example

GET /openapi/v1.0/phonebook/get?id=5&access_token=go18MODkNUAOReyKCnKzm6HEr6qTD1Pq HTTP/1.1 

Response example

HTTP/1.1 200 OK
    "errcode": 0,
    "errmsg": "SUCCESS",
    "data": {
        "id": 5,
        "name": "Vendor",
        "member_select": "sel_specific",
        "contacts_list": [
                "id": 3,
                "contact_name": "Joseph Goffin",
                "company": "Ticketsales",
                "email": "joseph@gmail.com",
                "business": "12354978652"
                "id": 4,
                "contact_name": "Jay Prichett",
                "company": "Closet",
                "email": "jayprichett@icloud.com",
                "business": "001-5503308",
                "mobile": "15735810000"
                "id": 8,
                "contact_name": "Test P-Series",
                "company": "Yeastar",
                "email": "test@icloud.com",
                "business": "12333333",
                "remark": "contact_for_test"
                "id": 10,
                "contact_name": "P-Series",
                "company": "Yeastar",
                "email": "test@icloud.com",
                "business": "5503301",
                "remark": "contact_for_test"
                "id": 11,
                "contact_name": "Example Li",
                "company": "Yeastar",
                "email": "liexample@icloud.com",
                "business": "12333333",
                "remark": "contact_for_test"
                "id": 29,
                "contact_name": "Test-contact",
                "business": "55667788"
                "id": 30,
                "contact_name": "Test-contact2",
                "business": "9910101111"
                "id": 32,
                "contact_name": "Test-contact3",
                "company": "Yeastar",
                "email": "testcontact@126.com",
                "business": "1235555999"
        "total": 8