This document provides some guidance, to allow dispatch software developers to build API endpoints which we can interact with when a telephone call is received. We can create a request in virtually any format. However, to provide easy integration, we have some standards which will allow easy integration.
The responses can also be in virtually any format, as long as we can get the data that we need.
Our preferred integration methods:
- Node.js client library
- REST API
Methods | Description |
---|---|
invite | Start a new inbound call. |
ringing | Show a call ringing at an agent phone(s). |
missed | Report a missed call (to allow a call back / update statistics). |
connected | New connected call |
cleared | A call has ended |