Documents

Envoyez votre premier message dans un après-midi

Une API REST simple pour l'envoi, le suivi et la réception de SMS : authentification par jeton, webhooks et SDK en temps réel, sans rien d'exotique à apprendre.

Démarrage rapide

Trois mouvements, commencez à livrer

Chaque intégration est le même arc court : authentifier, envoyer, puis suivre.

01 · AuthentifierJeton : sk_live_9f2a7c10Type de contenu : application/json ✓

Envoyez votre clé d'accès sous forme d'en-tête de jeton, avec Content-Type : application/json, à chaque demande.

02 · EnvoyerPOST /externe/sms{ msgstr : "9f2a7c10", code d'erreur : 0 }

POSTEZ un from, to et un contenu. La réponse revient immédiatement avec un msgid et un code d'erreur.

03 · PisteGET /report?status=Livraison200 OK

Nous POSTONS ou OBTENONS un rapport d'état sur votre URL de rappel dès qu'un message atteint son état final.

Envoyer

Une demande, dans la langue que vous utilisez déjà

POSTEZ votre expéditeur, votre destinataire et votre contenu avec un en-tête Token. La réponse revient au moment où nous l’acceptons.

01curl -X POST https://secure.smslocal.com/api/service/enterprise-service/external/sms \02  -H "Token: $SMSLOCAL_TOKEN" \03  -H "Content-Type: application/json" \04  -d '{05    "from": "SMSLOCAL",06    "to": "14155550123",07    "content": "Your code is 481920."08  }'
201 · Accepté

msgstr "9f2a7c10-4b2e-…"

direction "mt"

code d'erreur 0

Enregistrez le msgstr - c'est ainsi que vous suivez ce message à partir d'ici.

L'objet message

Lire un message de haut en bas

Les événements d’envoi, de statut et entrants renvoient tous la même forme : apprenez-la une fois.

01Identifiant du message

Identifiant du message

msgid — émis au moment où un message est créé. C'est le handle que vous utilisez pour vérifier son statut ultérieurement.

02Expéditeur

Expéditeur

de - un numéro de téléphone ou un identifiant alphanumérique jusqu'à 11 caractères, quelle que soit l'identité vue par vos destinataires.

03Destinataire

Destinataire

à : le numéro auquel le message est destiné, y compris l'indicatif du pays.

04Codage

Codage

codage des données — GSM7 contient 160 caractères par partie ; passez à Unicode et cela tombe à 70. Allez-y, et il se concatène en parties supplémentaires facturées.

05Direction

Direction

direction — chaque message est mt (vous l'avez envoyé) ou mo (vous l'avez reçu), la même forme dans les deux cas.

06Code d'erreur

Code d'erreur

code d'erreur - renvoyé sur la réponse d'envoi et sur chaque rapport d'état. 0 signifie accepté ; tout le reste vous dit exactement ce qui n'a pas fonctionné.

Référence

Un point final, deux verbes

POST pour envoyer, GET pour vérifier l'état - la même URL et le même en-tête de jeton dans les deux cas.

POSTE

Envoyer

Envoyez un message et recevez immédiatement un msgid et un code d'erreur.

Retours msgstr + code d'erreur
OBTENIR

Piste

Recherchez un message que vous avez déjà envoyé pour vérifier son état actuel.

Retours message + statut
Webhooks

Rapports de situation, au moment où ils se produisent

Définissez une URL de rappel et chaque livraison, échec et réponse entrante y atterrit sous la forme d'un GET ou d'un POST — aucune interrogation n'est requise.

livrémsgstr 9f2a7c10 · statut Livraison
entrantréponse reçue · direction mo
échouémsgstr 4c81e2 · statut Échec
Votre point de terminaison200 OK
Commencer

Obtenez votre clé API

Commencez l'intégration en quelques minutes avec notre API REST.

Réponses à vos questions

Documents pour développeurs – questions fréquemment posées

Transmettez votre clé d'accès dans un en-tête Token à chaque requête — Token : {accessKey} — ainsi que Content-Type : application/json.

Chaque envoi renvoie un msgid. Dirigez-nous vers une URL de rappel et nous POST ou OBTENONS un rapport d'état au moment où le message atteint son état final - subdate, donedate et le code d'état résultant inclus.

mt (mobile terminé) est un message que vous avez envoyé ; mo (origine mobile) est une réponse que vous avez reçue. Les deux utilisent la même forme d’objet de message.

La livraison est réessayée conformément à la politique de nouvelle tentative : rien n'est abandonné en silence, mais un point de terminaison qui n'acquitte jamais continuera à recevoir des tentatives.

160 caractères en codage GSM7, ou 70 en Unicode. Dépassez la limite et le message est concaténé en plusieurs parties, chacune facturée séparément.