Getting started with Integration

This document will describe how to get started with our API.

Basic Integration

This documentation will guide you through the process of integrating with our API, from obtaining API credentials to constructing HTTP requests and handling responses. With our comprehensive documentation and examples, you'll be up and running in no time, sending SMS messages to your users' mobile devices effortlessly.

Let's dive in and unlock the full potential of SMS communication in your application:

1. Let's get started by creating your API key.

2. If you'd like to receive Delivery Receipts , register your Webhook listener endpoint.

3. Send messages to Single Recipients , or scale up your outreach by Sending Batches of up to 1,000 messages per request.

Authentication

Authentication to the API is performed via Bearer keys. Once you have created your API Key, it should be provided along with every request.

For example, use the following in CURL requests:

-H "Authorization: Bearer [API Key]"

Sending Messages

SMS message delivery operates as an asynchronous process within our system. Upon submitting a message to our platform, we will acknowledge receiving the message and asynchronously deliver it to the handset.

If you registered for Delivery Receipt notifications, you will receive those to your specified webhook endpoint as they arrive in our system. It is recommended that you store those receipts for asynchronous processing on your end.

BulkSMS API usage overview

Please note: All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Keep your API Keys secure! Remember not to share your keys in publicly accessible areas such as client-side code or a public Git repository.