Send single or bulk SMS messages using the Single Message API
Overview
This API allows an enterprise to send a single message to one or more mobile numbers (a maximum of 50 mobile numbers at one time). It supports both GET and POST methods and can be used in synchronous or asynchronous mode.
HTTP Methods
This API uses the below HTTP method to send single or bulk SMS messages using the Single Message API.
- GET
- POST
API Endpoint
https://bulkpush.mytoday.com/BulkSms/SingleMsgApi
Request Headers
| Header Name | Type | Description | Example | Required |
|---|---|---|---|---|
| Content-Type | String | Media type of the request body | application/x-www-form-urlencoded | Yes (POST) |
| api-key | String | API key for authentication | - | - |
Request Parameters
GET Method
Request parameters must be URL encoded.
| Parameter | Type | Description | Example | Required |
|---|---|---|---|---|
| feedid | String | Account ID | account_id | Yes |
| username | String | Username | username | Yes |
| password | String | Password | password | Yes |
| To | String | Mobile number(s) (max 50) | mobile | Yes |
| Text | String | Message text | message | Yes |
| templateid | String | Template ID | templateid | Yes |
| entityid | String | Entity ID | entityid | Yes |
| async | Integer | Async or sync flag | 1 / 0 | Yes |
| short | Integer | Short URL flag | 1 / 0 | Optional |
POST Method
Allows uploading up to 10,000 messages.
| Parameter | Type | Description | Example | Required |
|---|---|---|---|---|
| feedid | String | Account ID | accountid | Yes |
| username | String | Username | username | Yes |
| password | String | Password | password | Yes |
| To | String | Mobile or comma-separated mobiles | mobile | Yes |
| Text | String | SMS text | Message | Yes |
| templateid | String | Template ID | templateid | Yes |
| entityid | String | Entity ID | entityid | Yes |
| async | Integer | Async or sync flag | 1 / 0 | Yes |
| short | Integer | Short URL flag | 1 / 0 | Optional |
Example Requests
GET
https://test1bulksms.mytoday.com/BulkSms/SingleMsgApi?feedid=<account_id>&username=<username>&password=<password>&To=<mobile>&Text=<message>&templateid=<templateid>&entityid=<entityid>&async=<1/0>&short=<1/0>
POST
curl --location --request POST 'https://test1bulksms.mytoday.com/BulkSms/SingleMsgApi' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'feedid=accountid' \
--data-urlencode 'username=username' \
--data-urlencode 'password=password' \
--data-urlencode 'To=mobile' \
--data-urlencode 'Text=Message' \
--data-urlencode 'templateid=templateid' \
--data-urlencode 'entityid=entityid' \
--data-urlencode 'short=1/0' \
--data-urlencode 'async=1/0'
Example Responses
<RESULT REQID ='29749608774'> </RESULT>
Sample success Sync Response :