v1

latestSwagger 2.02026-07-13143662.0 KB
sms

Envoyer un sms

Envoi un sms vers un unique destinataire

post/sms

Request body

keyidstring required

Clé API

gmt_zone'Pacific/Midway' | 'America/Adak' | 'Etc/GMT+10' | 'Pacific/Marquesas' | 'Pacific/Gambier' | 'America/Anchorage' | 'America/Ensenada' | 'Etc/GMT+8' | 'America/Los_Angeles' | 'America/Denver' | 'America/Chihuahua' | 'America/Dawson_Creek' | 'America/Belize' | 'America/Cancun' | 'Chile/EasterIsland' | 'America/Chicago' | 'America/New_York' | 'America/Havana' | 'America/Bogota' | 'America/Caracas' | 'America/Santiago' | 'America/La_Paz' | 'Atlantic/Stanley' | 'America/Campo_Grande' | 'America/Goose_Bay' | 'America/Glace_Bay' | 'America/St_Johns' | 'America/Araguaina' | 'America/Montevideo' | 'America/Miquelon' | 'America/Godthab' | 'America/Argentina/Buenos_Aires' | 'America/Sao_Paulo' | 'America/Noronha' | 'Atlantic/Cape_Verde' | 'Atlantic/Azores' | 'Europe/Belfast' | 'Europe/Dublin' | 'Europe/Lisbon' | 'Europe/London' | 'Africa/Abidjan' | 'Europe/Amsterdam' | 'Europe/Belgrade' | 'Europe/Brussels' | 'Africa/Algiers' | 'Africa/Windhoek' | 'Asia/Beirut' | 'Africa/Cairo' | 'Asia/Gaza' | 'Africa/Blantyre' | 'Asia/Jerusalem' | 'Europe/Minsk' | 'Asia/Damascus' | 'Europe/Moscow' | 'Africa/Addis_Ababa' | 'Asia/Tehran' | 'Asia/Dubai' | 'Asia/Yerevan' | 'Asia/Kabul' | 'Asia/Yekaterinburg' | 'Asia/Tashkent' | 'Asia/Kolkata' | 'Asia/Katmandu' | 'Asia/Dhaka' | 'Asia/Novosibirsk' | 'Asia/Rangoon' | 'Asia/Bangkok' | 'Asia/Krasnoyarsk' | 'Asia/Hong_Kong' | 'Asia/Irkutsk' | 'Australia/Perth' | 'Australia/Eucla' | 'Asia/Tokyo' | 'Asia/Seoul' | 'Asia/Yakutsk' | 'Australia/Adelaide' | 'Australia/Darwin' | 'Australia/Brisbane' | 'Australia/Hobart' | 'Asia/Vladivostok' | 'Australia/Lord_Howe' | 'Etc/GMT-11' | 'Asia/Magadan' | 'Pacific/Norfolk' | 'Asia/Anadyr' | 'Pacific/Auckland' | 'Etc/GMT-12' | 'Pacific/Chatham' | 'Pacific/Tongatapu' | 'Pacific/Kiritimati'

Fuseau horaire de la date d'envoi

date_envoistring

Date d'envoi au format YYYY-MM-DD hh:mm . Ce paramètre est optionnel, si il est omis l'envoi est réalisé immédiatement.

smsstring required

Message à envoyer aux destinataires. Le message doit être encodé au format utf-8 et ne contenir que des caractères existant dans l'alphabet GSM. Il est également possible d'envoyer (à l'étranger uniquement) des SMS en UCS-2, cf paramètre ucs2 pour plus de détails.

numstring required

Numero de téléphone au format national (exemple 0680010203) ou international (example 33680010203)

emetteurstring
  • L'emetteur doit être une chaîne alphanumérique comprise entre 4 et 11 caractères.

  • Les caractères acceptés sont les chiffres entre 0 et 9, les lettres entre A et Z et l’espace.

  • Il ne peut pas comporter uniquement des chiffres.

  • Pour la modification de l'émetteur et dans le cadre de campagnes commerciales, les opérateurs imposent contractuellement d'ajouter en fin de message le texte "STOP XXXXX". De ce fait, le message envoyé ne pourra excéder une longueur de 148 caractères au lieu des 160 caractères, le « STOP » étant rajouté automatiquement.

trackerstring

Le tracker doit être une chaine alphanumérique de moins de 50 caractères. Ce tracker sera ensuite renvoyé en paramètre des urls pour les retours des accusés de réception.

smslongstring

Le SMS long permet de dépasser la limite de 160 caractères en envoyant un message constitué de plusieurs SMS. Il est possible d’envoyer jusqu’à 6 SMS concaténés pour une longueur totale maximale de 918 caractères par message. Pour des raisons technique, la limite par SMS concaténé étant de 153 caractères. En cas de modification de l’émetteur, il faut considérer l’ajout automatique de 12 caractères du « STOP SMS ». Pour envoyer un smslong, il faut ajouter le paramètre smslong aux appels. La valeur de SMS doit être le nombre maximum de sms concaténé autorisé. Pour ne pas avoir ce message d’erreur et obtenir un calcul dynamique du nombre de SMS alors il faut renseigner smslong = "999"

nostopstring

Si le message n’est pas à but commercial, vous pouvez faire une demande pour retirer l’obligation du STOP. Une fois votre demande validée par nos services, vous pourrez supprimer la mention STOP SMS en ajoutant nostop = "1"

internationalstring
domtomstring

Les envois vers les préfixes opérateurs à destination des DOM TOM (ou DROM-COM) sans l'indicatif pays associé (ex: +262 pour La Réunion) seront acceptés par l'API mais ne pourront etre délivrés. Pour forcer leur traitement au tarif en vigueur, utiliser la valeur 1

sandboxstring

Activation du mode bac à sable Ce champ permet de ne pas envoyer réellement les SMS lors de la requête Les envois ne sont pas facturés Utiliser la valeur 1

numAzurstring

Dans le cadre d'une utilisation combinée entre SMS Azur et l'API, il est possible de forcer le numéro d'expéditeur à être le même que celui utilisé sur SMS Azur Utiliser la valeur 1

ucs2string

Il est également possible d’envoyer des SMS en alphabet non latin (russe, chinois, arabe, etc) sur les numéros hors France métropolitaine. Pour ce faire, la requête devrait être encodée au format UTF-8 et contenir l’argument ucs2 = "1" Du fait de contraintes techniques, 1 SMS unique ne pourra pas dépasser 70 caractères (au lieu des 160 usuels) et dans le cas de SMS long, chaque sms ne pourra dépasser 67 caractères.

Example request

{
  "keyid": "VOTRE_KEYID",
  "num": "0600123456",
  "sms": "Bonjour! Bienvenue sur iSendPro!",
  "emetteur": "iSendPro"
}

Response

Reponse OK