Mettre à jour la configuration de signature

Mettez à jour une configuration de signature existante, avec prise en charge de la modification du nom de la signature. Après la mise à jour, le statut de la signature repasse à « En attente de validation ».

Adresse d'appel

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

Authentification

Veuillez consulter Authentification pour savoir comment authentifier les requêtes API.

Exemple de requête

En-tête de la requête

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

            

Corps de la requête

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

            

Paramètres de requête

Paramètres de chemin

Paramètres du corps de la requête

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 :

Exemple de succès

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

            

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 :

Exemple d'erreur

              
              {
  "code": 400,
  "message": "can not update pending status sign"
}

            

Codes d'erreur

Messages d'erreur courants :

• invalid signId : format de l'ID de la signature incorrect
• sign config not exist : la configuration de signature n'existe pas
• sign_name already exist : le nom de la signature existe déjà
• can not update pending status sign : une signature en attente de validation ne peut pas être mise à jour
• there are pending or running plans using current sign, can not update : il existe des plans en attente d'envoi ou en cours d'exécution utilisant cette signature, mise à jour impossible

Points d'attention

1. Une signature en attente de validation ne peut pas être mise à jour.
2. S'il existe des plans de messages en attente d'envoi ou en cours d'exécution utilisant cette signature, elle ne peut pas être mise à jour.
3. Après la mise à jour, le statut de la signature repasse à « En attente de validation » (status=1).
4. Le nom de la signature ne peut pas contenir les caractères interdits : 【, 】, [, ]
5. L'ID de la signature est un nombre de type chaîne de caractères.

Annexe

Statut de la configuration de signature (status)