Send SMS
Send text messages
158 subscribers
749 ms avg latency
58 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Send SMS endpoints
| Method | Endpoint | Description |
|---|---|---|
| User API | ||
| GET |
User status /API/v1.0/REST/status |
Used to retrieve the services status of the user identified by the id. |
| GET |
Dashboard /API/v1.0/REST/dashboard |
API used to retrieve the dashboard URL of the authenticated user |
| GET |
Verify session /API/v1.0/REST/checksession |
Checks whether the user session is still active and valid (without renewal) |
| POST |
Reset password /API/v1.0/REST/pwdreset |
Changes the authenticated user’s password |
| Contacts API | ||
| POST |
Add a contact /API/v1.0/REST/contact |
Add a contact to the user’s addressbook. |
| GET |
Get a contact /API/v1.0/REST/contact/{contactid} |
Get a contact’s details |
| POST |
Registration of a contact to a list /API/v1.0/REST/list/{campaign_id}/contact |
Creates a new contact entry and adds it onto the specified campaign. |
| GET |
List contact’s custom fields /API/v1.0/REST/contacts/fields |
Returns the list of user’s defined custom fields |
| POST |
Add contact to sms blacklist /API/v1.0/REST/contact/add_to_blacklist/{CONTACT_ID} |
Returns the result of operation |
| POST |
Add multiple contacts to sms blacklist /API/v1.0/REST/contact/add_to_blacklist_batch |
Add multiple contacts to the user’s blacklist. |
| POST |
Add phone number to sms blacklist /API/v1.0/REST/contacts/add_to_blacklist?phoneNumber=PHONE_NUMBER |
Add phone number to sms blacklist |
| POST |
Add multiple contacts https://app.gateway.smsend.it/API/v1.0/REST/contacts |
Add multiple contacts to the user’s addressbook. |
| Authentication API | ||
| GET |
Authenticate using a user token /API/v1.0/REST/token |
The login with token API lets you authenticate by using your username and password, and returns a token to be used for authenticating the next API calls |
| GET |
Authenticate using a session key /API/v1.0/REST/login |
The login with session key API lets you authenticate by using your username and password, and returns a token to be used for authenticating the next API calls |
| SMS History API | ||
| GET |
Get sent SMS messages history /API/v1.0/REST/smshistory |
Returns the user’s SMS messages history |
| Subaccount API | ||
| GET |
Get the list of subaccounts /API/v1.0/REST/subaccounts |
Returns the list of subaccounts of the authenticated user. |
| POST |
Create a subaccount /API/v1.0/REST/subaccount |
Creates a new subaccount for the authenticated user, which has to be a superaccount. |
| POST |
Move credits from/to subaccount /API/v1.0/REST/subaccount/{subaccount_id}/credit |
Transfers credits between a superaccount and a subaccount. The subaccount must be enabled to have its own credits (i.e. subaccount credit-eat-mode is 0 or 2) |
| GET |
Get a subaccount’s purchases /API/v1.0/REST/subaccount/{subaccount_id}/purchase |
Returns the paginated list of purchases made by a subaccount. Caller must be a superaccount. |
| POST |
Change subaccount password /API/v1.0/REST/subaccount/{subaccount_id}/changepwd |
Change a subaccount’s password |
| GET |
Get subaccount available credits /API/v1.0/REST/subaccount/{subaccount_id}/credit |
Returns the available credits of the given subaccount |
| GET |
Get subaccount /API/v1.0/REST/subaccount/{subaccount_id} |
Returns the list of subaccounts of the authenticated user. |
| POST |
Create a subaccount purchase /API/v1.0/REST/subaccount/{subaccount}/purchase |
Creates one or more purchases for the given subaccount. Subaccount credit-eat-mode must be 2. Caller must be a superaccount. |
| PUT |
Edit subaccount /API/v1.0/REST/subaccount/{subaccount_id} |
Edits the subaccount identified by the given subaccount_id. Calling user must be a superaccount. |
| DELETE |
Delete a subaccount’s purchase /API/v1.0/REST/subaccount/{subaccount_id}/purchase/{purchase_id} |
Deletes a purchase of the given subaccount. Caller must be a superaccount, and the Subaccount’s credit-eat-mode should be 2. |
| Two_Factor Authentication | ||
| POST |
Verify a 2FA Pin /API/v1.0/REST/2fa/verify |
Verify that the pin inserted by the user is valid. |
| POST |
Request a 2FA Pin /API/v1.0/REST/2fa/request |
Request a Two Factor Authentication via text message. This method generates a pin and sends it via text message to the user. |
| Email_Campaign API | ||
| PUT |
Modify a list /API/v1.0/REST/list/{list_id} |
Updates a sending list. |
| POST |
Create a new list /API/v1.0/REST/list |
Create a new sending list. |
| POST |
Add a contacts group to a list of distribution /API/v1.0/REST/list/{list_id}/group/{group_id} |
Add all contacts of the given group to the given list of distribution. Emails can be only sent to contacts that belong to a distribution list. |
| GET |
Get list of campaigns by statuses /API/v1.0/REST/list |
Get list of campaigns by statuses. If statuses is not specified by default return only ACTIVE campaign. |
| Email Campaign API | ||
| POST |
Create a new email draft /API/v1.0/REST/list/{list_id}/issue |
Creates a new email draft. Every email draft must be associated to a distribution list. |
| POST |
Create new issue using a specified template /API/v1.0/REST/list/{campaignId}/issue/template/{template} |
Creates a new issue starting from the specified template. |
| POST |
Send an issue to preloaded contacts /API/v1.0/REST/list/{campaignId}/issue/{idIssue} |
Schedule an issue to be sent to a specified list of contacts Ids at a given time. |
| Received_SMS API | ||
| GET |
Get the MO received messages /API/v1.0/REST/mosmshistory |
This feature is available only for French customers!. Returns a list (limited to max. 100 entries) of MO messages received for the give type which could be STOP or CONTACT or… |
| GET |
Get the received SMS messages after a specified message. /API/v1.0/REST/srsmshistory/{id_sim}/{id_message} |
Returns a list (limited to max. 100 entries) of SMS messages received after the given SMS message ID id_message, for the given SIM id_sim. |
| GET |
Get the received SMS messages for one or more specific SIMs API/v1.0/REST/srsmshistory/{id_sim} |
Get the paginated list of received SMS messages. |
| GET |
Get new received messages for all SIMs /API/v1.0/REST/newsrsmsmessage |
Returns the list of received messages on the given sim_id since the last call of this method, or the beginning of time if it’s the first call. The list is limited to max. 100… |
| Contacts_groups API | ||
| POST |
Add a contact to a group /API/v1.0/REST/group/{group_id}/contact/{contact_id} |
Adds the specified contact in the specified contacts group. |
| POST |
Create a contacts group /API/v1.0/REST/group |
Creates an empty group of contacts given a name and a description. |
| Landing_pages API | ||
| GET |
List the published landing pages /API/v1.0/REST/landings |
Returns the list of published landing pages of the user. |
| Contacts groups_API | ||
| DELETE |
Delete a contacts group /API/v1.0/REST/group/{group_id} |
Deletes the contacts group identified by the given ID. |
| PUT |
Modify an existing contacts group /API/v1.0/REST/group/{group_id} |
Updates a given contacts group |
| GET |
List contacts groups /API/v1.0/REST/groups |
Returns the list of existing contacts groups, paginated. |
| DELETE |
Remove a contact from a group /API/v1.0/REST/group/{group_id}/contact/{contact_id} |
Removes the specified contact from the specified contacts group. |
| SMS Blacklist/Stop SMS | ||
| POST |
Add Phone Number to Blacklist /API/v1.0/REST/blacklist/sms |
Add Phone Number to SMS Blacklist The Phone number will no longer receive an SMS from the user requesting the addition to the blacklist. |
| POST |
Add multiple numbers to sms blacklist /API/v1.0/REST/blacklist/smsbatch |
Add multiple numbers to the user’s blacklist. |
| GET |
Retrieve list of phone numbers in blacklist /API/v1.0/REST/blacklist/sms |
Retrieve the paginated list of Phone numbers in SMS Blacklist |
| TPOA_API | ||
| GET |
Get all aliases /API/v1.0/REST/alias |
Returns a paginated list of the user’s TPOA aliases. |
| GET |
Get a specific alias /API/v1.0/REST/alias/{alias_id} |
Returns the data of the given TPOA Alias ID. |
+ 8 more endpoints on the provider's documentation.
Send SMS pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|