Перейти к основному содержимому

Последовательности приветственных сообщений — руководство по API | Документация для разработчиков

Последовательности приветственных сообщений — руководство по API

Обновлено: 17 ноября 2025 г
При создании рекламных объявлений Click-to-WhatsApp вы можете подключить последовательность приветственных сообщений из вашего мессенджера. Последовательность может включать текст, предварительно заполненное сообщение и ответы на часто задаваемые вопросы.
В этом руководстве объясняется, как управлять последовательностями приветственных сообщений через конечную точку API.

Требования

Вашему приложению необходимо предоставить whatsapp_business_management .

Конечные точки

// Создать новую последовательность / Изменить существующую последовательностьPOST
/<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
// Получить список последовательностей / Получить конкретную последовательностьGET
/<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
// Удалить последовательность
DELETE /<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
Создайте последовательность
Для загрузки новой последовательности приветственных сообщений отправьте POST- запрос на WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences .
Конечная точка
// Создать новую последовательность
POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
Пример запроса
curl-X POST\
-F'welcome_message_sequence=
      {
       "text":"Это приветственное сообщение, созданное в стороннем инструменте",
"autofill_message": {"content": "Здравствуйте! Могу ли я получить дополнительную информацию!"},
"ice_breakers":[
    {"title":"Быстрый ответ 1"},
           {"title":"Быстрый ответ 2"},
           {"title":"Быстрый ответ 3"}
        ]
      }' \
-F'name="Регистрация водителя"' \
"https://graph.facebook.com/v14.0/WhatsappBusinessAccount/welcome_message_sequences"
-H'Авторизация: Bearer' 
Пример ответа
В ответе содержится идентификатор последовательности приветственного сообщения.
{"sequence_id":"186473890"}
Параметры

Параметр

Описание

Пример значения

sequence_id
Нить
Необходимый


Идентификатор последовательности.
186473890
имя
Нить
Необходимый


Название последовательности.
Регистрация водителей
welcome_message_sequence
Объект JSON
Необходимый


JSON-сообщение приветствия, которое будет отправлено при нажатии на объявление.
{
"text":"Это приветственное сообщение, созданное в стороннем инструменте",
"autofill_message": {"content": "Здравствуйте! Могу ли я получить дополнительную информацию об этом!"},
"ice_breakers":[
    {"title":"Быстрый ответ 1"},
    {"title":"Быстрый ответ 2"},
    {"title":"Быстрый ответ 3"}
  ]
}
Изменить существующую последовательность
Последовательность, связанная с активной рекламой, удалить нельзя.
Для обновления существующей последовательности отправьте POST- запрос на WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences со следующим содержимым:
    Параметр sequence_id задается идентификатором обновляемой последовательности.Другие параметры, такие как name или welcome_message_sequence, также нуждаются в обновлении.
    Конечная точка
    // Изменить существующую последовательность
    POST /<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
    Пример запроса
    curl-X POST\
    -F'sequence_id="186473890"'\
    -F'name="Driver sign-up updated name"' \
    "https://graph.facebook.com/v14.0/395394933592466/welcome_message_sequences"
    -H'Authorization: Bearer BEAiil...'
    Пример ответа
    В ответе содержится сообщение об успехе или об ошибке.
    {"success": true}
    Параметры
    
Заполнитель

Описание

Пример значения

    sequence_id
    Нить
    Необходимый

    
Идентификатор последовательности.
    186473890
    имя
    Нить
    Необязательный

    
Название последовательности.
    Регистрация водителей
    welcome_message_sequence
    Объект JSON
    Необязательный

    
JSON-сообщение приветствия, которое будет отправлено при нажатии на объявление.
    {
    "text":"Это приветственное сообщение, созданное в стороннем инструменте",
    "autofill_message": {"content": "Здравствуйте! Могу ли я получить дополнительную информацию об этом!"},
    "ice_breakers":[
        {"title":"Быстрый ответ 1"},
        {"title":"Быстрый ответ 2"},
        {"title":"Быстрый ответ 3"}
      ]
    }
    Получить список последовательностей
    Чтобы получить доступ к существующей последовательности, отправьте GET- запрос к WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences .
    Конечная точка
    // Получить список последовательностей
    GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
    Пример запроса
    curl-XGET"https://graph.facebook.com/v14.0/395394933592466/welcome_message_sequences"
    -H'Авторизация: Bearer BEAiil...'
    Пример ответа
    В случае успеха API возвращает список последовательностей для данного приложения.
    [
      {
    "sequence_id":"8716291",
    "name":"Регистрация водителя",
    "welcome_message_sequence":",
    "is_used_in_ad": true,
      },
      {
    "sequence_id":"4362",
    "name":"Basic Triage",
    "welcome_message_sequence":",
    "is_used_in_ad": false
      },
      {
    "sequence_id":"0139138",
    "name":"Appointment Schedule",
    "welcome_message_sequence":",
    "is_used_in_ad": true
      }
      ...
      ...
      ...,
      {
    "sequence_id":"6987565",
    "name":"Car Leads",
    "welcome_message_sequence":",
    "is_used_in_ad": false
      },
    ]
    Получите определенную последовательность
    Чтобы получить доступ к определенной последовательности, отправьте GET- запрос к WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences параметре sequence_id идентификатор последовательности, которую вы хотите запросить.
    Конечная точка
    // Получение определенной последовательности
    GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
    Пример запроса
    curl-XGET \
    -F'sequence_id="6987565"'
    "https://graph.facebook.com/v14.0/395394933592466/welcome_message_sequences"
    -H'Авторизация: Bearer BEAiil...'
    Пример ответа
    В случае успеха API возвращает запрошенную последовательность.
    [
      {
    "sequence_id":"6987565",
    "name":"Регистрация водителя",
    "welcome_message_sequence":",
    "is_used_in_ad": false
      },
    ]
    
