Brekeke PBX Wiki

getContactList

getContactList

 

Permissions:

admin or user

 

Description:

Retrieves lists of the contact summary.

 

Parameters:

phonebook – a name of the phonebook
shared – true if the phonebook is shared (admin only)
search_text – keywords to search contacts (separated by a white space)
offset – an offset position to retrieve the contact (default: 0)
limit – maximum number of contact to be retrieved (default: 100, maximum: 1000)

 

Returns:

If the method succeeds, it returns an array of a contact summary in the format shown below:
aid – the ID of the contact
display_name – a display name of the contact

 

Version:

3.8 or later

Yes No
Suggest Edit