WhatsApp Business Platform On-Premises API

Wir stellen die On-Premises API ein. Weitere Informationen und wie du auf unsere Cloud API der nächsten Generation migrieren kannst, findest du in unserem Dokument zur Einstellung der On-Premises API.

Nutzer*innen

/v1/users

Verwende den users-Node für die Verwaltung der Authentifizierung und für den Zugriff auf den WhatsApp Business On-Premises API-Client.

Bevor du beginnst

Der WhatsApp Business On-Premises API-Client verwendet ein Standardkonto mit dem Benutzernamen admin und dem Passwort secret. Dieses Konto kann nicht entfernt oder aus dem System gelöscht werden. Aus Sicherheitsgründen musst du das Administratorpasswort sofort ändern.

Falls du dein Passwort vergessen hast, wende dich an Direct Support, um Hilfe beim Zurücksetzen zu erhalten.

Einschränkungen

  • Nur das admin-Konto kann Benutzer*innen erstellen oder löschen.

Empfehlungen

  • Verwende das admin-Konto nur zum Erstellen oder Löschen von Benutzer*innen.
  • Erstelle Nutzerkonten, um deine On-Premises API-Clients von WhatsApp Business zu verwalten.

Erstellen

Um ein Konto für eine*n Nutzer*in in deinem Unternehmen zu erstellen, der*die auf die WhatsApp Business API zugreifen kann, sende den Benutzernamen und das Passwort über den /users-Endpunkt an den WhatsApp Business API-Client. Der Endpunkt validiert den Benutzernamen und das Passwort und erstellt ein neues Konto, falls noch kein Konto mit diesem Benutzernamen existiert. Das Passwort wird mit einem Einweg-Hash verarbeitet und in einem Datenvolume gespeichert. Die Parameter username und password müssen angegeben werden.

Beispiel

Sende eine Anfrage wie die folgende, um eine*n Nutzer*in zu erstellen:

POST /v1/users
Authorization: Bearer your-auth-token

{
  "username": "username",
  "password": "password"
}

Wenn die Anfrage erfolgreich war und der*die Nutzer*in erstellt wurde, erhältst du eine Antwort mit dem HTTP-Statuscode 201 Created und der folgenden Payload:

{
  "users": [{
     "username": "username"
  }]
}

Wenn die Anfrage nicht erfolgreich war, erhältst du eine Antwort mit einem HTTP-Statuscode und einem WhatsApp-Fehlercode. Wenn du einen bereits vorhandenen Benutzernamen angegeben hast, erhältst du die folgende Fehlerantwort:

{
  "errors": [{
    "code": 1014,
    "title": "Internal error",
    "details": "Unable to create user. Already exist?"
  }]
}

Parameter

NameBeschreibung

username

Erforderlich.

Muss mindestens 4 und höchstens 32 Zeichen enthalten.
Verwende eine Vorlage für username, zum Beispiel den ersten Buchstaben des Vornamens und den Nachnamen, um nicht versehentlich mehrere Konten für eine Person zu erstellen.

password

Erforderlich.

Muss mindestens 8 und höchstens 64 Zeichen enthalten. Es ist jeweils mindestens ein Großbuchstabe, ein Kleinbuchstabe, eine Ziffer und ein Sonderzeichen erforderlich:


!\/'"#$%&()*+-.,:;_<>=?@[]{}^`|~

Authorization

Erforderlich.

Authentifizierungsschlüssel für den*die Administrator*in, der*die die Anfrage ausführt. Weitere Informationen findest du in der Dokumentation Anmeldung und Authentifizierung – Schlüssel.

Edges

Die folgenden Edges sind mit diesem Node verbunden:

EdgeBeschreibung

/users/login

Verwende diese Edge, um dich beim On-Premises API-Client von WhatsApp Business anzumelden.

/users/logout

Verwende diese Edge, um dich vom On-Premises API-Client von WhatsApp Business abzumelden.

/users/{username}

Verwende diese Edge, um ein Nutzerkonto abzurufen, zu aktualisieren oder zu löschen.

Häufige Fehler

HTTP-StatuscodeGrund

400

  • Passwort ist zu kurz (weniger als 8 Zeichen) oder zu lang (mehr als 64 Zeichen).
  • Benutzername ist zu kurz (weniger als 4 Zeichen) oder zu lang (mehr als 32 Zeichen).

Korrigiere die Länge von Benutzername und/oder Passwort und sende die Anfrage erneut.

403

Du verwendest nicht das admin-Konto, um das Nutzerkonto zu erstellen.

500

Konto konnte nicht erstellt werden, möglicherweise existiert der Name bereits.

Falls in der Antwort andere Fehler enthalten sind, findest du hier weitere Informationen: Fehlercodes und HTTP-Statuscodes.