Schnellstart für benutzerdefinierte Kanäle

Diese Integration ermöglicht Ihrem Team, über eine benutzerdefinierte Implementierung über jeden beliebigen Messaging-Kanal mit Ihren Kunden zu chatten.

Einen benutzerdefinierten Kanal verbinden

Schritt 1: Gehe zu Einstellungen > Kanäle

Schritt 2: Klicken Sie auf Kanal hinzufügen > Benutzerdefinierter Kanal > Verbinden

Schritt 3: Geben Sie die Ziel-Webhook-URL ein, an die ausgehende Nachrichten gesendet werden.

Schritt 4: Wählen Sie den ID-Typ für den Kanal > klicken Sie auf Weiter

ID-Typen werden zur Benutzeridentifizierung und zur Kommunikation mit Ihrem benutzerdefinierten Integrationsserver verwendet.

Es stehen zwei Arten von IDs zur Verfügung:

1. Telefonnummer: Verwenden Sie dies, wenn der Nachrichtendienstanbieter Kontakte anhand ihrer Telefonnummer erkennt.

   1. Beispielformat: +60177872890

2. Benutzerdefinierte ID: Verwenden Sie dies, wenn der Messaging-Dienstanbieter Kontakte anhand einer benutzerdefinierten ID erkennt.

   1. Die maximale Zeichenlänge beträgt 50.

   2. AZ,az,0-9,_,=,+,/und@sind erlaubt.

Schritt 5: Der folgende Dialog liefert dieKanal-ID,API-TokenundWebhook-URLzB

1. Kanal-ID:gfd8g7fd89dgfd

2. API-Token:aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd

3. Webhook-URL:https://app.respond.io/custom/channel/webhook/

   Mithilfe des ID-Typs „Telefonnummer“ können Sie eine Konversation beginnen und die erste Nachricht an einen Kontakt senden.

Nachrichten an respond.io weiterleiten

Die Webhook-URLwird verwendet, um dieNachrichten,NachrichtenechosundNachrichtenbelegeauf der respond.io-Plattform zu posten.

Der bereitgestellte Code löst den Webhook auf respond.io aus, erstellt bei Bedarf einen Kontakt und speichert die Nachricht unter diesem Kontakt.

Beispiel für Nachrichten

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'Autorisierung: Träger aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'Cache-Steuerung: kein Cache' \\  
  -H 'Inhaltstyp: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "Typ": "Nachricht",  
      "mId": "xcvzzxcxczxczxc",  
      "Zeitstempel": 2132131321000,  
      "Nachricht": {  
        "Typ": "Text",  
        "Text": "Hallo Welt"  
      }  
    }  
  \],  
  "Kontakt": {  
    "Vorname": "John",  
    "Nachname": "Doe",  
    "Profilbild": "",  
    "Ländercode": "MY",  
    "E-Mail": "[email protected]",  
    "Telefon": "+60177872890",  
    "Sprache": "en"  
  }  
}'

Beispiel für Messaging Echoes

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'Autorisierung: Träger aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'Cache-Steuerung: kein Cache' \\  
  -H 'Inhaltstyp: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "Typ": "Nachricht\_Echo",  
      "mId": "xcvzzxcxczxczxc",  
      "Zeitstempel": 2132131321000,  
      "Nachricht": {  
        "Typ": "Text",  
        "Text": "Hallo Welt"  
      }  
    }  
  \],  
  "Kontakt": {  
    "Vorname": "John",  
    "Nachname": "Doe",  
    "Profilbild": "",  
    "Ländercode": "MY",  
    "E-Mail": "[email protected]",  
    "Telefon": "+60177872890",  
    "Sprache": "en"  
  }  
}'

Beispiel für Messaging-Belege

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'Autorisierung: Träger aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'Cache-Steuerung: kein Cache' \\  
  -H 'Inhaltstyp: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "Typ": "Nachricht\_Status",  
      "mId": "xcvzzxcxczxczxc",  
      "Zeitstempel": 2132131321000,  
      "Status": {  
        "Wert": "gesendet|zugestellt|gelesen|fehlgeschlagen",  
        "Nachricht": "Fehler: Senden aufgrund eines ungültigen Tokens fehlgeschlagen"  
      }  
  \]  
}'

Antwort – Erfolg (HTTP-Status → 200)

"OK"

Ausgehende Nachrichten von respond.io verarbeiten

respond.io ruft den Endpunkt<API Base URL>/messageauf

Stellen Sie sicher, dass Sie den CodeOutgoing Messageauf der Route/messageIhres Webservers anwenden.

Hier ist das cURL-Beispiel von respond.io, das den Endpunkt aufruft:

curl -X POST \\  
  /message \\  
  -H 'Autorisierung: Träger aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'Cache-Steuerung: kein Cache' \\  
  -H 'Inhaltstyp: application/json' \\  
  -d '{  
	"channelId": "gfd8g7fd89dgfd",  
	"contactId": "+60177872890",  
	"message": {  
		"type": "text",  
		"Text": "Hallo Welt"  
	}  
}'

Antwort – Erfolg (HTTP-Status → 200)

{  
	"mId": "1640141607842"  
}

