Campagne
Cette méthode vous permet d'envoyer une campagne à un ou plusieurs destinataires.
POST
/send
Paramètres du body
text
requis
|
Votre message |
value
requis
|
Les numéros des destinataires |
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 |
gsmsmsid | Un id de votre choix pour lier le message à son accusé de réception |
unicode | Activate the unicode mode, allowing special chars and reducing the length of one SMS to 70 characters. Par défaut 0 |
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
POST /send HTTP/1.1
Host: api.smsfactor.com
Authorization: Bearer your.token
Accept: application/json
{
"sms": {
"message": {
"text": "Message via API",
"pushtype": "alert",
"sender": "Illidan",
"delay": "2024-12-21 10:02:50",
"unicode": 0
},
"recipients": {
"gsm": [
{
"gsmsmsid": "100",
"value": "33612345678"
},
{
"gsmsmsid": "101",
"value": "33612345677"
}
]
}
}
}
<?xml version="1.0" encoding="UTF-8"?>
<sms>
<message>
<text>Message via API</text>
<pushtype>alert</pushtype>
<sender>Illidan</sender>
<delay>2024-12-21 10:02:50</delay>
<unicode>0</unicode>
</message>
<recipients>
<gsm gsmsmsid="100">33612345678</gsm>
<gsm gsmsmsid="101">33612345677</gsm>
</recipients>
</sms>
\SMSFactor\SMSFactor::setApiToken('your token');
$response = \SMSFactor\Campaign::send([
'sms' => [
'message' => [
'text' => 'Message via API',
'pushtype' => 'alert',
'sender' => 'Illidan',
'delay' => '2024-12-21 10:02:50',
'unicode' => 0
'recipients' => [
'gsm' => [
[
'gsmsmsid' => "100",
'value' => '33612345678'
],
[
'gsmsmsid' => "101",
'value' => '33612345677'
]
]
]
]
], false); // True to simulate the campaign (no SMS sent)
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 ...).