API SMS

createSMSMessage

Utilisé pour envoyer des notifications SMS aux utilisateurs

POST https://api.pushwoosh.com/json/1.3/createSMSMessage

Corps de la requête

Nom	Requis	Type	Description
auth*	Oui	string	Jeton d’accès API depuis le Panneau de configuration Pushwoosh.
application*	Oui	string	Code d’application Pushwoosh
notifications*	Oui	array	Paramètres de contenu. Tableau JSON des paramètres de message. Voir les détails ci-dessous.

Paramètres de notification

Nom	Requis	Type	Description
send_date*	Oui	string	Date et heure d’envoi de la notification. Utilisez le format `YYYY-MM-DD HH:mm` ou `now` pour envoyer immédiatement.
content*	Oui	string	Contenu textuel du message SMS.
devices*	Oui	array	Numéro de téléphone du client (doit être associé à un UserId via `/registerDevice` et spécifié dans le paramètre `hwid` ou utilisez `use_auto_registration`). Un seul numéro peut être spécifié ici.
use_auto_registration	Non	boolean	Si défini sur `true`, le numéro de téléphone spécifié dans le paramètre `devices` sera automatiquement enregistré.
dynamic_content_placeholders	Non	object	Espaces réservés de contenu dynamique pour personnaliser le contenu du message. Chaque espace réservé sera remplacé par les valeurs dynamiques correspondantes.
preset	Non	string	Code de préréglage SMS depuis votre Panneau de configuration.

Exemple de requête

{
  "request": {
    "application": "12345-67891",    // required. Pushwoosh application code.
    "auth": "yxoPUlwqm…………pIyEX4H",  // required. API access token from Pushwoosh Control Panel.
    "notifications": [{
      "send_date": "now",            // required. YYYY-MM-DD HH:mm OR "now".
      "content": "Hello!",           // required. SMS text (string).
      "devices": ["+1234567890"],    // required. Customer phone number (must be associated with
                                     //           a UserId using. /registerDevice and specified in
                                     //           the "hwid" parameter or use "use_auto_registration").
                                     //           Only one number can be specified here.
      "preset": "XXXXX-XXXXX",       // optional. SMS Preset Code from your Control Panel.
      "use_auto_registration": true  // optional. Automatically register phone number specified
                                     //           in "devices" parameter.
    }]
  }
}

Exemple de réponse

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "Messages": [
      "9648-0B10ECB6-0D9F214D"
    ]
  }
}

Réponse d’erreur

{
  "status_code": 210,
  "status_message": "Invalid devices list. \"devices\" must be an array.",
  "response": {
    "Messages": []
  }
}

Pour obtenir les statistiques SMS, utilisez la méthode totalsByIntervals.

Vous pouvez également consulter les statistiques pour chaque message dans la section Historique des messages.