Supprimer une configuration de signature

Supprime la configuration de signature spécifiée. Si la signature est utilisée par un plan de messages (à l'état en attente ou en cours d'exécution), elle ne peut pas être supprimée.

Adresse d'appel

DELETE https://smsapi.engagelab.com/v1/sign-configs/:signId

Authentification

Veuillez consulter Authentification pour savoir comment authentifier les appels à l'API.

Exemple de requête

En-tête de requête

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

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

Afficher ce bloc de code dans la fenêtre flottante

Corps de la requête

Aucun

Paramètres de requête

Paramètres de chemin

Paramètre	Type	Option	Description
signId	String	Obligatoire	ID de la signature

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
code	Integer	Code de statut, 0 indique un succès
message	String	Description du statut

Exemple de succès

{ "code": 0, "message": "success" }

              
              {
  "code": 0,
  "message": "success"
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse en cas d'erreur

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étails de l'erreur

Exemple d'erreur

{ "code": 400, "message": "there are pending or running plans using current sign, can not update" }

              
              {
  "code": 400,
  "message": "there are pending or running plans using current sign, can not update"
}

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 :

invalid signId : format de l'ID de signature incorrect
sign config not exist : la configuration de signature n'existe pas
there are pending or running plans using current sign, can not update : il existe des plans en attente ou en cours d'exécution utilisant cette signature, la suppression est impossible

Remarques

S'il existe des plans de messages en attente ou en cours d'exécution utilisant cette signature, elle ne peut pas être supprimée.
L'ID de la signature est un nombre de type chaîne de caractères.