​
API Reference

The Voxeme account-level REST API allows you to create and manage calls, applications, speech credentials, carriers, and other resources associated with your account.

​
Authentication

The API uses Bearer authentication; i.e., a bearer token that must be provided in the Authorization header: 
Authorization: Bearer 'your-api-token'
You can generate an API token for your account in the hosted portal.

​
HTTP Response Codes

  • POST requests will return a 201 status on success and a JSON payload that includes a sid property referencing the unique identifier of the resource that has been created.
  • UPDATE and DELETE requests will return a 204 status on success with no body
  • GET requests will return a 200 response with a JSON payload

​
API Version

The current version of the API is v1.

​
Base URL

The base URL for all API requests is determined by your deployment. For cloud-hosted instances, this will be provided in your account portal.

​
Rate Limiting

API requests are subject to rate limiting to ensure fair usage and system stability. Current limits are:
  • 1000 requests per hour per account
  • 100 requests per minute per account
Exceeding these limits will result in a 429 (Too Many Requests) response.