Definition
When sending to mainland France (you may inquire regarding other destinations), you can activate the “SMS answer” option.
The sender is replaced by a short number, at no charge, to which which your recipients can reply.
Receiving replies
3 ways to get the replies:
- On the interface: you have access to your replies either by country or by date.
- Email: send us an email to which we will reply with the answers as soon as they arrive.
- By Callback: send us a URL that we can use to send you the answers. > Read more
URL
XML :Â https://www.octopush-dm.com/api/sms
JSON :Â https://www.octopush-dm.com/api/sms/json
Or
UTF-8
Special parameters
Nom | 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. |
with_replies | Set to 1 to indicate that you want answers to messages that were sent |
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&sms_type=FR&sms_sender=Octopush&with_replies=1”
XML Back
000
0.55
6.93
api110000000021
1455975613
1
€
< successs>
< success>
+33601010101
FR
0.055
< /success>
< /successs>
< /failures>
JSon Back
{“error_code“:“000”,”cost“:0.055,”balance“:6.93,”ticket“:“api110000000021”,”sending_date“:1501503703,”number_of_sendings“:1,”currency_code“:“u20ac”,”failures“:[],”successs“:{“recipient“:33601010101,”country_code“:”FR”,”cost“:0.550,”sms_needed“:1}}
Defining XML Tags
Refer to page XML Returns