sms77.io¶
Getting Started with sms77¶
The sms77 modules allow you to send SMS, check messages status, check account balance and pricing, send a voice message, and lookup HLR, MNP, and CNAM information in your sms77 account.
Prerequisites
- An sms77 account
In order to use sms77 with Ibexa Connect, it is necessary to have an sms77 account. If you do not have one, you can create an sms77 account at sms77/signup.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting sms77 to Ibexa Connect¶
To connect your sms77 account to Ibexa Connect, you need to obtain your API Key.
1. Login to your sms77 account.
2. From the left menu, click Settings and then click HTTPS API.
3. Copy the API Key to your clipboard.
4. Go to Ibexa Connect and open the sms77 module's Create a connection dialog.
5. In the Connection name field, enter a name for the connection and click Continue.
6. In the API Key field, enter the API key copied in step 3.
7. Click Continue.
The connection has been established.
Other¶
Send SMS¶
Sends one/multiple SMS to one/multiple user(s).
Message |
Enter the message text. |
Recipient |
Enter the recipient's phone number. |
Debug |
Select whether you want to send the SMS and charge the account:
|
Delay |
Enter the date and time when you want to send the message. For example, |
Flash |
Select whether to send SMS as a flash:
|
From |
Enter the name or phone number that displays to the recipient. |
Label |
Enter a label for the message to filter the messages when searching. For example, |
No Reload |
Select whether to send duplicate SMS within a timeframe of 180 seconds:
|
Performance Tracking |
Select whether to active performance tracking for URLs found inside the message. |
Time to Live |
Enter the time in milliseconds after which you do not want the message to be delivered. |
Type |
Select the SMS type:
|
User data Header (UDH) |
Select whether to send SMS with custom User Data Header (UDH). If set and parameter text contains hex code, the SMS is sent as 8-bit binary SMS. Only direct SMS support custom UDH:
|
Unicode |
Select whether the message contains any encoding characters:
|
UTF8 |
Select whether you want to disable the automatic message format detection from the server and enforces the message(s) as UTF8:
|
Status¶
Retrieves the status information for a single message ID.
| Message ID | Enter the Message ID whose status you want to retrieve. |
Balance¶
Returns the account balance for a given API key.
Pricing¶
Retrieves the pricing information for a specific country or all.
ISO Code |
Enter the ISO code to retrieve the pricings |
SMS Type |
Select the SMS type for which you want to view the pricing details:
|
Voice¶
Send a text to a speech voice call to any number.
Recipient |
Enter the phone number of the recipient. |
Message |
Enter the message in the text that needs to be converted to voice. |
XML |
Select whether the recipient details are in XML format:
|
Sender |
Enter the sender number. |
Validate for Voice¶
Validates caller IDs for our voice API. Returns a code on successful validation. Simultaneously the given number receives a call from us where the recipient needs to enter the code via DTMF.
| Phone number | Enter the phone number whose Caller ID you want to validate. |
| Callback URL | Enter the callback URL to call the phone number to validate the Caller ID. |
Lookup¶
Looks up publicly available information about a phone number.
| Phone Number | Enter the phone number whose details you want to lookup. |
Lookup HLR¶
Performs a Home Location Register (HLR) lookup.
| Phone Number | Enter the phone number whose HLR information you want to lookup. |
Lookup MNP¶
Performs a Mobile Number Portability (MNP) lookup.
| Phone Number | Enter the phone number whose MNP information you want to lookup. |
Lookup CNAM¶
Performs a Calling Name Delivery lookup.
| Phone Number | Enter the phone number whose Caller ID information you want to lookup. |
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the sms77 API Documentation. |
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - Get Balance¶
The following API call returns balance amount in your sms77 account:
URL: balance
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body. In our example, the balance amount in the sms77 account is returned:
