NixoSMS – Laravel Self-Hosted SMS Gateway
Connect Mobile Apps To Server
Getting Started
Welcome to the SMS API documentation. This API allows you to send SMS messages and check their delivery status.
Base URL
https://example.com/api
Authentication
All API requests require a Bearer token in the Authorization header.
Note: Include your Bearer token in the Authorization header for all requests.
Authorization: Bearer YOUR_ACCESS_TOKENSend SMS
Send SMS messages to any phone number through SIM1 or SIM2.
Endpoint
GET
/send/sms
Request Parameters
| Parameter | Required | Values | Description |
|---|---|---|---|
| device_id | Yes | string | Your Device ID |
| sim | Yes | sim1/sim2 | SIM slot selection |
| number | Yes | string | Recipient phone number |
| sms | Yes | string | Message content |
Example Request
curl --location 'https://example.com/api/send/sms?device_id=YOUR_DEVICE_ID&sim=sim1&number=RECIPIENT_NUMBER&sms=MESSAGE_TEXT'
\--header 'Authorization: Bearer yp9R89xLf5aWp9cFfBUpoDjaPhBuIFNQbEt8KFHP9oWEV4vrBWeUjue1iIcwF2cUicAJDKrnMEQvfoTn'
Example Response
{
"status": true,
"message": "Sms send successfully",
"sms_id": 17
}
Check SMS Status
Check the delivery status of a sent SMS message.
Endpoint
GET
/check/status
Request Parameters
| Parameter | Required | Values | Description |
|---|---|---|---|
| id | Yes | integer | SMS ID received from send response |
Example Request
curl --location 'https://example.com/api/check/status?id=SMS_ID' \
--header 'Authorization: Bearer yp9R89xLf5aWp9cFfBUpoDjaPhBuIFNQbEt8KFHP9oWEV4vrBWeUjue1iIcwF2cUicAJDKrnMEQvfoTn'
Example Response
{
"status": true,
"message": "SMS found",
"data": {
"id": 6,
"device_id": 5,
"sim": "sim2",
"number": "01829934805",
"sms": "Test message",
"status": 2,
"created_at": "2025-07-02T05:59:58.000000Z",
"updated_at": "2025-07-02T06:00:02.000000Z"
}
}
Status Codes
- 1 = Delivered
- 2 = Processing
- 3 = Failed
Error Handling
Common error responses and their meanings.
| HTTP Code | Error Code | Description |
|---|---|---|
| 400 | invalid_request | Missing or invalid parameters |
| 401 | unauthorized | Invalid or missing access token |
| 403 | permission_denied | Insufficient permissions |
| 404 | not_found | SMS not found |
Support
For any technical issues or questions regarding NixoSMS, please contact our support team:
Note: This contact information is for
technical support only. Please include detailed information about your issue when
contacting us.