WhatsApp v0.1 zu v1 Migrationsanleitung

Derzeit gibt es zwei Versionen der Messages API: v0.1 und v1. Während v1 alle Funktionen von v0.1 unterstützt, gibt es einige wesentliche Unterschiede zwischen den beiden Versionen, die Sie beachten sollten, wenn Sie bereits v0.1 der API verwenden und eine Migration zu v1 planen.

JSON-Struktur

Einer der wichtigsten Unterschiede zwischen den beiden Versionen ist die Struktur, die für die JSON-Daten in Anfragen an die API und für eingehende Webhook-Daten verwendet wird; v1 bietet eine vereinfachte, flachere Struktur. Damit Ihre Anwendung mit v1 funktioniert, müssen Sie jeden Code ändern, der JSON-Daten generiert oder darauf verweist.

Einige der Unterschiede zwischen den beiden Strukturen sind:

• to und from sind Einzelwertknoten anstelle eines Objekts
• Die Nachrichtenübermittlung channel muss nur einmal angegeben werden, anstatt als type in to und from
• Die message Objekt wurde ersetzt durch ein message_typeund einen einzelnen Werteknoten mit dem durch die Bezeichnung implizierten Inhaltstyp, z. B. "text": "this is a text"

Beispiele

Ausgehender WhatsApp-Text V0.1

{
  "to": {
    "type": "whatsapp",
    "number": "447700900000"
  },
  "from": {
    "type": "whatsapp",
    "number": "447700900001"
  },
  "message": {
    "content": {
      "type": "text",
      "text": "Hello From Vonage!"
    }
  }
}

Ausgehender WhatsApp-Text V1

{
  "message_type": "text",
  "text": "Hello From Vonage!",
  "to": "447700900000",
  "from": "447700900001",
  "channel": "whatsapp"
}

Eingehender WhatsApp-Text-Webhook v0.1

{
  "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "timestamp": "2020-01-01T14:00:00.000Z",
  "to": {
    "type": "whatsapp",
    "number": "447700900000"
  },
  "from": {
    "type": "whatsapp",
    "number": "447700900001"
  },
  "message": {
    "content": {
      "type": "text",
      "text": "Hello From Vonage!"
    }
  }
}

Eingehender WhatsApp-Text Webhook v1

{
  "channel": "whatsapp",
  "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
  "to": "447700900000",
  "from": "447700900001",
  "timestamp": "2020-01-01 14:00:00 UTC",
  "message_type": "text",
  "text": "Nexmo Verification code: 12345. Valid for 10 minutes.",
  "profile": {
    "name": "Jane Smith"
  },
  "context": {
    "message_uuid": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
    "message_from": "447700900000"
  }
}

Dies sind nur einige Beispiele. Prüfen Sie die Spezifikation für einen umfassenden Satz von Feldern für die verschiedenen Nachrichtentypen und Webhooks.

Verwendung von Vonage Applications für Webhooks

Wenn Sie Webhakenfür v1 müssen diese innerhalb einer Vonage Anwendung. Außerdem muss die Applikation so eingestellt sein, dass sie v1 als Version verwendet.

Ein grundlegender Arbeitsablauf für die Einrichtung dieser Funktion über die Dashboard würde wie folgt aussehen:

1. Erstellen Sie eine neue Anwendung unter Ihre Applications (geben Sie ihr einen passenden Namen, etc.)
2. Aktivieren Sie unter Funktionen die Option Nachrichten
3. Die Aktivierung von Nachrichten sollte Felder für eingehende und Status-Webhooks freilegen. Setzen Sie den eingehenden Webhook auf die URL, unter der Sie die Rückrufe für die interaktiven WhatsApp-Nachrichten empfangen möchten.
4. Setzen Sie die Messages API-Version über das Dropdown-Menü auf v1
5. Klicken Sie auf Neue Anwendung generieren

Verwendung von JWTs zur Authentifizierung bei Verwendung einer Vonage-Applikation

Wenn Sie eine Vonage Application einrichten, sollten Sie unbedingt beachten, dass Vonage Applications die Verwendung von JWT (JSON Web Tokens) zur Authentifizierung von Anfragen an die API vorschreiben. Mit anderen Worten: Die HTTP-Basisauthentifizierung ist in dieser Situation keine Option. Lesen Sie mehr über JWTs.

Verknüpfung von Numbers und Social Channels mit einer Vonage Applications

Wenn Sie bestimmte Numbers und Social Channels für eine Vonage Application verfügbar machen möchten, müssen Sie diese Numbers und Social Channels mit der Application verknüpfen. Dies kann über die Dashboard. Von der Seite ApplicationsWählen Sie die Anwendung aus, die Sie verknüpfen möchten. Auf der Registerkarte "Nummern verknüpfen" können Sie Numbers mit der Anwendung verknüpfen, auf der Registerkarte "Soziale Kanäle verknüpfen" soziale Kanäle.

Zusätzliche Merkmale

Ein Grund, warum Sie auf v1 migrieren sollten, wenn Sie derzeit v1 verwenden, ist, dass Sie einige der Vorteile der zusätzliche Eigenschaften die v1 bietet, zum Beispiel Interaktive WhatsApp-Nachrichten.