Bring Your Own Directory API
The Bring Your Own Directory API is a specification for integrators who want to provide their own contact directory to the Buzzeasy Agent UI.
After configuring the API URL and API key in the Administration Portal under Administration > Configuration > Agent, the Agent UI directory module uses this API instead of the built-in directory feature.
Contacts returned by this API can be consulted with or transferred to from a customer call. They can also be used as email recipients.
Implementation requirements
Implement the API endpoints described in the specification below and make them available at the configured API URL. Authenticate every request using the x-api-key header with the API key configured in the Administration Portal.
The contact search endpoint supports continuation tokens through skipToken. Presence can be refreshed for a collection of contact IDs through the presence endpoint.