Guida Rapida al Canale Personalizzato

Questa integrazione consente al tuo team di chattare con i tuoi clienti su qualsiasi canale di messaggistica tramite un'implementazione personalizzata.

Collegamento di un canale personalizzato

Passaggio 1: Vai a Impostazioni > Canali

Passaggio 2: Fai clic su Aggiungi canale > Canale personalizzato > Connetti

Passaggio 3: Inserisci l'URL del webhook di destinazione a cui verranno inviati i messaggi in uscita.

Passaggio 4: Seleziona il tipo di ID per il canale > clicca Avanti

I tipi di ID vengono utilizzati per l'identificazione dell'utente e per comunicare con il server di integrazione personalizzato.

Sono disponibili due tipi di ID:

1. Numero di telefono: utilizzare questa opzione se il fornitore del servizio di messaggistica riconosce i contatti in base al loro numero di telefono.

   1. Formato di esempio: +60177872890

2. ID personalizzato: utilizzare questa opzione se il fornitore del servizio di messaggistica riconosce i Contatti in base a un ID generato personalizzato.

   1. La lunghezza massima dei caratteri è 50.

   2. AZ,az,0-9,_,=, Sono consentiti+,/e@.

Passo 5: La seguente finestra di dialogo fornirà il Channel ID, il API Token e il Webhook URL, ad esempio.

1. ID canale:gfd8g7fd89dgfd

2. Token API:aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd

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

   Utilizzando un ID di tipo Numero di Telefono è possibile avviare una conversazione e inviare il primo messaggio a un Contatto.

Passa i messaggi a respond.io

Il Webhook URL viene utilizzato per inviare i Messaggi, gli Echo di Messaggistica e le Ricevute di Messaggistica alla piattaforma respond.io.

Il codice fornito attiverà il webhook su respond.io, creando un contatto se necessario e salvando il messaggio sotto quel contatto.

Esempio per i messaggi

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'autorizzazione: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'controllo cache: no-cache' \\  
  -H 'tipo di contenuto: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "eventi": \[  
    {  
      "tipo": "messaggio",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "messaggio": {  
        "tipo": "testo",  
        "testo": "Ciao mondo"  
      }  
    }  
  \],  
  "contatto": {  
    "Nome": "John",  
    "Cognome": "Doe",  
    "Immagine del profilo": "<https://static.independent.co.uk/s3fs-public/thumbnails/image/2015/07/08/14/pic.jpg>",  
    "Codice paese": "MIO",  
    "email": "john@respond.io",  
    "telefono": "+60177872890",  
    "lingua": "en"  
  }  
}'

Esempio per gli echi di messaggistica

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'autorizzazione: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'controllo cache: no-cache' \\  
  -H 'tipo di contenuto: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "eventi": \[  
    {  
      "tipo": "messaggio\_echo",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "messaggio": {  
        "tipo": "testo",  
        "testo": "Ciao mondo"  
      }  
    }  
  \],  
  "contatto": {  
    "Nome": "John",  
    "Cognome": "Doe",  
    "Immagine del profilo": "<https://static.independent.co.uk/s3fs-public/thumbnails/image/2015/07/08/14/pic.jpg>",  
    "Codice paese": "MIO",  
    "email": "john@respond.io",  
    "telefono": "+60177872890",  
    "lingua": "en"  
  }  
}'

Esempio di ricevute di messaggistica

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'autorizzazione: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'controllo cache: no-cache' \\  
  -H 'tipo di contenuto: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "eventi": \[  
    {  
      "tipo": "messaggio\_stato",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "stato": {  
        "valore": "inviato|consegnato|letto|fallito",  
        "messaggio": "Errore: invio fallito a causa di token non valido"  
      }  
  \]  
}'

Risposta - Successo (stato HTTP → 200)

"OK"

Gestisci i messaggi in uscita da respond.io

respond.io chiamerà l'endpoint<API Base URL>/message

Assicurati di applicare il codiceOutgoing Messagesulla rotta/messagedel tuo server web.

Ecco l'esempio cURL di respond.io che chiama l'endpoint:

curl -X POST \\  
  <API Base URL>/messaggio \\  
  -H 'autorizzazione: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'controllo cache: no-cache' \\  
  -H 'tipo di contenuto: applicazione/json' \\  
  -d '{  
	"channelId": "gfd8g7fd89dgfd",  
	"contactId": "+60177872890",  
	"messaggio": {  
		"tipo": "testo",  
		"testo": "Ciao mondo"  
	}  
}'

