Подготовка к рассылке уведомлений

Перед рассылкой у вас должны быть:

• Чат, привязанный к зарегистрированному аккаунту WhatsApp Business.
  

  Как зарегистрировать аккаунт в WhatsApp Business написано в этой статье.

  
  
• Название пространства имен и название шаблона WhatsApp.
  

  Для получения пространства имен и шаблона WhatsApp обратитесь в сервис технической поддержки с просьбой создать шаблон WhatsApp, все необходимые данные они вам сообщат.

Рассылка уведомлений через API

Шаг 1. Подготовка сценария

Подготовьте сценарий, привязанный к чату, которым будет начинаться чат-сессия при рассылке уведомлений. Именно в нем указывается шаблон WhatsApp и пространство имен.

Выполните следующие действия:

1. Откройте нужный вам сценарий через редактор сценариев.
   
   
2. Разместите в сценарии блок информации или вопроса сразу после стартового блока. Он будет отвечать за старт чат-сессии.
   

   В этом блоке обязательно должен содержаться любой текст. Он не будет отображаться клиенту.

   Этот блок обязательно должен располагаться сразу после стартового блока, иначе бот может работать неправильно.

   
   

   Номер	Название поля	Описание поля
   1	Добавить действие	Нажмите кнопку Добавить действие и выберите действие Прикрепить шаблон WhatsApp.
   2	ID шаблона	Введите пространство имен, которое вы получили от технической поддержки.
   3	Название шаблона	Введите название шаблона, которое вы получили от технической поддержки.
   4	Сообщение на кнопку	Введите любой текст. Он не будет отображаться клиенту, но обязателен к заполнению.
   5	Тип кнопки	Выберите тип кнопки. Если в шаблоне кнопки не используются, то выберите вариант Быстрый ответ. Подробнее о типах кнопок вы можете узнать в этой статье.

   
   
   
3.  Сохраните сценарий.

Шаг 2. Подготовка рассылки в Twin API

curl --request POST \
     --url https://notify.twin24.ai/api/v1/messages \
     --header 'accept: application/json' \
     --header 'authorization: Bearer YOURTOKEN' \
     --header 'content-type: application/json' \
     --data '
{
  "messages": [
    {
      "useShortLinks": false,
      "destinations": [
        {
          "phone": "NUMBERPHONE"
        }
      ],
      "channels": {
        "chat": {
          "chatId": "YOURCHATID",
          "botId": "YOURBOTID",
          "messengerType": "WHATSAPP",
          "provider": "TWIN"
        }
      }
    }
  ]
}
'

Выполните следующие действия:

1. Откройте TWIN API. Там найдите метод Create message batch.
    
   
   
2. В поле Bearer введите ваш авторизационный токен.
   
   
   

   Инструкция по получению авторизационного токена

   Чтобы получить авторизационный токен, откройте вкладку Помощь – API и скопируйте оттуда ваш токен.
   
   
   

   
   
   
3. Нажмите ADD OBJECT в пункте messages.
   
   
   
   
4. Если вы хотите задать определенный временной диапазон, в котором будет происходить рассылка, нажмите ADD ARRAY OF STRINGS в функции allowedTimeRanges и укажите два значения: с какого и до какого времени будет происходить рассылка.
   

   Используйте этот шаблон для установки даты и времени: 2023-03-20T11:56:07+00:00.

   
   
   Пример указания временного диапазона отправки

   

   
   
   
   
5. Нажмите ADD OBJECT в пункте destinations.
   
   
   
   
6. Введите номер телефона, на который хотите отправить уведомление в поле phone.
   
   
   
   
7. Нажмите CHANNELS OBJECT в пункте channels.
   
   
   
   
8. Нажмите на CHAT OBJECT.
   
   
   
   
9. Заполните выделенные на скриншоте поля как указано в табличке ниже
   
   

   Название поля	Описание поля
   chatId	Введите ID чата, который привязан к WhatsApp Business.
   botId	Введите ID сценария, привязанного к чату, который содержит в себе шаблон и пространство имен.
   messengerType	Выберите тип мессенджера WHATSAPP.
   povider	Выберите провайдера TWIN.

   
   
   
10. Нажмите кнопку Try It. 
    
    
    
    

После этого убедитесь, что все прошло успешно. Для этого проверьте поле RESPONSE, там должно быть значение 201. Также результат можно увидеть в поле YOUR REQUEST HISTORY.

Работа с переменными в рассылке по API

curl --request POST \
     --url https://notify.twin24.ai/api/v1/messages \
     --header 'accept: application/json' \
     --header 'authorization: Bearer YOURTOKEN' \
     --header 'content-type: application/json' \
     --data '
{
  "messages": [
    {
      "useShortLinks": false,
      "destinations": [
        {
          "variables": {
            "VAR_NAME": "YOUR VALUE"
          },
          "phone": "YOURPHONE"
        }
      ],
      "channels": {
        "chat": {
          "chatId": "YOURCHATID",
          "botId": "YOURBOTID",
          "messengerType": "WHATSAPP",
          "provider": "TWIN"
        }
      }
    }
  ]
}
'

Объявление переменных в Twin API

Если вы хотите использовать переменные в рассылке, то вернитесь variables и нажмите VARIABLES OBJECT, а затем ADD FIELD. Кнопка ADD FIELD  добавляет новые переменные в рассылку.

Объявите переменные в появившихся полях. Название переменной впишите в поле с названием newKey, а ее значение в поле с названием New Value. На скриншоте company_name – это название, а Twin – значение переменной.

Использование объявленных переменных в сценарии

Для использования объявленных переменных в сценарии обращайтесь к ним из сценария по следующей форме: {clientMetadata.var_name}. Где var_name – название переменной.