Envoyer
Envoyer
Envoyez un modèle de SMS à un ou plusieurs utilisateurs
URL
https://sms.api.engagelab.cc/v1/send
https://sms.api.engagelab.cc/v1/send
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête HTTP
POST
POST
Afficher ce bloc de code dans la fenêtre flottante
Content-Type
Content-Type: application/json;charset=utf-8
Content-Type: application/json;charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante
En-têtes de la requête
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | oui | Basic base64(sms_user:sms_key) |
Description des paramètres du corps de la requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| from | string | non | Le nom de l'expéditeur peut comporter de 3 à 11 caractères et ne peut contenir que des lettres anglaises et des chiffres, par défaut vide, affichage selon l'effet réel. |
| to | array | oui | Liste de numéros de téléphone mobile, maximum 1000 dans la liste. |
| body | object | oui | Paramètres du contenu du SMS |
| template_id | int | oui | ID du modèle |
| msg_type | int | non | Type de SMS, 2 représente un SMS international, valeur par défaut 2. |
| label_id | int | non | Étiquette du SMS |
| vars | object | non | Variable. Jusqu'à 1 Mo |
| custom_args | object | non | Champs optionnels personnalisés par le client. Taille maximale 1 Ko. |
| request_id | string | non | ID de cette demande d'envoi ; 128 caractères maximum. |
Astuces :
- vars est utilisé pour le remplacement de variables dans le contenu du message. Le format est un objet JSON, par exemple '{"varname": ["value1", "value2"]}', où varname est la variable du contenu du message.
- Exemple de contenu du message : Bienvenue sur le service de SMS %sp%. Valeur vars correspondante : {"sp": "engagelab"}. Remplacement du contenu du SMS : Bienvenue à utiliser le service de SMS EngageLab.
- Chaque valeur dans vars ne peut pas dépasser 16 caractères par défaut, formatée en chaîne de caractères, et les variables ne peuvent pas contenir de liens HTTP (veuillez contacter le service client pour des besoins spécifiques).
- Le système remplacera les variables dans le modèle de SMS par les paramètres dans vars, et tous les numéros recevront le même contenu remplacé.
- Les custom_args définis par vous-même seront intégrés dans l'en-tête ; les données SMSHook ultérieures vous seront renvoyées.
- Le request_id permet d'éviter les soumissions répétées, la période de validité est de 1 heure. En cas de soumission répétée dans l'heure, le dernier résultat de la demande sera renvoyé.
Exemple de requête
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123",
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
"week": "Tuesday"
}
}
}'
curl -X POST "https://sms.api.engagelab.cc/v1/send"
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"
--header "Content-Type: application/json"
--data '{
"from": "xxxx",
"to": ["+12673800456", "+12673800455"],
"request_id":"123",
"body":{
"template_id": 2336,
"label_id": 231,
"vars": {
"week": "Tuesday"
}
}
}'
Afficher ce bloc de code dans la fenêtre flottante
Description des valeurs de retour
| Paramètre | Description |
|---|---|
| success_count | Nombre d'envois réussis |
| sms_ids | Liste des IDs de SMS envoyés avec succès |
| failed_count | Nombre d'envois échoués |
| failed_items | Liste des téléphones en échec et les raisons associées |
| phone | Téléphone |
| message | Raison de l'échec |
| request_id | ID de cette demande d'envoi |
| custom_args | Champs optionnels personnalisés par le client |
Exemple de valeur de retour
Réponse-succès
HTTP Status: 200
// exemple de résultats de retour réussis
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123"
}
// exemple de résultats de retour réussis
{
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456", "1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123"
}
Afficher ce bloc de code dans la fenêtre flottante
// exemple de résultats de retour partiellement réussis
{
"code": 41031,
"message": "succès partiel",
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123",
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Format du numéro de téléphone invalide"
}
]
}
{
"code": 41031,
"message": "succès partiel",
"success_count": 1,
"sms_ids": ["1458113381893_15_3_11_1ainnq$+12673800456"],
"request_id":"123",
"failed_count": 1,
"failed_items": [
{
"phone":"1233",
"message":"Format du numéro de téléphone invalide"
}
]
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :401
{
"code": 30000,
"message": "Non autorisé."
}
{
"code": 30000,
"message": "Non autorisé."
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-erreur
HTTP Status :400
// exemple de résultats de retour échoués
{
"code": 32002,
"message": "Format du numéro de téléphone invalide"
}
// exemple de résultats de retour échoués
{
"code": 32002,
"message": "Format du numéro de téléphone invalide"
}
Afficher ce bloc de code dans la fenêtre flottante