Заполнитель

Описание

Пример значения

    sequence_id
    Нить
    Необязательный

    
Идентификатор последовательности.
    186473890
    лимит
    инт
    Необязательный

    
Количество последовательностей для получения.
    5
    Удалить последовательность
    Последовательность, связанная с активной рекламой, удалить нельзя.
    Для удаления последовательности отправьте DELETE- запрос на адрес WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences параметре sequence_id идентификатор последовательности, которую вы хотите удалить.
    Конечная точка
    // Получить существующую последовательность
    GET /<WHATSAPP_BUSINESS_ACCOUNT_ID>/welcome_message_sequences
    Пример запроса
    curl-X DELETE \
    -F'sequence_id="1234567890"'
    "https://graph.facebook.com/v14.0/395394933592466/welcome_message_sequences"
    -H'Authorization: Bearer BEAiil...'
    Пример ответа
    В случае успеха API возвращает подтверждение об успешном выполнении.
    {"success":true}
    
Заполнитель

Описание

Пример значения

    sequence_id
    Нить
    Необязательный

    
Идентификатор последовательности.
    186473890
    Вебхук
    Следующий веб-хук срабатывает, когда начинается диалог после того, как пользователь кликает на рекламу с призывом к действию «Click to WhatsApp».
    {
    "object": "whatsapp_business_account",
    "entry": [
        {
    "id": "ID",
    "changes": [
            {
    "value": {
    "messaging_product": "whatsapp",
    "metadata": {
    "display_phone_number": "PHONE_NUMBER",
    "phone_number_id": "PHONE_NUMBER_ID"
                },
    "contacts": [
                  {
    "profile": {
    "name": "NAME"
                    },
    "wa_id": "ID"
                  }
                ],
    "messages": [
                  {
    "referral": {
    "source_url": "AD_OR_POST_FB_URL",
    "source_id": "ADID",
    "source_type": "ad or post",
    "headline": "AD_TITLE",
    "body": "AD_DESCRIPTION",
    "media_type": "image or video",
    "image_url": "RAW_IMAGE_URL",
    "video_url": "RAW_VIDEO_URL",
    "thumbnail_url": "RAW_THUMBNAIL_URL",
    "ctwa_clid": "CTWA_CLID",
    "ref": "REF_ID",  // Новое поле в реферальной ссылке

                    },
    "from": "SENDER_PHONE_NUMBERID",
    "id": "wamid.ID",
    "timestamp": "TIMESTAMP",
    "type": "text",
    "text": {
    "body": "BODY"
                    }
                  }
                ]
              },
    "field": "messages"
            }
          ]
        }
      ]
    }
    Опыт работы с маркетинговым API
    После отправки последовательностей приветственных сообщений через API используйте идентификатор последовательности для настройки объявлений через маркетинговый API.
    В рекламном креативе идентификатор последовательности можно задать следующим образом:
    {
    "name": "creative",
    "object_story_spec": {...},
    "asset_feed_spec": {
    "additional_data": {
    "partner_app_welcome_message_flow_id": "
        }
      }
    }
    Для получения дополнительной информации о рекламных сообщениях см. раздел «Рекламные сообщения» в документации по Marketing API.
    Пошаговое руководство по работе с Ads Manager
    1: В «Шаблон сообщения» рекламного объявления выберите «Партнерское приложение».
    Раздел «Шаблон сообщения», отображающий опцию «Партнерское приложение»
      Нажмите на «Партнерское приложение» и выберите соответствующее партнерское приложение для обмена сообщениями.
      Выбор партнерского приложения в выпадающем меню
      3. В разделе «Последовательность сообщений»выберите последовательность приветственных сообщений, которую вы отправили через API.
      Выпадающий список выбора последовательности сообщений
        Предварительно просмотрите последовательность сообщений и нажмите «Сохранить».
        Предварительный просмотр последовательности сообщений с кнопкой «Сохранить»
        коды ошибок
        
Код

Описание

Возможные решения

        4027001
        Неверные входные данные
        Часть или все входные данные не соответствуют требуемому формату.
        Убедитесь, что все поля и параметры, передаваемые в запрос, имеют правильный тип и формат, а также что все необходимые параметры присутствуют.
        4027005
        Не удалось создать последовательность приветственных сообщений
        Произошла ошибка при попытке создать новую последовательность приветственных сообщений.
        Убедитесь, что токен доступа имеет все необходимые разрешения для бизнес-аккаунта WhatsApp.
        4027006
        Не удалось обновить последовательность приветственных сообщений
        Не удалось обновить последовательность приветственных сообщений.
        Проверьте правильность всех полей и идентификатора последовательности. Убедитесь, что токен доступа имеет необходимые разрешения для бизнес-аккаунта WhatsApp.
        4027007
        API недоступен
        Доступ к используемому API пока невозможен.
        Подождите день-два, пока API станет доступен, и попробуйте снова.
        4027010
        Отсутствует параметр
        Отсутствует один или несколько необходимых параметров.
        Проверьте всю документацию и убедитесь в наличии необходимых параметров.
        4027012
        Последовательность, используемая в рекламе
        Последовательность приветственных сообщений связана с активной рекламой и не может быть обновлена ​​или удалена.
        Отключите последовательность от рекламы и попробуйте снова.
        4027017
        Не удалось загрузить последовательность
        Не удалось загрузить последовательность, которая обновляется или удаляется.
        Последовательность приветственных сообщений либо отсутствует, либо у вас нет разрешения на доступ к ней. Пожалуйста, проверьте токен доступа и убедитесь, что у вас есть необходимые разрешения.
        
    
                
        
    
        

            
        
        
        
    
        

    
        

    
    
        
        
        
             Вернуться наверх