API docs by Redocly

VoxiSMS API (3.0.0)

Download OpenAPI specification:

Public API for sending SMS messages through the VoxiSMS platform. Messages are enqueued and delivered by the VoxiSMS Android app via the device's native SMS capability.

Send an SMS

Enqueues an SMS message for delivery. Authentication uses a shared x-api-key header plus per-customer customerId and secretKey in the request body.

Authorizations:
api_key
Request Body schema: application/json
required
customerId
required
string

Your VoxiSMS Customer ID.

secretKey
required
string

Your VoxiSMS Secret Key.

recipient
required
string

Destination phone number in E.164 format.

message
required
string

The SMS message content.

id
string

Optional client-supplied message ID. A UUID is generated automatically if omitted.

webhookUrl
string <uri>

Optional URL to receive delivery/status event callbacks.

source
string

Originating integration identifier.

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "secretKey": "string",
  • "recipient": "+15551234567",
  • "message": "string",
  • "id": "string",
  • "webhookUrl": "http://example.com",
  • "source": "zapier"
}

Response samples

Content type
application/json
{
  • "code": 200,
  • "message": "string",
  • "data": {
    }
}