Risposta - Successo (stato HTTP → 200)

{  
	"mId": "1640141607842"  
}

L'autenticazione deve avvenire nell'endpoint prima di inviare il messaggio al fornitore di servizi di messaggistica.

Ecco un esempio di utilizzo di un middleware express per questo scopo:

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

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

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

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

    se (apiToken !== token) {
        restituisci res.send(401)
    }
    successivo();
};

modulo.esportazioni = {
    validateToken
};

Abbiamo'incluso un esempio di canale personalizzato che puoi testare sul tuo server. Dai un'occhiata al nostro progetto GitHub qui.

Tipo di messaggio

Esempio di testo

{  
  "tipo": "testo",  
  "testo": "Benvenuto su respond.io",  
}

Esempio per file multimediale

{  
  "tipo": "allegato",  
  "allegato": {  
    "tipo": "immagine|video|audio|file",  
    "url": "https://abc/japan.png",  
    "mimeType": "immagine/png",  
    "fileName":"logo aziendale.png",  
    "descrizione": "ultimo logo aziendale"  
  }  
}

Assicurati che l'URL dell'allegato non venga scaricato forzatamente dal browser. L'intestazione della risposta HTTP's Content-Disposition dovrebbe avere il valore predefinito, ovvero inline.

Esempio per la posizione

{  
  "tipo": "posizione",  
  "latitudine": 0.123456,  
  "longitudine": -0.1234,  
  "indirizzo": "Sky Suites, Jalan P. Ramlee, Kuala Lumpur, 50250 Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur"  
}

Esempio per risposta rapida

{  
  "tipo": "risposta\_rapida",  
  "titolo": "Seleziona la tua lingua preferita",    
  "risposte": \[  
    "Malese",  
    "Inglese"  
  \]  
}

Codici di errore

Errore (Stato HTTP → 4xx)

Configurazione del canale

Passaggio 1: Fai clic su Impostazioni > Canali

Passaggio 2: Individua il canale personalizzato > fai clic su Gestisci

Passaggio 3: Nella pagina di configurazione del canale personalizzato vedrai le seguenti configurazioni:

• Icona del canale - Carica un'immagine che fungerà da icona per il tuo canale personalizzato.

• Nome canale - Il nome del canale può essere modificato e viene utilizzato internamente per identificare il canale.

• URL webhook per messaggio in uscita — URL webhook per i messaggi in uscita verso questo canale.

• URL webhook per messaggio in arrivo — URL webhook per i messaggi in arrivo su questo canale.

• Tipo ID — Vengono utilizzati per l'identificazione dell'utente e per comunicare con il server di integrazione personalizzato.

• ID canale — ID canale univoco per identificare il tuo canale personalizzato.

• Token API — Identificatore univoco utilizzato per autenticare un utente per accedere a un'API.

Passaggio 4: Fare clic su Salva modifiche per aggiornare la configurazione del canale personalizzato.

FAQ e risoluzione dei problemi

Posso collegare le chat di altre piattaforme utilizzando un canale personalizzato?

Sì, puoi farlo. Ecco tre passaggi da seguire:

1. In respond.io, inserisci il webhook URL di destinazione proveniente dall'altra piattaforma nel campo Webhook URL per messaggi in arrivo.

2. Nell'altra piattaforma, imposta un URL webhook che punti a respond.io, consentendo ai Contatti di inviarti messaggi.

3. Avrai bisogno di un Server di Integrazione Personalizzata per interpretare le API sia di respond.io che dell'altra piattaforma, consentendo lo scambio di messaggi tra di esse.

Assicuratevi di verificare con l'altra piattaforma che i primi due passaggi siano fattibili.

Domande frequenti sui webhook dei canali personalizzati

Perché il webhook restituisce uno stato 200 anche se il messaggio non riesce a essere recapitato a respond.io?

Quando si collega un canale personalizzato, i messaggi inviati a respond.io tramite webhook restituiranno sempre immediatamente un codice di stato 200, indipendentemente dal fatto che il messaggio sia stato trasmesso correttamente a respond.io. Ciò è dovuto alla natura dei webhook, che sono progettati per restituire una risposta immediata senza verificare il successo della consegna del messaggio.