Free and immediate reminder Free and immediate reminder
04.13.41.50.70 (appel gratuit depuis un fixe)

Send SMS with mail merge

Definition

This option allows you to customize SMS messages for your recipients.
You can set up the customization on your side, but it requires you to send a separate request for each telephone number, which can take several minutes depending on the size of your lists.
Through the Octopush mail option, sending your messages to all of your contacts will take only a few seconds.

URL

http://www.octopush-dm.com/api/sms
or
https://www.octopush-dm.com/api/sms

Encoding

UTF-8

Special parameters

Name Definition
user_login User login (email address).
api_key API key available on your manager.
sms_recipients List of numbers in international format + XXZZZZZ separated by commas.
sms_text Message text (maximum 459 characters).
sms_type SMS Type: XXX = Low Cost SMS; FR = Premium SMS; WWW = Global SMS. In France, if "STOP XXXXX" is missing from your text, the API will return an error.
sms_sender Sender of the message (if the user allows it), 3-11 alphanumeric characters (a-zA-Z).
recipients_first_names* Replacing the string {nom} of your message, separated by commas.
recipients_last_names* Replacing {prenom} string of your message, separated by commas.
sms_fields_1* Replacing the string {ch1} of your message, separated by commas.
sms_fields_2* Replacing the string {ch2} of your message, separated by commas.
sms_fields_3* Replacing the string {ch3} of your message, separated by commas.

* These parameters are optional. They may also contain only one data item.

Curl example

curl "https://www.octopush-dm.com/api/sms/?user_login=*****%40******.com&api_key=***************&sms_text=un+exemple+de+texte&sms_recipients=0033601010101,0033601010102,0033601010103&recipients_last_names=durand,tchang,smith&sms_fields_1=M,Mme,Mr&sms_type=WWW&sms_sender=Octopush&sms_mode=2"

XML Back

<?xml version="1.0" encoding="UTF-8"?>
<octopush>
    <error_code>000</error_code>
    <cost>0.105</cost>
    <balance>6.93</balance>
    <ticket>api110000000021</ticket>
    <sending_date>1455975613</sending_date>
    <number_of_sendings>1</number_of_sendings>
    <currency_code>€</currency_code>
    <successs>
        <success>
            <recipient>+33601010101</recipient>
            <country_code>FR</country_code>
            <cost>0.550</cost>
        </success>
    </successs>
    <failures/>
</octopush>

Defining XML Tags

Refer to page XML Returns