Définition
Pour les envois vers la France Métropolitaine (pour les autres destinations, nous demander), vous pouvez activer l’option « SMS réponse ».
L’émetteur est alors remplacé par un numéro court non surtaxé auquel vos destinataires peuvent répondre.
Réception des réponses
3 manières de recevoir les réponses :
- Sur l’interface : vous avez accès à vos réponses soit par campagne, soit par date.
- Par Email : transmettez nous une adresse email à laquelle nous vous enverrons les réponses au fur et à mesure qu’elles nous arrivent.
- Par Callback : transmettez nous une URL à laquelle nous vous transmettrons les réponses. > En savoir plus
URL
XML : https://www.octopush-dm.com/api/sms
JSON : https://www.octopush-dm.com/api/sms/json
Encodage
UTF-8
Paramètres particuliers
Nom | Définition |
user_login | Login utilisateur (adresse e-mail). |
api_key | Clé api disponible sur votre manager. |
sms_recipients | Liste des numéros au format international +XXZZZZZ, séparés par des virgules. |
sms_text | Texte du message (maximum 459 caractères). |
sms_type | Type de SMS : XXX = SMS LowCost ; FR = SMS Premium; WWW = SMS Monde. En France, si la mention « STOP au XXXXX » est absente de votre texte, l’API renverra une erreur. |
with_replies | Instancier à 1 pour indiquer que vous souhaitez les réponses aux SMS envoyés |
Exemple Curl
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«
Retour XML
< successs>
< success>
< /success>
< /successs>
< /failures>
Retour JSON
{« 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}}
Définition des Tags XML
Se référer à la page concernant les retours XML