Envoyer des SMS

Cette requête est utilisée pour envoyer des SMS en temps réel ou en différé.

URL

POST https://api.smspartner.fr/v1/send

Paramètres

Chaque demande d’API prend en charge les paramètres suivants :

    • La plateforme n’envoie pas de SMS commerciaux entre 20h et 8h en semaine et les dimanches et jours fériés (restriction légale). Si un message SMS est envoyé, le message est en pause jusqu’au prochain jour ouvrable à 8h.
    • Vous n’envoyez pas de SMS commerciaux? contactez-nous pour désactiver cette restriction : help@smspartner.fr
apiKey Clé API de votre compte. Vous l’obtenez dans votre compte SMS Partner.
phoneNumbers Numéros de téléphone des destinataires.
Pour l’envoi de plusieurs SMS les numéros doivent être séparés par des virgules. La limite d’envoi sur une seule requête est de 500 numéros.
Ils peuvent être :

  • au format national (06xxxxxxxx) ou international (+336xxxxxxxx), pour des numéros français.
  • au format international (+496xxxxxxxx), pour des numéros hors France.
message Contenu du SMS. 160 caractères maximum par SMS (au delà, il vous sera décompté un SMS supplémentaire par tranche de 153 caractères).

Attention, certains caractères spéciaux et accentués seront remplacés lors de l’envoi :
Voir la liste

Le caractère ” doit obligatoirement être échappé (\”) pour que le texte du SMS soit valide. Dans le cas contraire une erreur 400 sera retournée.

Le tag :br: Permet de faire un saut de ligne. Attention le saut de ligne comptes pour deux caractères.

La mention STOP SMS est obligatoire pour les SMS à caractères commerciaux (voir le paramètre isStopSms ci-dessous)
Si c'est un compte marketing la mention STOP SMS est ajouté automatiquement.

Paramètres optionnels
gamme Gamme du SMS, sa valeur doit être:

  • 1 pour les SMS Premium
  • 2 pour les SMS Low Cost

  Si ce paramètre est omis , les SMS seront envoyés dans la gamme Premium

sender Nom d’émetteur du message. Si l’émetteur est laissé vide, vos SMS seront acheminés avec un shortcode opérateur en guise d’expéditeur (exemple : 36xxx).

  Le nombre de caractères pour le nom d’émetteur doit être compris entre 3 et 11 inclus et ne doit pas comporter de caractères spéciaux.
Certains modèles de téléphone portable n’interprètent pas les espaces.

tag Chaine de caractères de 20 caractères maximum sans espace(s) et en minuscule(s)
scheduledDeliveryDate Date d’envoi du SMS, au format dd/mm/YYYY. A définir uniquement si vous souhaitez que les SMS soient envoyés en différé.
time Heure d’envoi du SMS (format 0-24), obligatoire si scheduledDeliveryDate est défini.
minute Minute d’envoi du SMS (format 0-55, par intervalle de cinq minutes).
, obligatoire si scheduledDeliveryDate est défini.
urlResponse Url de retour des Réponses (ex: http://www.monurldereponse)
urlDlr Url de retour des Accusé de réceptions (ex: http://www.monurldedlr)
isStopSms Gamme premium: 1 pour ajouter la mention STOP à la fin du SMS ( obligatoire pour des SMS commerciaux ).

Gamme ÉCO:   Ce paramètre n’est pas applicable pour cette gamme, il est nécessaire d’ajouter manuellement la mention NoPub=STOP pour les SMS commerciaux.

isUnicode Si 1: Active le mode Unicode, le nombre de caractères maximum par SMS sera de 70.

Important : le SMS unicode doit être activé sur votre compte par un administrateur pour que les envois soient disponibles. Merci de prendre contact avec le service technique pour l’activation de cette fonctionnalité.

> Voir liste complète des émoticônes / emojis

sandbox Pour tester l’envoi de SMS, vous pouvez utiliser le paramètre sandbox:

  • 1 pour activer le mode bac à sable

  Aucun SMS ne sera envoyé, et il n’y aura aucun débit sur votre compte.
Ces SMS seront supprimés de vos listes d’envois automatiquement tous les jours.

_format Format de la réponse. Vous pouvez choisir entre JSON ou XML. Par défaut, le format de réponse est JSON.

Requête

Exemple de requête :

Réponses

Erreurs

Exemple de message d’erreur:

Code de contrôle

Code erreurs
1 La Clé API est requise
2 Le numéro de téléphone est requis
9 Au moins une contrainte n’a pas été respectée lors de l’envoi :

  • L’émetteur ne peut pas être plus long que 11 caractères.
  • Numéro de téléphone non valide.
  • Si scheduledDeliveryDate est défini:
    • La date (dd/mm/yyyy) est antérieure à la date actuelle.
    • La minute est requise.
    • L’heure est requise.
10 Clé API incorrecte
11 Manque de crédits

Liste des caractères remplacés

Caractères Remplacé par:

ą

à

ÿ

y

ç

Ç

û

u

ü

u

ï

i

ô

o

ö

o

ó

o

î

i

ë

e

ê

e

[

(

]

)

{

(

}

)

`

µ

u

Ä

A

À

A

Á

A

Caractères Remplacé par:

Â

A

Ã

A

È

E

Ê

E

Ë

E

Î

I

Ü

U

Ù

U

Ú

U

Û

U

Ý

Y

ä

a

á

a

â

a

ã

a

Ö

O

Ô

O

œ

oe

^

Supprimé

~

Supprimé

|

Supprimé

\

Supprimé

¨

Supprimé

°

.

ñ

n

Ñ

N

§

Supprimé

«

»