Chemin d'accès, methode et authentification


POST /api/sms
Host: https://sms-scheduler.com
Content-Type: application/json; charset=utf-8
Authorization: usename:password | Basic (base64)
Toutes les requêtes effectuées via l'API SMS Scheduler :
  • Utilisent le chemin d'accès suivant : https://sms-scheduler.com/api/sms
  • Utilisent la méthode POST et le formattage en JSON.
  • Ont besoin d'être authentifiées grâce à l'email et le mot de passe utilisés pour se connecter à notre site Internet.

Créer un SMS (vers un ou plusieurs numéros de téléphone)

REQUETE


{
  "action": "create",
  "message": "My message",
  "delivery_date": 1573250000,
  "sender": "123",
  "phone_numbers": ["+330101010101", "+330202020202", "+490303030303", "0404-040-404"]
}
message (String - requis) : Le contenu de votre message.
delivery_date (Int - requis) : La date d'envoi du message utilisant le format "timestamp UNIX". Si la date est inférieure ou égale à la date actuelle, le SMS sera envoyé immédiatement.
sender (String - requis) : L'identifiant (ID) de l'expéditeur disponible sur la page "Expéditeurs" de SMS Scheduler lorsque vous êtes connecté.
phone_numbers (Array or String - requis) : Le numéro de téléphone vers lequel vous souhaitez envoyer le message. Il doit contenir le prefix du pays correspondant. Veillez également à retirer tous les points, espaces ou tirets présents dans le numéro. (ex : +33123456789). Il peut sagir d'une chaine de caractères (String) pour un numéro de téléphone unique ou d'un tableau (Array) lorsque vous souhaitez envoyer le même message à plusieurs numéros.

REPONSE


{
  "success": {
    "sms_id": 123456,
    "phone_numbers": ["+33601010101", "+33602020202", "+496303030303"]
  },
  "error": "Invalid phone_number",
  "invalid_phone_number": ["0404-040-404"]
}
success (Array) : Si présent, le SMS a bien été créé et est prêt pour être envoyé à tous les numéros de téléphone indiqués.
  • sms_id (Int) : Identifiant unique du message. Vous devriez stocker cet identifiant dans votre base de donnée afin de pouvoir supprimer ou modifier le message ou pour vérifier si le message a bien été réceptionné par le/les destinataire(s).
  • phone_numbers (Array) : Ensemble des numéros de téléphone vers lequels le message sera envoyé.
error (String) : Si présent, une erreur s'est produite lors de la création d'un ou plusieurs SMS.
invalid_phone_number (Array) : Si présent, retourne les numéros de téléphone qui n'ont pas été formattés correctement. Aucun SMS ne sera créé, ni envoyé, pour ces numéros.

Supprimer un SMS

REQUETE


{
"action": "delete",
"sms_id": 123456
}
sms_id (Int - required) : Identifiant unique receptionné lors de la création du message.

REPONSE


// example if success :
{
  "success": {
    "deleted": 3
  }
}
// example if failed :
{
  "error": "Wrong or invalid sms_id"
}
success (Array) : Si présent, le(s) SMS correspondant à l'identifiant unique inclu dans la requête a/ont bien été supprimé(s).
  • deleted (Int) : Nombre de SMS supprimés.
error (String) : Raison de l'erreur (la variable sms_id est incorrect).

Obtenir un rapport des envois

REQUETE


{
"action": "report",
"sms_id": 123456
}
sms_id (Int - required) : L'identifiant unique (ID) receptionné lors de la création du message.

REPONSE


// example if success :
{
  "success": {
    "sms_id": 123456,
    "report": [
      "Scheduled": [
        "+33601010101",
        "+496303030303"
      ],
      "Cancelled -- Blacklisted contact or phone number": [
        "+33602020202"
      ],
      "Missed -- Invalid phone number": [
        "+33602022356"
      ]
    ]
  }
}

// example if failed :
{
  "error": "Wrong or invalid sms_id"
}

success (Array) : Si présent, le rapport est disponible.
  • sms_id (Int) : Identifiant unique (ID) représentant le message.
  • report (Array) : Liste l'ensemble des SMS correspondant au message (avec l'identitifant ci-dessus).
    • phone_number (String) : Le numéro de téléphone correspondant.
    • status (String) : Le statut de l'envoi. Les valeurs possibles sont les suivantes :
      • Scheduled
      • Pending
      • Sent
      • Received
      • Cancelled -- Missing contact or phone number
      • Cancelled -- Invalid phone number
      • Cancelled -- Missing text message
      • Cancelled -- Invalid text message
      • Cancelled -- Missing sender
      • Cancelled -- Invalid sender
      • Cancelled -- Not enough credits
      • Cancelled -- Blacklisted contact or phone number
      • Cancelled -- End of validity period
      • Cancelled -- Unavailable country
      • Cancelled -- Error
      • Missed -- Invalid phone number
      • Missed -- Blacklisted phone number or blocked by phone carrier
      • Missed -- End of validity period
      • Missed -- Network not available on sending phone
      • Missed -- Sending failed (Unknown reason)
      • Missed -- Error
error (String) : Raison de l'erreur (la variable sms_id est incorrect).