API

Contact

Destination

Expéditeur

Modèle SMS

SMS

Réponse SMS

Utilisateur

Envoyer un SMS

Ce service est utilisé pour envoyer un SMS unitaire à un ou plusieurs destinataire(s) en envoi immédiat ou différé.

POST https://api.avosms.com/v1/sms/send

Paramètres

Tous les paramètres ci-dessous sont à envoyer en POST. Certains paramètres sont optionnels et comportent une valeur par défaut si non renseigné.

Liste des paramètres obligatoire

id	Votre identifiant de compte AvoSMS (adresse e-mail)
key	Clé API disponible depuis votre compte client « Accès API »
recipients	Numéro(s) du/des destinataire(s) concerné(s) par l'envoi
message	Contenu du SMS (1 SMS = 160 caractères, jusqu'à 600 caractères max)

Liste des paramètres optionnels

sender	Nom d'expéditeur (doit être compris entre 3 et 11 caractères) Par défaut : n° court 3XXXX
deliveryDate	Date d'envoi souhaitée (uniquement pour envoi en différé) [format : JJ/MM/AAAA]
deliveryHour	Heure d'envoi du SMS (uniquement pour envoi en différé) [format : JJ/MM/AAAA]
type	N ou M N = Notification \| M = Marketing
clickFollow	Permet de suivre le nombre de clics sur vos liens 0 = Ne pas suivre \| 1 = Suivre (si non renseigné, valeur mise à 0)

Exemple

<?php
$curl = curl_init("https://api.avosms.com/v1/sms/send"); curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); curl_setopt($curl, CURLOPT_COOKIESESSION, true);
$postfields = array( 'id' => "{ID}", //REQUIRED 'key' => "{KEY}", //REQUIRED 'sender' => "{SENDER}", //OPTIONNAL 'recipients' => array("{RECIPIENT 1}", "{RECIPIENT 2}"), //REQUIRED 'message' => "{MESSAGE}", //REQUIRED 'deliveryDate' => '{DELIVERY DATE}', //OPTIONNAL 'deliveryHour' => '{DELIVERY HOUR}', //OPTIONNAL 'type' => 'N', //OPTIONNAL 'clickFollow' => 0, //OPTIONNAL );
$postfields_json = json_encode($postfields); $trame = http_build_query($postfields, '', '&'); curl_setopt($curl, CURLOPT_POST, true); curl_setopt($curl, CURLOPT_POSTFIELDS, $trame); $raw_response = curl_exec($curl); curl_close($curl);
$response = json_decode($raw_response);
?>

Codes / Réponses

Lors d'une requête vers nos services, une réponse vous est retournée au format JSON. Vous trouverez dans le champ « code » le code de retour suite à votre demande. En cas de succès, le code retour contient « OK »

En cas de succès :

code (OK)	Votre demande a correctement été traitée. La campagne SMS a bien été envoyée / planifiée.
solde	Votre solde restant suite à l'envoi de SMS.
send_id	Identifiant de l'envoi SMS.
total_sms_sent	Nombre de SMS envoyé au total.
total_character_sms	Nombre de caractères présent dans le contenu du message SMS.
recipients_error	Tableau contenant le/les numéro(s) du/des destinataires ne pouvant être concerné pour l'envoi. (si aucune erreur, le tableau sera vide)

En cas d'erreur provenant du formatage / de votre saisie :

ERR_100	Identifiants API non reconnus.
ERR_101	Destinataire manquant « recipients » (aucun destinataire saisi)
ERR_102	Contenu du SMS vide (aucun contenu à envoyer)
ERR_103	Erreur sur nom d'expéditeur « sender » (doit être compris entre 3 et 11 caractères)
ERR_104	Le contenu du SMS est trop long (dépasse les 600 caractères)
ERR_105	Le format de date est invalide. Vérifier le format des params « deliveryDate » et « deliveryHour ».
ERR_106	Le type du SMS est invalide.
ERR_107	La valeur « clickFollow » est invalide.
ERR_108	Le nom d'expéditeur « sender » n'est pas autorisé.
ERR_109	Votre solde est insuffisant.

En cas d'erreur de traitement par nos services :

ERR_9XX

Erreur de traitement, contactez nos services.

Une erreur de traitement interne vous est informée par un code d'erreur « ERR_9XX » soit XX = chiffres non fixes, en fonction du type d'erreur.