SMS
Send With SES integrates with your AWS SNS account to send SMS (Text Messages). You can send SMS manually or via the API. There are three types of SMS you can send and each type has a predefined template.
Type of SMS | How to send |
|---|---|
Transactional | Manually or via API |
Marketing | Manually or via API |
One Time Passwords (OTP) | ONLY via API |
To send an SMS manually, select one or more contacts or filter contacts using the options in the left panel and click "Send Button" at top. You will be shown a popup where you can compose your SMS.
NOTEs:
- Sender ID is optional. Enter only if you have one.
- Origination number is required only if you are sending to USA mobile numbers.
See the request/response details below.
API Request
API Response
URL: https://api.sendwithses.com/send-sms
1
{
2
"method": "POST",
3
"url": "https://api.sendwithses.com/send-sms",
4
"headers": {"template-key": "**************************4lVm"},
5
"body": {
6
"sender_id": "ABCDEF",
7
"origination_number": "+449876543212",
8
"mobile": "+449876543210",
9
"message": "Hello John."
10
}
11
}
IMPORTANT:
- All API calls MUST include the Template Key. Template Key is unique to Transactional SMS and Marketing SMS.
- 'Origination Number' is required only when sending to USA mobile numbers.
- All mobile numbers MUST be in E.164 format.
Success Response:
1
{
2
"success": true,
3
"message": "SMS Sent"
4
}
Failed Response:
1
{
2
"success": false,
3
"message": "message details",
4
"error": "error details"
5
}
OTP SMS is used to send one time codes intended for Two-Factor Authentication (2FA) or other high value transactions within your website or mobile app. OTP SMS has a template that allows you to customize fields like App Name, OTP Size, and OTP Expiry Time.
The OTP SMS includes two parts, Send API and Verify API.
Send API
Verify API
Send API is used to trigger the SMS containing one time code to the end user.
URL: https://api.sendwithses.com/send-otp
Request:
1
{
2
"method": "POST",
3
"url": "https://api.sendwithses.com/send-otp",
4
"headers": {"template-key": "****************************elA2"},
5
"body": {
6
"sender_id": "ABCDEF"
7
"origination_number": "+449876543212"
8
"mobile": "+449876543210",
9
}
10
}
Success Response:
{
"success": true,
"message": "OTP Sent"
}
Failed Response:
1
{
2
"success": false,
3
"message": "message details",
4
"error": "error details"
5
}
IMPORTANT:
- All API calls MUST include the Template Key. Template Key is unique to OTP SMS.
- 'Origination Number' is required only when sending to USA mobile numbers.
- All mobile numbers MUST STRICTLY be in E.164 format.
Verify API is used to match the one time code received from end user with the code generated during the Send API call.
URL: https://api.sendwithses.com/verify-otp
Request:
1
{
2
"method": "POST",
3
"url": "https://api.sendwithses.com/verify-otp",
4
"headers": {"template-key": "***********************elA2"},
5
"body": {
6
"mobile": "+449876543210"
7
"otp": "123456",
8
}
9
}
Success Response:
1
{
2
"success": true,
3
"message": "OTP Verified"
4
}
Failed Response:
1
{
2
"success": false,
3
"message": "message details",
4
"error": "error details"
5
}
IMPORTANT:
- All API calls MUST include the Template Key. Template Key is unique to OTP SMS.
- 'Origination Number' is required only when sending to USA mobile numbers.
- All mobile numbers MUST STRICTLY be in E.164 format.
Last modified 28d ago