Inicio rápido de canal personalizado

Esta integración permite a su equipo chatear con sus clientes a través de cualquier canal de mensajería mediante una implementación personalizada.

Conexión de un canal personalizado

Paso 1: Vaya a Configuración > Canales

Paso 2: Haz clic en Agregar canal > Canal personalizado > Conectar

Paso 3: Ingrese la URL del Webhook de destino donde se enviarán los mensajes salientes.

Paso 4: Seleccione el tipo de ID para el canal > haga clic en Siguiente

Los tipos de identificación se utilizan para la identificación del usuario y se utilizan para comunicarse con su servidor de integración personalizado.

Hay dos tipos de identificaciones disponibles:

1. Número de teléfono: use esto si el proveedor de servicios de mensajería reconoce los contactos en función de su número de teléfono.

   1. Formato de muestra: +60177872890

2. ID personalizado: use esto si el proveedor de servicios de mensajería reconoce los contactos según una identificación generada personalizada.

   1. La longitud máxima de caracteres es 50.

   2. AZ,az,0-9,_,=,+,/y@están permitidos.

Paso 5: El siguiente cuadro de diálogo proporcionará elID del canal, elToken de APIy laURL del webhook, por ejemplo

1. ID del canal:gfd8g7fd89dgfd

2. Token API:aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd

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

   El uso de un tipo de ID de número de teléfono le permite iniciar una conversación y enviar el primer mensaje a un contacto.

Pasar mensajes a respond.io

La URL del webhook se utiliza para publicar los Mensajes, los Ecos de mensajería y los Recibos de mensajería en la plataforma respond.io.

El código proporcionado activará el webhook en respond.io, creando un contacto si es necesario y guardando el mensaje en ese contacto.

Muestra para mensajes

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'autorización: Portador aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'control de caché: sin caché' \\  
  -H 'tipo de contenido: aplicación/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "eventos": \[  
    {  
      "tipo": "mensaje",  
      "mId": "xcvzzxcxczxczxc",  
      "marca de tiempo": 2132131321000,  
      "mensaje": {  
        "tipo": "texto",  
        "texto": "Hola mundo"  
      }  
    }  
  \],  
  "contacto": {  
    "nombre": "John",  
    "apellido": "Doe",  
    "foto de perfil": "<https://static.independent.co.uk/s3fs-public/thumbnails/image/2015/07/08/14/pic.jpg>",  
    ,    "código de país": "MI",  
    ,    "correo electrónico": "john@respond.io",  
    ,    "teléfono": "+60177872890",  
    ,    "idioma": "es"  
  }  
}'

Muestra para ecos de mensajería

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'autorización: Portador aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'control de caché: sin caché' \\  
  -H 'tipo de contenido: aplicación/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "mensaje_echo",  
      "mId": "xcvzzxcxczxczxc",  
      "marca de tiempo": 2132131321000,  
      "mensaje": {  
        "tipo": "texto",  
        "texto": "Hola mundo"  
      }  
    }  
  \],  
  "contacto": {  
    "nombre": "John",  
    "apellido": "Doe",  
    "foto de perfil": "<https://static.independent.co.uk/s3fs-public/thumbnails/image/2015/07/08/14/pic.jpg>",  
    "código de país": "MY",  
    "correo electrónico": "john@respond.io",  
    "teléfono": "+60177872890",  
    "idioma": "en"  
  }  
}'

Ejemplo de recibos de mensajería

curl -X POST \\  
  https://app.respond.io/custom/channel/webhook/ \\  
  -H 'autorización: Portador aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'control de caché: sin caché' \\  
  -H 'tipo de contenido: aplicación/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "mensaje_estado",  
      "mId": "xcvzzxcxczxczxc",  
      "timestamp": 2132131321000,  
      "estado": {  
        "valor": "enviado|entregado|leído|fallido",  
        "mensaje": "Error: El envío falló debido a un token no válido"  
      }  
    }  
  \]  
}'

Respuesta - Éxito (estado HTTP → 200)

"OK"

Gestionar mensajes salientes desde respond.io

respond.io llamará al punto final<API Base URL>/mensaje

Asegúrese de aplicar el códigoMensaje salienteen la ruta/messagede su servidor web.

Aquí está el ejemplo cURL de respond.io llamando al punto final:

