Passer au contenu

API SMS

createSMSMessage Obsolète

Anchor link to

Utilisé pour envoyer des notifications SMS aux utilisateurs

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

Corps de la requête

Anchor link to
NomRequisTypeDescription
auth*OuistringJeton d’accès API depuis le Panneau de Configuration de Pushwoosh.
application*OuistringCode d’application Pushwoosh
notifications*OuiarrayParamètres de contenu. Tableau JSON des paramètres de message. Voir les détails ci-dessous.

Paramètres de notification

NomRequisTypeDescription
send_date*OuistringDate et heure d’envoi de la notification. Utilisez le format AAAA-MM-JJ HH:mm ou now pour un envoi immédiat.
content*OuistringContenu textuel du message SMS.
devices*OuiarrayNuméro de téléphone du client (doit être associé à un ID utilisateur 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_registrationNonbooleanSi défini sur true, le numéro de téléphone spécifié dans le paramètre devices sera automatiquement enregistré.
dynamic_content_placeholdersNonobjectEspaces 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.
presetNonstringCode de préréglage SMS de votre Panneau de Configuration.

Exemple de requête

Anchor link to
{
"request": {
"application": "12345-67891", // requis. Code d'application Pushwoosh.
"auth": "yxoPUlwqm…………pIyEX4H", // requis. Jeton d'accès API depuis le Panneau de Configuration de Pushwoosh.
"notifications": [{
"send_date": "now", // requis. AAAA-MM-JJ 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 ID utilisateur 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 de préréglage SMS de votre Panneau de Configuration.
"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

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

Réponse d’erreur

Anchor link to
{
"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 de chaque message dans la section Historique des messages.