SMS Documentation
Send One SMS
L'envoi d'un seul SMS est l'une des tâches les plus simples de la plateforme
Sparrow.
Envoyer un SMS est aussi simple que d'appeler "POST" à l'URL donnée, ceci est
un service payant. Pour les prix, vérifiez ici
POST : https://app.sparrowmessage.com/api/v1/sms/send/one
POST : https://app.sparrowmessage.com/api/v2/sms/send/one
Headers :
| # | Key | Value |
|---|---|---|
| 1 | Accept | application/json |
| 2 | Content-Type | application/json |
| 3 | Authorization | Bearer {api_token} |
api_token : récupérable à partir du service d'authentification vérifier ici
Params :
| # | Paramètre | Type | Description |
|---|---|---|---|
| 1 | phone | string | Le destinataire |
| 2 | text | string | Le contenu du SMS |
| 3 | notifyurl | string | URL de notification pour le changement de statut |
Response :
{
"code": "OK/KO",
"result": "object", // SI code "OK"
"message": "string", // SI code "OK"
"error": "string" // Si code "KO"
}Send Bulk SMS
Sparrow vous permet d'envoyer des SMS à plusieurs destinataires.
Envoyer un SMS est aussi simple que d'appeler "POST" à l'URL donnée, ceci est
un service payant. Pour les prix, vérifiez ici
POST : https://app.sparrowmessage.com/api/v1/sms/send/bulk
POST : https://app.sparrowmessage.com/api/v2/sms/send/bulk
Headers :
| # | Key | Value |
|---|---|---|
| 1 | Accept | application/json |
| 2 | Content-Type | application/json |
| 3 | Authorization | Bearer {api_token} |
api_token : récupérable à partir du service d'authentification vérifier ici
Params :
| # | Paramètre | Type | Description |
|---|---|---|---|
| 1 | phones[] | table | Liste des destinataires |
| 2 | text | string | Le contenu du SMS |
| 3 | notifyurl | string | URL de notification pour le changement de statut |
Response :
{
"code": "OK/KO",
"results": "collection", // SI code "OK"
"message": "string", // SI code "OK"
"error": "string" // Si code "KO"
}
Get SMS Status
Sparrow vous permet de récupérer le statut d'envoi de vos SMS via API.
Récupérer le statut de délivrabilité d'un SMS via un "POST" à l'URL donnée.
POST : https://app.sparrowmessage.com/api/v1/sms/status
POST : https://app.sparrowmessage.com/api/v2/sms/status
Headers :
| # | Key | Value |
|---|---|---|
| 1 | Accept | application/json |
| 2 | Content-Type | application/json |
| 3 | Authorization | Bearer {api_token} |
api_token : récupérable à partir du service d'authentification vérifier ici
Params :
| # | Paramètre | Type | Description |
|---|---|---|---|
| 1 | message_id | string | L'identifiant unique reçu lors de l'envoi du SMS |
Response :
{
"code": "OK/KO",
"result": "object", // SI code "OK"
"message": "string", // SI code "OK"
"error": "string" // Si code "KO"
}
Get SMS List Status
Sparrow vous permet de récupérer le statut d'envoi de vos SMS via API.
Récupérer le statut de délivrabilité d'une liste de SMS via un "POST" à l'URL donnée.
POST : https://app.sparrowmessage.com/api/v1/sms/status/bulk
POST : https://app.sparrowmessage.com/api/v2/sms/status/bulk
Headers :
| # | Key | Value |
|---|---|---|
| 1 | Accept | application/json |
| 2 | Content-Type | application/json |
| 3 | Authorization | Bearer {api_token} |
api_token : récupérable à partir du service d'authentification vérifier ici
Params :
| # | Paramètre | Type | Description |
|---|---|---|---|
| 1 | messages_id[] | table | Liste des identifiants uniques reçus lors de l'envoi du SMS |
Response :
{
"code": "OK/KO",
"results": "object", // SI code "OK"
"message": "string", // SI code "OK"
"error": "string" // Si code "KO"
}