curl -X POST \\  
  /mensaje \\  
  -H 'autorización: Portador aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'control de caché: sin caché' \\  
  -H 'tipo de contenido: aplicación/json' \\  
  -d '{  
	"canalId": "gfd8g7fd89dgfd",  
	"contactoId": "+60177872890",  
	"mensaje": {  
		"tipo": "texto",  
		"texto": "Hola mundo"  
	}  
}'

Respuesta - Éxito (estado HTTP → 200)

{  
	"mId": "1640141607842"  
}

La autenticación debe realizarse en el punto final antes de enviar el mensaje al proveedor de servicios de mensajería.

Aquí hay un ejemplo de uso de un middleware express para este propósito:

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);

    if (apiToken !== token) {
        return res.send(401)
    }
    next();
};

module.exports = {
    validateToken
};

Hemos incluido un ejemplo de un Canal Personalizado que puedes probar en tu servidor. Echa un vistazo a nuestro proyecto de GitHub aquí.

Tipo de mensajes

Muestra de texto

{  
  "tipo": "texto",  
  "texto": "Bienvenido a respond.io",  
}

Muestra de archivo multimedia

{  
  "tipo": "adjunto",  
  "adjunto": {  
    "tipo": "imagen|video|audio|archivo",  
    "url": "https://abc/japan.png",  
    "mimeType": "image/png",  
    "fileName":"company logo.png",  
    "description": "latest company logo"  
  }  
}

Asegúrate de que la URL del archivo adjunto no se descargue forzosamente por el navegador. El encabezado de respuesta HTTP's Content-Disposition debe tener el valor predeterminado, que es en línea.

Muestra de ubicación

{  
  "tipo": "ubicación",  
  "latitud": 0.123456,  
  "longitud": -0.1234,  
  "dirección": "Sky Suites, Jalan P. Ramlee, Kuala Lumpur, 50250 Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur"  
}

Muestra para respuesta rápida

{  
  "tipo": "respuesta rápida",  
  "título": "Seleccione su idioma preferido",    
  "respuestas": \[  
    "malayo",  
    "inglés"  
  \]  
}

Códigos de error

Error (Estado HTTP → 4xx)

Configuración del canal

Paso 1: Haz clic en Configuración > Canales

Paso 2: Ubica el canal personalizado > haz clic en Administrar

Paso 3: En la página de configuración de canal personalizado verá las siguientes configuraciones:

• Ícono de canal - Sube una imagen que sirva como ícono para tu canal personalizado.

• Nombre del canal - El nombre del canal se puede cambiar y se usa internamente para identificar el canal.

• URL de webhook para mensaje saliente — La URL de webhook para mensajes salientes a este canal.

• URL de webhook para mensajes entrantes — La URL de webhook para mensajes entrantes a este canal.

• Tipo de ID : se utilizan para la identificación del usuario y se utilizan para comunicarse con su servidor de integración personalizado.

• ID de canal — ID de canal único para identificar su canal personalizado.

• Token de API : un identificador único utilizado para autenticar a un usuario para acceder a una API.

Paso 4: Haga clic en Guardar cambios para actualizar la configuración del canal personalizado.

Preguntas frecuentes y solución de problemas

¿Puedo conectar chats de otras plataformas usando un canal personalizado?

Sí, puedes. A continuación se indican tres pasos a seguir:

1. En respond.io, ingrese la URL del webhook de destino de la otra plataforma en el campo URL del webhook para el mensaje entrante .

2. En la otra plataforma, configure una URL de webhook que apunte a respond.io, lo que permitirá que los contactos le envíen mensajes.

3. Necesitarás un Servidor de Integración Personalizada para interpretar las APIs tanto de respond.io como de la otra plataforma, permitiendo el intercambio de mensajes entre ellas.

Asegúrese de confirmar con la otra plataforma que los dos primeros pasos sean factibles.

Preguntas frecuentes sobre webhooks de canales personalizados

¿Por qué el webhook devuelve un estado 200 incluso si el mensaje no se puede entregar a respond.io?

Al conectar un canal personalizado, los mensajes enviados a respond.io a través de webhooks siempre devolverán un código de estado 200 inmediatamente, independientemente de si el mensaje se pasó correctamente a respond.io. Esto se debe a la naturaleza de los webhooks, que están diseñados para devolver una respuesta inmediata sin verificar el éxito de la entrega del mensaje.