Interactive API Playground
Introduction
Welcome to the Laravel API. Our API allows you to programmatically manage your SMS campaigns, devices, and contacts. You can test all endpoints directly from this page by pasting your API key in the top right.
Note: API requests made from this page hit the live production servers. Sending an SMS here will deduct from your actual balance.
Authentication
All requests to the API must be authenticated using a Bearer token. Include your API key in the Authorization header.
/api/v1/sms/send
Send an SMS message to a specific number using one of your mapped sender devices. This endpoint is asynchronous. The message is immediately queued for delivery and you will receive a log_id to track its status.
Parameters
| Name | Type | Description |
|---|---|---|
| sender | string | The exact name of the sender mapping configured by the admin. If left null or omitted, any active sender will be assigned automatically. |
| to * | string | The recipient's phone number including the country code (e.g., 8801700000000). |
| message * | string | The text content of the SMS message. |
Example Code
Interactive Tester
Live Request
/api/v1/sms/status
Check the status of a previously submitted SMS message using its log ID. Our system continuously synchronizes the real-time device status (e.g., pending, processing, sent, failed) in the background.
Parameters
| Name | Type | Description |
|---|---|---|
| log_id * | integer | The log_id returned by the /api/v1/sms/send endpoint. |
Example Code
Interactive Tester
Live Request
/api/v1/senders
Retrieve a list of all configured SMS senders. These are the mapped devices configured by the admin. You can use any of these names as the sender parameter when sending an SMS.
Parameters
Example Code
Interactive Tester
Live Request
Hit the button below to fetch your senders using the Bearer Token provided above.
/api/user
Get the profile details of the currently authenticated user based on the provided Bearer Token.
Parameters
Example Code
Interactive Tester
Live Request
Hit the button below to fetch your user info using the Bearer Token provided above.