Пользовательский канал быстрого запуска

Эта интеграция позволяет вашей команде общаться с клиентами через любой канал обмена сообщениями через пользовательскую реализацию.

Подключение пользовательского канала

Шаг 1: Перейдите к Настройки > Каналы

Шаг 2: Щелкните Добавить канал > Пользовательский канал > Подключиться

Шаг 3: Введите URL назначения Webhook, где будут отправляться исходящие сообщения.

Шаг 4: Выберите тип ID для канала > нажмите Далее

Типы идентификаторов используются для идентификации пользователей и используются для связи с вашим пользовательским сервером интеграции.

Существует два типа идентификаторов:

1. Телефонный номер: Используйте это, если поставщик услуг обмена сообщениями распознает контакты на основе их телефонного номера.

   1. Формат примера: +60177872890

2. Пользовательский ID: Используйте, если поставщик услуг обмена сообщениями распознает контакты на основе пользовательского ID.

   1. Максимальная длина символа - 50.

   2. A-Z,a-z,0-9,_,=,+,/и@разрешены.

Шаг 5: Следующий диалог предоставитканал ID,API TokenиURL Webhookнапр.

1. ID канала:gfd8g7fd89dgfd

2. API Token:aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd

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

   Использование типа Номер телефона позволяет инициировать разговор и отправить первое сообщение контакту.

Передача сообщений на respond.io

URL-адрес веб-перехватчикаиспользуется для публикациисообщений,сообщений эхаисообщений квитанцийна платформе response.io.

Предоставленный код вызовет webhook на respond.io, создаст контакт, если это необходимо, и сохранит сообщение под этим Контактом.

Пример для сообщений

curl -X POST \\  
  https://app.respond. o/custom/channel/webhook/ \\  
  -H 'authorization: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "message",  
      "mId": "xcvzzxcxczxc",  
      "timestamp": 21321321000,  
      "message": {  
        "type": "text",  
        "Текст": "Приветствуем мир"  
      }  
    }  
  \],  
  "contact": {  
    "firstName": "John",  
    "lastName": "Doe",  
    "profilePic": "",  
    "Код страны": "MY",  
    "email": "john@respond. o",  
    "телефон": "+60177872890",  
    "язык": "ru"  
  }  
}'

Пример для сообщений Echoes

curl -X POST \\  
  https://app.respond. o/custom/channel/webhook/ \\  
  -H 'authorization: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "message\_echo",  
      "mId": "xcvzzxcxczxc",  
      "timestamp": 21321321000,  
      "message": {  
        "type": "text",  
        "Текст": "Приветствуем мир"  
      }  
    }  
  \],  
  "contact": {  
    "firstName": "John",  
    "lastName": "Doe",  
    "profilePic": "",  
    "Код страны": "MY",  
    "email": "john@respond. o",  
    "телефон": "+60177872890",  
    "язык": "ru"  
  }  
}'

Пример для отправки квитанций

curl -X POST \\  
  https://app.respond. o/custom/channel/webhook/ \\  
  -H 'authorization: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
  "channelId": "gfd8g7fd89dgfd",  
  "contactId": "+60177872890",  
  "events": \[  
    {  
      "type": "message\_status",  
      "mId": "xcvzzxcxczxc",  
      "timestamp": 21321321000,  
      "status": {  
        "value": "sent|delivered|read|failed",  
        "message": "Ошибка: отправка не удалась из-за неверного токена"  
      }  
  \]  
}'

Ответ - Успех (HTTP статус → 200)

"OK"

Обработка исходящих сообщений от respond.io

response.io вызовет конечную точку<API Base URL>/message

Убедитесь, что вы применили кодИсходящего сообщенияна маршруте/messageвашего веб-сервера.

Вот пример cURL respond.io вызова конечной точки:

curl -X POST \\  
  /message \\  
  -H 'authorization: Bearer aaaxczsadzxcasdacxzcasdaaaxczsadzxcasdacxzcasd' \\  
  -H 'cache-control: no-cache' \\  
  -H 'content-type: application/json' \\  
  -d '{  
	"channelId": "gfd8g7fd89dgfd",  
	"contactId": "+60177872890",  
	"message": {  
		"type": "text",  
		"Текст": "Привет, Мир"  
	}  
}'

