Version: 1.0.0
AgileTelecom SMS Universal API
REST API for sending SMS messages in Universal mode. Supports placeholders, automatic concatenation, UDH, scheduled sending, and delivery notifications.
Authentication
All requests require one of the following methods:
- API Key — Header
X-Api-Key: <api-key> - Basic Auth — Header
Authorization: Basic <base64(username:password)>
Main features
- Send SMS with alphanumeric or numeric sender
- Dynamic placeholder support in message text
- Automatic concatenation for long messages (multipart SMS)
- Custom UDH data for binary SMS
- Scheduled sending
- Dry run mode for testing
- Delivery notifications via webhook
Webhook — Delivery notifications
When enableNotification is enabled, the system sends HTTP POST callbacks to your URL configured in the platform.
Callback format
{
"channel": "SMS",
"eventType": "DELIVERY",
"messageId": "uuid",
"statusCode": 3,
"statusDescription": "Delivered",
"price": 0.035,
"numPart": 1,
"totalParts": 1,
"timestamp": "2024-01-15T10:30:00Z"
}
| Field | Type | Description |
|---|---|---|
channel | string | Always "SMS" |
eventType | string | Always "DELIVERY" |
messageId | string | UUID of the sent message |
statusCode | integer | 3 = Delivered, 6 = Not Delivered |
statusDescription | string | Human-readable status description |
price | number | Message cost |
numPart | integer | Delivered part number |
totalParts | integer | Total parts of the concatenated message |
timestamp | string | ISO 8601 timestamp of the notification |
Authentication
- API Key: ApiKeyAuth
- HTTP: Basic Auth
API Key provided by AgileTelecom
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-Api-Key |
Username/password credentials
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | basic |
Contact AgileTelecom: