SMS APIs enable you to streamline and automate your communications with your audience using either an alphanumeric sender ID, shortcode or keyword. The alphanumeric sender ID is ideal for sending business-initiated messages, such as notifications, marketing campaigns, advertising sales, offers, OTPs, and other transactional messages where a response is not required. On the other hand, shortcodes and keywords are designed for two-way messaging, making them perfect for interactive use cases like conducting surveys.
SMS API Functionalities
With SMS APIs, you can:
Send a Broadcast
Send a Survey
Receive inbound message notifications (Callback)
Authentication
All requests sent to our system will need to be authenticated. We use header-based authentication. The authentication headers are:
x-api-key
x-app-id
To generate your API Key and find your App ID, Click on SETTINGS on your Mteja app menu, then click on INTEGRATIONS.
Note: Regenerating the API Key will invalidate the previously generated key.
Send a Broadcast
To send an SMS broadcast, you will need the following:
API Endpoint: https://api.sentry.mteja.io/api/sms
Request Type: POST
Authentication Headers: x-api-key, x-app-id
For detailed information on the request payload, refer to the SMS Broadcast API documentation.
Send a Survey
Surveys must be set up in advance on the dashboard using our user-friendly flow builder. After creating a survey, you can automate its distribution through this API.
To send an SMS survey, you will need the following:
API Endpoint: https://api.sentry.mteja.io/api/sms-survey
Request Type: POST
Authentication Headers: x-api-key, x-app-id
For detailed information on the request payload, refer to the SMS Survey API documentation.
Receive Inbound Message Notifications (Callback)
To receive inbound message notifications, you need to configure a callback URL on your dedicated SMS shortcode/keyword. To do this, follow these steps:
Click on CHANNELS on your Mteja app.
Click on SMS CHANNELS.
Select DEDICATED SHORTCODE / KEYWORD.
Click on CONFIGURE.
At the bottom of the configuration page, you will find the settings for the callback URL as shown below.
For detailed information on the request payload, refer to the Inbound SMS Notification documentation