API SMS

createSMSMessage

Utilisée 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 Contrôle 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 un envoi immédiat.
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 utiliser `use_auto_registration`). Un seul numéro peut être spécifié ici.
use_auto_registration	Non	boolean	Si défini à `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 pour le contenu dynamique afin de personnaliser le contenu du message. Chaque espace réservé sera remplacé par les valeurs dynamiques correspondantes.
preset	Non	string	Code du préréglage SMS depuis votre Panneau de Contrôle.

Exemple de requête

{
  "request": {
    "application": "12345-67891",    // requis. Code d'application Pushwoosh.
    "auth": "yxoPUlwqm…………pIyEX4H",  // requis. Jeton d'accès API depuis le Panneau de Contrôle Pushwoosh.
    "notifications": [{
      "send_date": "now",            // requis. YYYY-MM-DD HH:mm OU "now".
      "content": "Hello!",           // requis. Texte du SMS (chaîne de caractères).
      "devices": ["+1234567890"],    // requis. Numéro de téléphone du client (doit être associé à
                                     //           un UserId via /registerDevice et spécifié dans
                                     //           le paramètre "hwid" ou utiliser "use_auto_registration").
                                     //           Un seul numéro peut être spécifié ici.
      "preset": "XXXXX-XXXXX",       // optionnel. Code du préréglage SMS depuis votre Panneau de Contrôle.
      "use_auto_registration": true  // optionnel. Enregistre automatiquement le numéro de téléphone spécifié
                                     //           dans le paramètre "devices".
    }]
  }
}

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.