Campagne avec liste
Cette méthode vous permet d'envoyer une campagne à une liste de destinataires.
POST
/send/lists
Paramètres du body
text
requis
|
Votre message |
value
requis
|
L'id de la liste |
pushtype | Le type d'envoi (alert ou marketing ) |
delay | La date d'envoi Y-m-d H:i:s . Doit être dans la timezone Europe/Paris |
sender | Vous permet de personnaliser l'expéditeur |
unicode (default 0) | Activate the unicode mode, reducing the SMS length to 70 characters |
A propos du type d'envoi et de l'expéditeur
Si vous n'avez pas encore lu les informations de base à propos du SMS, vous pourriez être tenté d'y remédier.
Exemples
Si vous souhaitez ajouter des informations personnalisées dans le texte de votre SMS, vous pouvez ajouter les balises suivantes :
[info1]
,[info2]
,[info3]
,[info4]
POST /send/lists HTTP/1.1
Host: api.smsup.ch
Authorization: Bearer your.token
Accept: application/json
{
"sms": {
"message": {
"text": "Message via API with custom contact information [info1]",
"pushtype": "alert",
"sender": "Ganondorf",
"delay": "2024-12-31 10:46:51",
"unicode": 0
},
"lists": [
{
"value": "5a0331bffc5886074551ce97"
},
{
"value": "5a0331bffc5886074551ce98"
}
]
}
}
POST /send/lists HTTP/1.1
Host: api.smsup.ch
Authorization: Bearer your.token
Accept: application/xml
<?xml version="1.0" encoding="UTF-8"?>
<sms>
<message>
<text>Message via API</text>
<pushtype>alert</pushtype>
<sender>Ganondorf</sender>
<delay>2024-12-31 10:46:51</delay>
<unicode>0</unicode>
</message>
<lists>
<value>45190</value>
</lists>
<lists>
<value>47854</value>
</lists>
</sms>
Format de la réponse
Un statut -8 ne signifie pas que votre SMS ne partira pas. Inutile de retenter un envoi sauf si vous voulez envoyer le même SMS plusieurs fois 😉
{
"status": 1,
"message": "OK",
"ticket": "14672468", //The id of your campaign
"cost": 2, //The cost of your campaign
"credits": 642, //Your credits after your campaign has been created
"total": 2, //Number of message before filtering
"sent": 2, //Number of message after filtering
"blacklisted": 0, //Number of blacklisted numbers
"duplicated": 0, //Number of duplicated numbers
"npai": 0 //Number of npai numbers
"invalid": 0, //Number of invalid numbers
"not_allowed": 0, //Number of SMS sent to a not allowed country
"flood": 0, //Number of SMS filtered by anti-flood
"country_limit": 0, //Monthly limit for this country reached
}
<response>
<status>1</status>
<message>OK</message>
<ticket>14672468</ticket>
<cost>2</cost>
<credits>642</credits>
<total>2</total>
<sent>2</sent>
<blacklisted>0</blacklisted>
<duplicated>0</duplicated>
<npai>0</npai>
<invalid>0</invalid>
<not_allowed>0</not_allowed>
<flood>0</flood>
<country_limit>0</country_limit>
</response>
Quelle est la différence entre cost, total et sent ?
Le champs cost
est le nombre de crédits qu'a couté votre campagne. Pour rappel, un SMS de plus de 160 caractères coûte au moins 2 crédits. En savoir plus
Le champs total
est le nombre de numéro de téléphone que vous avez fourni pour créer votre campagne.
Le champs sent
est le nombre de numéro de téléphone sur lesquels nous avons réellement envoyé un SMS (après retrait des numéros invalides, blacklist ...).