Brekeke Documents

Find user guides, developer guides, API references, tutorials, and more!

Brekeke PBX Wiki

  1. Brekeke PBX basic Info
  2. Security
  3. Update & Upgrade
  4. Configuration
  5. Brekeke PAL option
  6. Integration with Zoho Products
  7. Integration with Microsoft Teams
  8. Add-ons
  9. Troubleshooting
  10. Developer's Guides
    1. Developer's Guide: ARS Plug-in
    2. Developer's Guide: Audio File Plug-in
    3. Developer's Guide: Flow
    4. Developer's Guide: Log Database
    5. Developer's Guide: PAL WebSocket
      1. 1. Brekeke PAL WebSocket Usage
      2. 2. Connecting with PAL WebSocket
      3. 3. Notifications
      4. 4. Methods
        1. alias (BSS REST API)
        2. barge
        3. blocklist (BSS REST API)
        4. callforward
        5. cancelTransfer
        6. conference
        7. copyRouteTemplate
        8. createExtension
        9. createTenant
        10. deleteContact
        11. deleteExtension
        12. deleteNote
        13. deletePrompt
        14. deleteRouteVariables
        15. disconnect
        16. email
        17. getAllDids
        18. getContact
        19. getContactList
        20. getExtensionProperties
        21. getExtensions
        22. getNote
        23. getNoteNames
        24. getOptions
        25. getPnApplicationInfo
        26. getPhonebooks
        27. getPlanSwitchTimer
        28. getRouteTemplateNames
        29. getRouteVariables
        30. getTalkerInfo
        31. getTenantProperties
        32. hold
        33. insertRouteVariables
        34. makeCall
        35. park
        36. pnmanage
        37. pnsend
        38. registered (BSS REST API)
        39. remoteControl
        40. renameRouteTemplate
        41. searchExtensions
        42. setContact
        43. setDid
        44. setExtensionProperties
        45. setNote
        46. setPlanSwitchTimer
        47. setTenantProperties
        48. startRecording
        49. stopRecording
        50. transfer
        51. unhold
        52. userdir (BSS REST API)
        53. unpark
        54. updateRouteVariables
      5. 5. Phonebook utility for javascript
      6. 6. Extension Settings Properties
      7. 7. Sample programs
      8. 8. REST API
    6. Developer's Guide: Web Service
    7. Simulate outside lines
  11. User's Guide
  12. Version History

getContactList

getContactList

 

Permissions:

admin or user

 

Description:

Retrieves lists of the contact summary.

 

Parameters:

phonebook – a name of the phonebook (optional)
shared – true if the phonebook is shared (optional)
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
« getContactgetExtensionProperties »
Suggest Edit