Details der Signaturkonfiguration abrufen

Rufen Sie über die Signatur-ID detaillierte Informationen zu einer Signaturkonfiguration ab, einschließlich Signaturname, Prüfungsstatus, Anzahl der zugehörigen Vorlagen usw.

Anfrage-URL

GET 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

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

Diesen Codeblock im schwebenden Fenster anzeigen

Anfragetext

Keiner

Anfrageparameter

Pfadparameter

Parameter	Typ	Option	Beschreibung
signId	String	Erforderlich	Signatur-ID

Antwortparameter

Erfolgsantwort

Der HTTP-Statuscode ist 200, und der Antworttext ist ein Signaturkonfigurationsobjekt:

Feld	Typ	Beschreibung
sign_id	String	Signatur-ID
sign_name	String	Signaturname
status	Integer	Status: 1-In Prüfung, 2-Genehmigt, 3-Abgelehnt
related_template_count	Integer	Anzahl der zugehörigen Vorlagen
audit_remark	String	Prüfungsanmerkungen
created_time	Integer	Erstellungszeit (Unix-Zeitstempel)
updated_time	Integer	Aktualisierungszeit (Unix-Zeitstempel)

Erfolgsbeispiel

{ "sign_id": "987654321", "sign_name": "Company Name", "status": 2, "related_template_count": 5, "audit_remark": "", "created_time": 1699000000, "updated_time": 1699000000 }

              
              {
  "sign_id": "987654321",
  "sign_name": "Company Name",
  "status": 2,
  "related_template_count": 5,
  "audit_remark": "",
  "created_time": 1699000000,
  "updated_time": 1699000000
}

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

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

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

Anhang

Status der Signaturkonfiguration (status)

Wert	Beschreibung
1	In Prüfung
2	Genehmigt
3	Abgelehnt