Ответ - Успех (HTTP статус → 200)

{  
	"mId": "1640141607842"  
}

Аутентификация должна происходить в конечной точке перед отправкой сообщения поставщику услуг обмена сообщениями.

Вот's пример использования экспресс-middleware для этой цели:

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

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

    если (!bearerToken)
        возвращает с. end(401)

    const token = bearerToken.substring(7, bearerToken.

    if (apiToken !== token) {
        return res. end(401)
    }
    следующей();
};

module.exports = {
    validateToken
};

Мы'включили пример пользовательского канала, который вы можете тестировать на вашем сервере. Посмотрите наш проект GitHub здесь.

Тип сообщений

Образец текста

{  
  "type": "text",  
  "text": "Добро пожаловать в respond.io",  
}

Пример для медиа файла

{  
  "type": "attachment",  
  "attachment": {  
    "type": "image|video|audio|file",  
    "url": "https://abc/japan. ng",  
    "mimeType": "image/png",  
    "fileName":"логотип компании. ng",  
    "Описание": "последний логотип компании"  
  }  
}

Убедитесь, что URL-адрес вложения является't принудительно скачан браузером. Заголовок HTTP ответа's Content-Disposition должен иметь значение по умолчанию, то есть inline.

Пример для местоположения

{  
  "type": "location",  
  "latitude": 0.123456,  
  "longitude": -0.1234,  
  "address": "Sky Suites, Jalan P. Ramlee, Kuala Lumpur, 50250 Kuala Lumpur, Wilayah Persekutuan Kuala Lumpur"  
}

Пример для быстрого ответа

{  
  "type": "quick\_reply",  
  "title": "Выберите предпочитаемый язык",    
  "Ответы": \[  
    "Малай",  
    "English"  
  \]  
}

Коды ошибок

Error (HTTP Status → 4xx)

Конфигурация канала

Шаг 1: Нажмите Параметры > Каналы

Шаг 2: Найдите пользовательский канал > нажмите Управление

Шаг 3: на странице Пользовательской конфигурации канала вы увидите следующие конфигурации:

• Значок канала - Загрузите изображение, которое служит иконкой для пользовательского канала.

• Название канала - Название канала можно изменить, оно используется внутри для идентификации канала.

• Webhook URL для исходящих сообщений — Webhook URL для исходящих сообщений в этот канал.

• Webhook URL для входящего сообщения — Webhook URL для входящих сообщений на этот канал.

• ID Type — Они используются для идентификации пользователя и используются для связи с вашим пользовательским сервером интеграции.

• Channel ID — Unique Channel ID для идентификации пользовательского канала.

• API Token — уникальный идентификатор, используемый для аутентификации пользователя для доступа к API.

Шаг 4: Нажмите Сохранить изменения для обновления конфигурации пользовательского канала.

FAQ и устранение неполадок

Могу ли я подключать чаты с других платформ с помощью пользовательского канала?

Да, вы можете. Ниже перечислены три шага:

1. В respond.io, введите URL-адрес вебхука назначения с другой платформы в поле URL-адрес Webhook для входящего сообщения.

2. На другой платформе настройте URL-адрес webhook со ссылкой на respond.io, позволяя Контактам отправлять вам сообщения.

3. Вам'понадобится сервер пользовательской интеграции для интерпретации API как с respond.io, так и с другой платформы, что позволяет обмениваться сообщениями между ними.

Убедитесь, что с другой платформой возможны первые два шага.

FAQ для пользовательских вебхуков каналов

Почему вебхук возвращает 200 статусов, даже если сообщение не может быть доставлено в respond.io?

При подключении пользовательского канала сообщения отправляются на ответ. , через вебхуки всегда возвращают 200 статус-кода немедленно, независимо от того, было ли сообщение успешно передано в respond.io. Это обусловлено характером вебхуков, которые предназначены для возврата немедленного ответа без проверки успеха доставки сообщения.