SMS
These Programmable SMS API helps you to add robust messaging capabilities to your application . Our web app portal offers a comprehensive suite of SMS features to meet your communication needs. Whether you're sending individual messages, bulk messages, or specialized types of SMS, our platform provides the tools to ensure efficient, secure, and effective communication.
Features
Using SMS API, you can send:
- Bulk SMS
- OTP SMS
- Flash SMS
- SMS with Unicode
- WhatsApp API
Base URL
Headers
- Name
contentType
- Type
- string
- Description
This should be set to application/json.
- Name
apiKey
- Type
- string
- Description
Find your API key under your login account.
Send single message
Our web app portal allows you to send individual SMS messages efficiently and securely.
Required Attribute
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
text
- Type
- string
- Description
The phone number for the contact.
- Name
type
- Type
- string
- Description
Route Type
Request
{
'sender': 'senderName'\
'to': '91XXXXXXXXXX'\
'text': 'Hello World!'\
'type': 'TRANS'\
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXXX",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
}
],
"totalCount": 1,
"message": "Message Sent Successfully!",
"error": null
}
Send OTP SMS
Our web app portal includes a robust feature for sending OTP (One-Time Password) SMS messages. This functionality is crucial for applications requiring enhanced security, such as user authentication, transaction verification, and password resets. The OTP SMS ensures that only the intended recipient can complete the action, adding an extra layer of security to your processes.
Required Attributes
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
text
- Type
- string
- Description
The phone number for the contact.
- Name
type
- Type
- string
- Description
Route Type
Request
{
'sender': 'senderName'\
'to': '91XXXXXXXXXX'\
'text': 'Hello World!'\
'type': 'OTP'\
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXXX",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
}
],
"totalCount": 1,
"message": "Message Sent Successfully!",
"error": null
}
Send Bulk SMS
Our web app portal is equipped with a powerful bulk SMS feature designed to facilitate large-scale communication with your audience. This functionality is ideal for marketing campaigns, event notifications, alerts, and any situation where you need to reach multiple recipients simultaneously. With our bulk SMS feature, you can ensure that your message is delivered quickly and efficiently to all intended recipients.
Required attributes
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
text
- Type
- string
- Description
The phone number for the contact.
- Name
type
- Type
- string
- Description
Route Type
Request
{
'sender': 'senderName'\
'to': '"91XXXXXXXXX1, 91XXXXXXXXXX2, 91XXXXXXXXXX3'\
'text': 'Hello World!'\
'type': 'TRANS'\
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXX1",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
},
{
"recipient": "91XXXXXXXXX2",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:2"
},
{
"recipient": "91XXXXXXXXX3",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:3"
}
],
"totalCount": 3,
"message": "Message Sent Successfully!",
"error": null
}
Send SMS with Unicode
Our web app portal supports sending SMS messages with Unicode characters, allowing you to communicate in multiple languages and include special characters. This feature is essential for reaching a global audience, ensuring that your messages are accurately represented regardless of the language or symbols used.
Required Attributes
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
text
- Type
- string
- Description
The phone number for the contact.
- Name
type
- Type
- string
- Description
Route Type
Optional Attributes
- Name
unicode
- Type
- integer
- Description
To specify that themessage to be sent is in unicode format.
Request
{
'sender': 'senderName'\
'to': '91XXXXXXXXXX'\
'text': 'Hello World!'\
'type': 'TRANS'\
'unicode': 1
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXXX",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
}
],
"totalCount": 1,
"unicode": 1,
"message": "Message Sent Successfully!",
"error": null
}
Send Flash SMS
Our web app portal offers a Flash SMS feature, allowing you to send urgent and high-priority messages that appear directly on the recipient's mobile screen. Unlike regular SMS messages, Flash SMS doesn't get stored in the recipient's inbox by default, making it ideal for time-sensitive alerts, critical notifications, and emergency communications.
Required Attributes
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
text
- Type
- string
- Description
The phone number for the contact.
- Name
type
- Type
- string
- Description
Route Type
Optional Attributes
- Name
flash
- Type
- integer
- Description
Unique identifier for the contact.
Request
{
'sender': 'senderName'\
'to': '91XXXXXXXXXX'\
'text': 'Hello World!'\
'type': 'TRANS'\
'flash': 1\
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXXX",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
}
"flash": 1
],
"totalCount": 1,
"message": "Message Sent Successfully!",
"error": null
}
Send Template SMS
Our web app portal includes a Template SMS feature designed to streamline and standardize your messaging processes. This functionality allows you to create and use predefined message templates for various scenarios such as promotions, reminders, notifications, and more. With Template SMS, you can ensure consistent communication while saving time on message composition.
Required Attributes
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
text
- Type
- string
- Description
The phone number for the contact.
- Name
type
- Type
- string
- Description
Route Type
Optional Attributes
- Name
templateId
- Type
- string
- Description
Unique ID of the template
Request
{
'sender': 'senderName'\
'to': '91XXXXXXXXXX'\
'text': 'Hello World!'\
'type': 'TRANS'\
'templateId' :'templateId'\
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXXX",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
}
],
"totalCount": 1,
"message": "Message Sent Successfully!",
"error": null
}
Send SMS with templateId
Our web portal features a send SMS option with a templateId, making your messaging processes more efficient and consistent.
Required Attributes
- Name
sender
- Type
- string
- Description
Originator/Alphanumeric ID
- Name
to
- Type
- string
- Description
Recipient's MSISDN
- Name
templateId
- Type
- string
- Description
Unique ID of the template
- Name
type
- Type
- string
- Description
TRANS
- Name
custom
- Type
- object
- Description
If the template contains variables, pass a custom parameter value in the array with the number of variables present in the template data. Otherwise, pass the custom parameter with a blank array.
Request
{
"sender": "AOCAPI",
"to": "91XXXXXXXXXX",
"templateId": "150716565XXXXXXXXXX",
"custom": ["var1","var2"],
"type": "TRANS"
}
Response
{
"id": "58d63c02-XXXX-XXXX-XXXX-XXXXbb39453",
"data": [
{
"recipient": "91XXXXXXXXXX",
"messageId": "58d63c02-XXXXX-XXXXX-XXXXX-XXXX9bb39453:1"
}
],
"totalCount": 1,
"message": "Message Sent Successfully!",
"error": null
}