Obtenir les détails d'une configuration de signature

Récupère les informations détaillées d'une configuration de signature à partir de l'ID de signature, notamment le nom de la signature, le statut de validation, le nombre de modèles associés, etc.

Adresse d'appel

GET 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

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

              
              GET /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 est un objet de configuration de signature :

Champ	Type	Description
sign_id	String	ID de la signature
sign_name	String	Nom de la signature
status	Integer	Statut : 1-En attente de validation, 2-Validée, 3-Rejetée
related_template_count	Integer	Nombre de modèles associés
audit_remark	String	Remarque de validation
created_time	Integer	Date de création (horodatage Unix)
updated_time	Integer	Date de mise à jour (horodatage Unix)

Exemple de succès

{ "sign_id": "987654321", "sign_name": "Nom de l'entreprise", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "sign_id": "987654321",
  "sign_name": "Nom de l'entreprise",
  "status": 2,
  "related_template_count": 5,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

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": "invalid signId" }

              
              {
  "code": 400,
  "message": "invalid signId"
}

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

Annexe

Statut de la configuration de signature (status)

Valeur	Description
1	En attente de validation
2	Validée
3	Rejetée