Logo Site EngageLab Mark Colored TransparentDokumentation
Suchen

Signaturkonfiguration aktualisieren

Aktualisieren Sie eine bestehende Signaturkonfiguration, mit Unterstützung für die Änderung des Signaturnamens. Nach der Aktualisierung wechselt der Signaturstatus zurück zu „In Prüfung".

Anfrage-URL

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

Aufruf-Authentifizierung

Bitte lesen Sie Aufruf-Authentifizierung, um zu erfahren, wie Sie API-Anfragen authentifizieren.

Anfragebeispiel

Anfrage-Header

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

            
Diesen Codeblock im schwebenden Fenster anzeigen

Anfragetext

{ "sign_name": "Company Name" }
              
              {
  "sign_name": "Company Name"
}

            
Diesen Codeblock im schwebenden Fenster anzeigen

Anfrageparameter

Pfadparameter

Parameter Typ Option Beschreibung
signId String Erforderlich Signatur-ID

Anfragetext-Parameter

Parameter Typ Option Beschreibung
sign_name String Erforderlich Signaturname, Länge 2–60 Zeichen, darf nicht enthalten: , , [, ]

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode ist 200, und der Antworttext enthält die folgenden Felder:

Feld Typ Beschreibung
code Integer Statuscode, 0 bedeutet Erfolg
message String Statusbeschreibung

Erfolgsbeispiel

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

            
Diesen Codeblock im schwebenden Fenster anzeigen

Fehlerantwort

Der HTTP-Statuscode ist 4xx/5xx, und der Antworttext enthält die folgenden Felder:

Feld Typ Beschreibung
code Integer Fehlercode
message String Fehlerdetails

Fehlerbeispiel

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

            
Diesen Codeblock im schwebenden Fenster anzeigen

Fehlercodes

Fehlercode HTTP-Code Beschreibung
400 400 Parameterfehler oder Fehler in der Geschäftslogik
500 500 Interner Serverfehler

Häufige Fehlermeldungen:

  • invalid signId: Formatfehler der Signatur-ID
  • sign config not exist: Signaturkonfiguration existiert nicht
  • sign_name already exist: Signaturname existiert bereits
  • can not update pending status sign: Signatur im Status „In Prüfung" kann nicht aktualisiert werden
  • there are pending or running plans using current sign, can not update: Es gibt ausstehende oder laufende Pläne, die diese Signatur verwenden, sie kann nicht aktualisiert werden

Hinweise

  1. Signaturen im Status „In Prüfung" können nicht aktualisiert werden.
  2. Wenn es ausstehende oder laufende Nachrichtenpläne gibt, die diese Signatur verwenden, kann sie nicht aktualisiert werden.
  3. Nach der Aktualisierung wechselt der Signaturstatus zurück zu „In Prüfung" (status=1).
  4. Signaturnamen dürfen keine verbotenen Zeichen enthalten: , , [, ]
  5. Die Signatur-ID ist eine Zahl vom Typ String.

Anhang

Status der Signaturkonfiguration (status)

Wert Beschreibung
1 In Prüfung
2 Genehmigt
3 Abgelehnt
Icon Solid Transparent White Qiyu
Vertrieb kontaktieren