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

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

Обновлено: 17 ноября 2025 г

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

В этом руководстве объясняется, как управлять последовательностями приветственных сообщений через конечную точку API.

Требования

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

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

//
Создать новую последовательность / Изменить существующую последовательностьence
ПОЧТА /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

// Получить список последовательностей / Получить конкретную последовательностьце
ПОЛУЧАТЬ /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

// Удалить последовательность
УДАЛИТЬ /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

Создайте последовательность

~~Чтобы загрузить новую последовательность приветственных сообщений, отправьте~~ ПОЧТА ~~запрос к~~ WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences ~~конечная точка.~~

Конечная точка

// Создать новую последовательность
ПОЧТА /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

Пример запроса

локон-X ПОЧТА\
-Ф'welcome_message_sequence=
      {
       "текст":"Это приветственное сообщение, написанное в инструменте 3P",
"autofill_message": {"content": "Привет! Могу ли я получить Больше информации об этом!"
"ice_breakers":[
    {"title":"Быстрый ответ 1"},
           {"title":"Быстрый ответ 2"},
           {"title":"Быстрый ответ 3"}
        ]
      }' \
-Ф'name="Регистрация водителя"' \
"https://graph.facebook.com/v14.0/WhatsappBusinessAccount/welcome_message_sequences"
-ЧАС«Авторизация: Предъявитель»<ACCESS_TOKEN> '

Пример ответа

~~В ответе содержится идентификатор последовательности приветственного сообщения.~~

{"sequence_id":"186473890"}

Параметры

~~Параметр~~ ~~Описание~~ ~~Пример значения~~

~~Параметр~~	~~Описание~~	~~Пример значения~~
`sequence_id` ~~Нить~~	~~Необходимый~~ ~~Идентификатор последовательности.~~	`186473890`
`имя` ~~Нить~~	~~Необходимый~~ ~~Название последовательности.~~	`Регистрация водителей`
`welcome_message_sequence` ~~Объект JSON~~	~~Необходимый~~ ~~JSON-сообщение приветствия, которое будет отправлено при нажатии на объявление.~~	{ ~~"текст"~~:~~«Это приветственное сообщение, созданное с помощью инструмента стороннего поставщика»~~, ~~"autofill_message": {"содержание"~~: ~~Здравствуйте! Не могли бы вы предоставить более подробную информацию по этому вопросу?~~}, ~~"ice_breakers"~~:[ {~~"заголовок"~~:~~"Быстрый ответ 1"~~}, {~~"заголовок"~~:~~"Быстрый ответ 2"~~}, {~~"заголовок"~~:~~"Быстрый ответ 3"~~} ] }

sequence_id

~~Нить~~

~~Необходимый~~

~~Идентификатор последовательности.~~

186473890

имя

~~Нить~~

~~Необходимый~~

~~Название последовательности.~~

Регистрация водителей

welcome_message_sequence

~~Объект JSON~~

~~Необходимый~~

~~JSON-сообщение приветствия, которое будет отправлено при нажатии на объявление.~~

{
"текст":«Это приветственное сообщение, созданное с помощью инструмента стороннего поставщика»,
"autofill_message": {"содержание": Здравствуйте! Не могли бы вы предоставить более подробную информацию по этому вопросу?},
"ice_breakers":[
    {"заголовок":"Быстрый ответ 1"},
    {"заголовок":"Быстрый ответ 2"},
    {"заголовок":"Быстрый ответ 3"}
  ]
}

Изменить существующую последовательность

Последовательность, связанная с активной рекламой, удалить нельзя.

Для обновления существующей последовательности отправьте POST- запрос на WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences со следующим содержимым:

Параметр sequence_id задается идентификатором обновляемой последовательности.Другие параметры, такие как name или welcome_message_sequence , также нуждаются в обновлении.

Конечная точка

//
Изменить существующую последовательность
ПОЧТА /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

Пример запроса

локон-X ПОЧТА\
-Ф'sequence_id="186473890"'\
-Ф'name="Имя, указанное при регистрации водителя, обновлено"' \
"https://graph.facebook.com/v14.0/395394933592466/"последовательности приветственных сообщений"
-ЧАС«Авторизация: Предъявитель BEAiil...»

Пример ответа

В ответе содержится сообщение об успехе или об ошибке.

{ "success" : true }

Параметры

~~Заполнитель~~ ~~Описание~~ ~~Пример значения~~

~~Заполнитель~~	~~Описание~~	~~Пример значения~~
`sequence_id` ~~Нить~~	~~Необходимый~~ ~~Идентификатор последовательности.~~	`186473890`
`имя` ~~Нить~~	~~Необязательный~~ ~~Название последовательности.~~	`Регистрация водителей`
`welcome_message_sequence` ~~Объект JSON~~	~~Необязательный~~ ~~JSON-сообщение приветствия, которое будет отправлено при нажатии на объявление.~~	{ ~~"текст"~~:~~«Это приветственное сообщение, созданное с помощью инструмента стороннего поставщика»~~, ~~"autofill_message": {"содержание"~~: ~~Здравствуйте! Не могли бы вы предоставить более подробную информацию по этому вопросу?~~}, ~~"ice_breakers"~~:[ {~~"заголовок"~~:~~"Быстрый ответ 1"~~}, {~~"заголовок"~~:~~"Быстрый ответ 2"~~}, {~~"заголовок"~~:~~"Быстрый ответ 3"~~} ] }

sequence_id

~~Нить~~

~~Необходимый~~

~~Идентификатор последовательности.~~

186473890

имя

~~Нить~~

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

~~Название последовательности.~~

Регистрация водителей

welcome_message_sequence

~~Объект JSON~~

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

~~JSON-сообщение приветствия, которое будет отправлено при нажатии на объявление.~~

{
"текст":«Это приветственное сообщение, созданное с помощью инструмента стороннего поставщика»,
"autofill_message": {"содержание": Здравствуйте! Не могли бы вы предоставить более подробную информацию по этому вопросу?},
"ice_breakers":[
    {"заголовок":"Быстрый ответ 1"},
    {"заголовок":"Быстрый ответ 2"},
    {"заголовок":"Быстрый ответ 3"}
  ]
}

Получить список последовательностей

~~Чтобы получить доступ к существующей последовательности, отправьте..~~ ПОЛУЧАТЬ ~~запрос к~~ WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences ~~конечная точка.~~

Конечная точка

// Получить список последовательностей
ПОЛУЧАТЬ /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

Пример запроса

локон-XПОЛУЧАТЬ"https://graph.facebook.com/v14.0/395394933592466/"последовательности приветственных сообщений"
-ЧАС«Авторизация: Предъявитель BEAiil...»

Пример ответа

~~В случае успеха API возвращает список последовательностей для данного приложения.~~

[
  {
"sequence_id":"8716291",
"имя":"Регистрация водителя",
"welcome_message_sequence":"<JSON_OBJECT> ",
"is_used_in_ad": истинный,
  },
  {
"sequence_id":"4362",
"имя":«Базовая сортировка пациентов»,
"welcome_message_sequence":"<JSON_OBJECT> ",
"is_used_in_ad": ЛОЖЬ
  },
  {
"sequence_id":"0139138",
"имя":«График встреч»,
"welcome_message_sequence":"<JSON_OBJECT> ",
"is_used_in_ad": истинный
  }
  ...
  ...
  ...,
  {
"sequence_id":"6987565",
"имя":"Автомобильные лидеры",
"welcome_message_sequence":"<JSON_OBJECT> ",
"is_used_in_ad": ЛОЖЬ
  },
]

Получите определенную последовательность

~~Чтобы получить определенную последовательность, отправьте~~ ПОЛУЧАТЬ ~~запрос к~~ WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences с sequence_id ~~Параметр задается идентификатором последовательности, которую вы хотите запросить.~~

Конечная точка

// Получить определенную последовательность
ПОЛУЧАТЬ /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

Пример запроса

локон-XПОЛУЧАТЬ \
-Ф'sequence_id="6987565"'
"https://graph.facebook.com/v14.0/395394933592466/"последовательности приветственных сообщений"
-ЧАС«Авторизация: Предъявитель BEAiil...»

Пример ответа

~~В случае успеха API возвращает запрошенную последовательность.~~

[
  {
"sequence_id":"6987565",
"имя":"Регистрация водителя",
"welcome_message_sequence":"<JSON_OBJECT> ",
"is_used_in_ad": ЛОЖЬ
  },
]

~~Заполнитель~~	~~Описание~~	~~Пример значения~~
`sequence_id` ~~Нить~~	~~Необязательный~~ ~~Идентификатор последовательности.~~	`186473890`
`лимит` ~~инт~~	~~Необязательный~~ ~~Количество последовательностей для получения.~~	`5`

Удалить последовательность

Последовательность, связанная с активной рекламой, удалить нельзя.

Для удаления последовательности отправьте DELETE- запрос на адрес WHATSAPP_BUSINESS_ACCOUNT_ID/welcome_message_sequences параметре sequence_id идентификатор последовательности, которую вы хотите удалить.

Конечная точка

//
Получить существующую последовательность
ПОЛУЧАТЬ /<Идентификатор бизнес-аккаунта WhatsApp>/welcome_message_sequences

Пример запроса

локон-X УДАЛИТЬ \
-Ф'sequence_id="1234567890"'
"https://graph.facebook.com/v14.0/395394933592466/"последовательности приветственных сообщений"
-ЧАС«Авторизация: Предъявитель BEAiil...»

Пример ответа

~~В случае успеха API возвращает подтверждение об успешном выполнении.~~

{"успех":истинный}

~~Заполнитель~~	~~Описание~~	~~Пример значения~~
`sequence_id` ~~Нить~~	~~Необязательный~~ ~~Идентификатор последовательности.~~	`186473890`

Вебхук

Следующий веб-хук срабатывает, когда начинается диалог после того, как пользователь кликает на рекламу с призывом к действию «Click to WhatsApp».

{
"объект": "whatsapp_business_account",
"вход": [
    {
"идентификатор": "ИДЕНТИФИКАТОР",
"изменения": [
        {
"ценить": {
"messaging_product": "WhatsApp",
"метаданные": {
"display_phone_number": "НОМЕР ТЕЛЕФОНА",
"идентификатор_номера_телефона": "НОМЕР_ТЕЛЕФОНА_ID"
            },
"контакты": [
              {
"профиль": {
"имя": "ИМЯ"
                },
"ва_ид": "ИДЕНТИФИКАТОР"
              }
            ],
"сообщения": [
              {
«направление»: {
"source_url": "AD_OR_POST_FB_URL",
"source_id": "ADID",
"source_type": "реклама или пост",
"заголовок": "AD_TITLE",
"тело": "ОПИСАНИЕ_РЕКЛАМНОГО_ОБЪЯВЛЕНИЯ",
"media_type": «изображение или видео»,
"image_url": "RAW_IMAGE_URL",
"video_url": "RAW_VIDEO_URL",
"thumbnail_url": "RAW_THUMBNAIL_URL",
"ctwa_clid": "CTWA_CLID",
"ref": "REF_ID",  // Новое поле в реферальной ссылке

                },
"от": "ИДЕНТИФИКАТОР_НОМЕРА_ОТПРАВИТЕЛЯ_ТЕЛЕФОНА",
"идентификатор": "wamid.ID",
"временная метка": "ВРЕМЕННАЯ МЕТКА",
"тип": "текст",
"текст": {
"тело": "ТЕЛО"
                }
              }
            ]
          },
"поле": "сообщения"
        }
      ]
    }
  ]
}

Опыт работы с маркетинговым API

После отправки последовательностей приветственных сообщений через API используйте идентификатор последовательности для настройки объявлений через маркетинговый API.

В рекламном креативе идентификатор последовательности можно задать следующим образом:

{
"имя":

~~"творческий"~~,
~~"object_story_spec": {...},~~
~~"asset_feed_spec": {~~
~~"дополнительные_данные": {~~
~~"partner_app_welcome_message_flow_id"~~: ~~"<SEQUENCE_ID_RETURNED_FROM_POST_REQUEST> "~~
}
}
}

Для получения дополнительной информации о рекламных сообщениях см. раздел «Рекламные сообщения» в документации по Marketing API.

Пошаговое руководство по работе с Ads Manager

1: В «Шаблон сообщения» рекламного объявления выберите «Партнерское приложение».

Раздел «Шаблон сообщения», отображающий опцию «Партнерское приложение»

Нажмите на «Партнерское приложение» и выберите соответствующее партнерское приложение для обмена сообщениями.

Выбор партнерского приложения в выпадающем меню

3. В разделе «Последовательность сообщений» выберите последовательность приветственных сообщений, которую вы отправили через API.

Выпадающий список выбора последовательности сообщений

Предварительно просмотрите последовательность сообщений и нажмите «Сохранить» .

Предварительный просмотр последовательности сообщений с кнопкой «Сохранить»

коды ошибок

Код Описание Возможные решения

4027001

Неверные входные данные

Часть или все входные данные не соответствуют требуемому формату.

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

4027005

Не удалось создать последовательность приветственных сообщений

Произошла ошибка при попытке создать новую последовательность приветственных сообщений.

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

4027006

Не удалось обновить последовательность приветственных сообщений

Не удалось обновить последовательность приветственных сообщений.

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

4027007

API недоступен

Доступ к используемому API пока невозможен.

Подождите день-два, пока API станет доступен, и попробуйте снова.

4027010

Отсутствует параметр

Отсутствует один или несколько необходимых параметров.

Проверьте всю документацию и убедитесь в наличии необходимых параметров.

4027012

Последовательность, используемая в рекламе

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

Отключите последовательность от рекламы и попробуйте снова.

4027017

Не удалось загрузить последовательность

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

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