API de Messagerie SMS

Envoyez des messages texte à un ou plusieurs destinataires. Veuillez lire Référence Générale de l'API avant de consulter ce document.

Envoyez sans effort des codes de vérification, des messages transactionnels et promotionnels à un ou plusieurs destinataires dans n'importe quel pays du monde. L'interface offre une méthode d'entrée de paramètres concise, flexible et complète pour répondre à divers scénarios d'utilisation de SMS.

Si vous prévoyez d'envoyer des codes de vérification SMS aux utilisateurs via Unimatrix, nous vous recommandons d'utiliser notre API Envoyer OTP, ce qui améliorera votre efficacité de développement et l'expérience utilisateur.

Définitions

Action : sms.message.send
Méthode HTTP : POST
Content-Type : application/json

Paramètres de Requête

Nom	Type	Requis	Description	Exemple
to	string \| string[]	Oui	Numéro de téléphone du destinataire. Utilisez le format E.164.	+12068800123
signature	string	Non	Nom de l'expéditeur SMS. Doit contenir entre 2 et 16 caractères.	Unimatrix
text	string	Non	Texte complet du SMS. * `templateId`, `text` ou `content` sont nécessaires	701522 est votre code de vérification, valable 10 minutes.
content	string	Non	Contenu principal du SMS, sera combiné avec la signature pour former le texte complet du SMS. * `templateId`, `text` ou `content` sont nécessaires	701522 est votre code de vérification, valable 10 minutes.
templateId	string	Non	ID du modèle SMS ou code de modèle personnalisé. * `templateId`, `text` ou `content` sont nécessaires	pub_verif_en_ttl
templateData	JSON	Non	Variables du modèle, utilisées avec `templateId`.	`{"code": "701522", "ttl": "10"}`

Exemple de Requête

curl -X POST 'https://api.unimtx.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
  "to": "+12068800xxx",
  "text": "Votre code de vérification est 204806."
}'

Paramètres de Réponse

Nom	Type	Description	Exemple
code	string	Code de retour	0
message	string	Message de retour	Succès
data	JSON	Résultats

Résultats `data`

Nom	Type	Description	Exemple
recipients	integer	Nombre de destinataires	1
messageCount	integer	Nombre total de messages facturés	1
currency	string	Devise	USD
totalAmount	string	Montant total consommé	0.018900
messages	JSON[]	Détails des messages envoyés

Messages `data.messages`

Nom	Type	Description	Exemple
id	string	ID du message	c9159d19f394833327e43c8e7285a6b3
to	string	Numéro de téléphone du destinataire (E.164)	+12068800123
iso	string	Code de pays (iso2)	US
cc	string	Code de pays (Préfixe international)	1
parts	integer	Nombre de parties du message	1
price	string	Montant consommé	0.018900

Exemples de Réponse

Exemple de réponse réussie

Code d'état : 200, Corps de la réponse :

{
  "code": "0",
  "message": "Succès",
  "data": {
    "recipients": 1,
    "messageCount": 1,
    "totalAmount": "0.018900",
    "messages": [
      {
        "id": "c9159d19f394833327e43c8e7285a6b3",
        "to": "+12068800123",
        "iso": "US",
        "cc": "1",
        "parts": 1,
        "price": "0.018900"
      }
    ]
  }
}

Exemple de réponse en échec

Code d'état : 400, Corps de la réponse :

{
  "code": "105400",
  "message": "InsufficientFunds"
}