Logo Site EngageLab Mark Colored TransparentDocumentation
Rechercher

Créer une configuration de signature

Créez une nouvelle configuration de signature (Sender ID) pour afficher l'identité de l'expéditeur dans les SMS. Après sa création, la signature est à l'état « En attente de validation » et doit être validée avant de pouvoir être utilisée.

URL d'appel

POST https://smsapi.engagelab.com/v1/sign-configs

Authentification des appels

Veuillez consulter Authentification des appels pour savoir comment authentifier vos requêtes API.

Exemple de requête

En-tête de requête

POST /v1/sign-configs HTTP/1.1 Content-Type: application/json Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0
              
              POST /v1/sign-configs  HTTP/1.1
Content-Type: application/json
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

            
Afficher ce bloc de code dans la fenêtre flottante

Corps de requête

{ "sign_name": "Nom de l'entreprise" }
              
              {
  "sign_name": "Nom de l'entreprise"
}

            
Afficher ce bloc de code dans la fenêtre flottante

Paramètres de requête

Paramètre Type Option Description
sign_name String Obligatoire Nom de la signature, longueur de 2 à 60 caractères, ne peut pas contenir : , , [, ]

Paramètres de réponse

Réponse en cas de succès

Le code de statut HTTP est 200 et le corps de la réponse contient les champs suivants :

Champ Type Description
sign_id String ID de la signature créée

Exemple de succès

{ "sign_id": "987654321" }
              
              {
  "sign_id": "987654321"
}

            
Afficher ce bloc de code dans la fenêtre flottante

Réponse en cas d'échec

Le code de statut HTTP est 4xx/5xx et le corps de la réponse contient les champs suivants :

Champ Type Description
code Integer Code d'erreur
message String Détail de l'erreur

Exemple d'erreur

{ "code": 400, "message": "sign_name already exist" }
              
              {
  "code": 400,
  "message": "sign_name already exist"
}

            
Afficher ce bloc de code dans la fenêtre flottante

Codes d'erreur

Code d'erreur http code Description
400 400 Erreur de paramètre ou erreur de logique métier
500 500 Erreur interne du serveur

Messages d'erreur courants :

  • sign_name already exist : le nom de la signature existe déjà

Points d'attention

  1. Après sa création, la signature est à l'état « En attente de validation » (status=1) et doit être validée avant de pouvoir être utilisée
  2. Les noms de signature ne peuvent pas être en double au sein d'une même activité
  3. Le nom de la signature ne peut pas contenir les caractères interdits : , , [, ]
  4. L'ID de la signature est un nombre de type chaîne de caractères

Annexe

Statut de la configuration de signature (status)

Valeur Description
1 En attente de validation
2 Validée
3 Rejetée
Icon Solid Transparent White Qiyu
Contactez-nous