Signaturkonfiguration erstellen

Erstellen Sie eine neue Signaturkonfiguration (Sender ID), um die Absenderidentität in SMS-Nachrichten anzuzeigen. Nach der Erstellung hat die Signatur den Status „In Prüfung" und muss die Prüfung bestehen, bevor sie verwendet werden kann.

Anfrage-URL

POST https://smsapi.engagelab.com/v1/sign-configs

Aufruf-Authentifizierung

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

Anfragebeispiel

Anfrage-Header

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

              
              POST /v1/sign-configs  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

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
sign_id	String	Die erstellte Signatur-ID

Erfolgsbeispiel

{ "sign_id": "987654321" }

              
              {
  "sign_id": "987654321"
}

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": "sign_name already exist" }

              
              {
  "code": 400,
  "message": "sign_name already exist"
}

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:

sign_name already exist: Signaturname existiert bereits

Hinweise

Nach der Erstellung hat die Signatur den Status „In Prüfung" (status=1) und muss die Prüfung bestehen, bevor sie verwendet werden kann.
Signaturnamen dürfen innerhalb desselben Unternehmens nicht doppelt vorkommen.
Signaturnamen dürfen keine verbotenen Zeichen enthalten: 【, 】, [, ]
Die Signatur-ID ist eine Zahl vom Typ String.

Anhang

Status der Signaturkonfiguration (status)

Wert	Beschreibung
1	In Prüfung
2	Genehmigt
3	Abgelehnt