Die Authentifizierung muss am Endpunkt erfolgen, bevor die Nachricht an den Messaging-Dienstanbieter gesendet wird.

Hier'ist ein Beispiel für die Verwendung einer Express-Middleware für diesen Zweck:

const {validationResult} = require('express-validator');

const validateToken = (req, res, next) => {
    const apiToken = <>
    const bearerToken = req.headers.authorization;

    if (!bearerToken)
        return res.send(401)

    const token = bearerToken.substring(7, bearerToken.length);

    wenn (apiToken !== token) {
        return res.send(401)
    }
    weiter();
};

module.exports = {
    validateToken
};

Wir'haben ein Beispiel für einen benutzerdefinierten Kanal beigefügt, den Sie auf Ihrem Server testen können. Schauen Sie sich hier unser GitHub-Projekt an.

Nachrichtentyp

Beispiel für Text

{  
  "Typ": "Text",  
  "Text": "Willkommen bei respond.io",  
}

Beispiel für Mediendatei

{  
  "Typ": "Anhang",  
  "Anhang": {  
    "Typ": "Bild|Video|Audio|Datei",  
    "URL": "https://abc/japan.png",  
    "MIME-Typ": "Bild/png",  
    "Dateiname":"Firmenlogo.png",  
    "Beschreibung": "neuestes Firmenlogo"  
  }  
}

Stelle sicher, dass die URL des Anhangs nicht zwangsweise vom Browser heruntergeladen wird. Der Content-Disposition-Header der HTTP-Antwort sollte den Standardwert inline haben.

Beispiel für Standort

{  
  „Typ“: „Standort“,  
  „Breitengrad“: 0,123456,  
  „Längengrad“: -0,1234,  
  „Adresse“: „Sky Suites, Jalan P. Ramlee, Kuala Lumpur, 50250 Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur“  
}

Beispiel für eine Schnellantwort

{  
  "Typ": "Schnellantwort",  
  "Titel": "Wählen Sie Ihre bevorzugte Sprache",    
  "Antworten": \[  
    "Malaiisch",  
    "Englisch"  
  \]  
}

Fehlercodes

Fehler (HTTP-Status → 4xx)

Kanalkonfiguration

Schritt 1: Klicken Sie auf Einstellungen > Kanäle

Schritt 2: Suchen Sie den benutzerdefinierten Kanal > Klicken Sie auf Verwalten

Schritt 3: Auf der Seite „Benutzerdefinierte Kanalkonfiguration“ sehen Sie die folgenden Konfigurationen:

• Kanalsymbol – Laden Sie ein Bild hoch, das als Symbol für Ihren benutzerdefinierten Kanal dient.

• Kanalname – Der Kanalname kann geändert werden und wird intern zur Identifizierung des Kanals verwendet.

• Webhook-URL für ausgehende Nachrichten — Die Webhook-URL für ausgehende Nachrichten an diesen Kanal.

• Webhook-URL für eingehende Nachrichten — Die Webhook-URL für eingehende Nachrichten an diesen Kanal.

• ID-Typ — Diese werden zur Benutzeridentifizierung und zur Kommunikation mit Ihrem benutzerdefinierten Integrationsserver verwendet.

• Kanal-ID — Eindeutige Kanal-ID zur Identifizierung Ihres benutzerdefinierten Kanals.

• API-Token — Eine eindeutige Kennung, die zur Authentifizierung eines Benutzers für den Zugriff auf eine API verwendet wird.

Schritt 4: Klicken Sie auf Änderungen speichern , um die benutzerdefinierte Kanalkonfiguration zu aktualisieren.

FAQ und Fehlerbehebung

Kann ich Chats von anderen Plattformen über einen benutzerdefinierten Kanal verbinden?

Ja, das ist möglich. Hier sind drei Schritte, die Sie befolgen müssen:

1. Gib in respond.io die Ziel-Webhook-URL von der anderen Plattform in das Feld Webhook-URL für eingehende Nachrichten ein.

2. Richten Sie auf der anderen Plattform eine -Webhook-URL ein, die auf respond.io verweist und es Kontakten ermöglicht, Ihnen Nachrichten zurückzusenden.

3. Sie'benötigen einen benutzerdefinierten Integrationsserver , um APIs sowohl von respond.io als auch von der anderen Plattform zu interpretieren und so den Nachrichtenaustausch zwischen ihnen zu ermöglichen.

Stellen Sie sicher, dass Sie mit der anderen Plattform bestätigen, dass die ersten beiden Schritte durchführbar sind.

FAQ zu benutzerdefinierten Kanal-Webhooks

Warum gibt der Webhook den Status 200 zurück, auch wenn die Nachricht nicht an respond.io zugestellt werden kann?

Beim Verbinden eines benutzerdefinierten Kanals geben Nachrichten, die über Webhooks an respond.io gesendet werden, immer sofort einen Statuscode 200 zurück, unabhängig davon, ob die Nachricht erfolgreich an respond.io weitergeleitet wurde. Dies liegt an der Natur von Webhooks, die darauf ausgelegt sind, eine sofortige Antwort zurückzugeben, ohne den Erfolg der Nachrichtenübermittlung zu überprüfen.