About the REST API

The Wipple CPaaS REST API lets your back-end systems create, query, update and end calls, and inspect the conferences and queues that are active on your account.

API endpoint

All requests are sent to the API endpoint assigned to your account. In this documentation the host name is written as {API_ENDPOINT}; the base URL is therefore:

https://{API_ENDPOINT}/v1

Every call-control resource lives beneath your account:

https://{API_ENDPOINT}/v1/Accounts/{AccountSid}/...

{AccountSid} is the identifier of your account. It also appears as account_sid in every webhook.

Authentication

The API uses bearer authentication. Send your API key in the Authorization header of every request:

Authorization: Bearer <token>

API keys grant full control over the calls on your account. Store them securely and never embed them in client-side code.

Request format

Requests that carry a body must use Content-Type: application/json. Path segments such as {AccountSid}, {CallSid} and {ConferenceName} are replaced by the actual identifiers.

HTTP response codes

Errors are reported with a 4xx or 5xx status. Where a body is returned it is a JSON object with a msg property describing the problem:

{
  "msg": "call not found"
}

Endpoints

Calls

Conferences

Queues