Skip to Content

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

ParameterRequiredTypeDescription
idYesIntegerThe unique ID of the phonebook.
Note: You can query the phonebook's ID using Search Specific Phonebooks.

Response parameters

ParameterTypeDescription
errcodeIntegerReturned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsgStringReturned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
dataObject<Phonebook_DetailInfo>The list of the phonebook's detailed information.

Phonebook_DetailInfo

ParameterTypeDescription
idIntegerPhonebook ID.
nameStringPhonebook name.
member_selectStringThe member selection method.
  • sel_all: All company contacts are selected.
  • sel_specific: Specific company contacts are selected.
contacts_listArray<Contacts_List>The list of company contact's information.
totalIntegerThe total of company contacts contained in the phonebook.

Contacts_List

ParameterTypeDescription
idIntegerThe unique ID of the company contact.
contact_nameStringThe name of the company contact.
companyStringCompany.
emailStringEmail address.
businessStringBusiness number.
business2StringBusiness number 2.
mobileStringMobile number.
mobile2StringMobile number 2.
homeStringHome number.
home2StringHome number 2.
home_faxStringHome fax.
business_faxStringBusiness fax.
otherStringOther number.
remarkStringRemark.

Examples

Request example

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

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 BCS",
                "company": "Cloud One",
                "email": "test@icloud.com",
                "business": "12333333",
                "remark": "contact_for_test"
            },
            {
                "id": 10,
                "contact_name": "BCS",
                "company": "Cloud One",
                "email": "test@icloud.com",
                "business": "5503301",
                "remark": "contact_for_test"
            },
            {
                "id": 11,
                "contact_name": "Example Li",
                "company": "Cloud One",
                "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": "Cloud One",
                "email": "testcontact@126.com",
                "business": "1235555999"
            }
        ],
        "total": 8
    }
}