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

WhatsApp Cloud API - Шаблонный API | Документация для разработчиков

WhatsApp Cloud API - Шаблонный API

Экземпляр для программы магистратуры (LLM)
Версия
Создавайте, получайте, обновляйте и удаляйте шаблоны сообщений.
Управляйте предварительно утвержденными форматами сообщений для инициированных компанией переписок.
Включает в себя отправку шаблонов, локализацию и показатели качества.

База

URL
https://graph.facebook.com

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


ПОЛУЧАТЬ /{Версия}/{ИДЕНТИФИКАТОР_ШАБЛОНА}

Справочная информация по конечной точке: Шаблон сообщения WhatsApp

Синтаксис запроса

ПОЛУЧАТЬ /{Версия}/{TEMPLATE_ID}
Попробуйте!
Выберите язык

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{TEMPLATE_ID}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"категория"«МАРКЕТИНГ»,
«компоненты»: [
        {
"формат""ТЕКСТ",
"текст""Осенняя распродажа",
"тип""ЗАГОЛОВОК"
        },
        {
"пример": {
"body_text": [
              [
"ОСЕНЬ 25"
              ]
            ]
          },
"текст"Привет, {{1}}, наша осенняя распродажа началась! Используйте промокод {{2}}Получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!,
"тип""ТЕЛО"
        },
        {
"текст"«Не интересуетесь нашими акциями? Tap Stop Prom»варианты",
"тип"«Нижний колонтитул»
        },
        {
"кнопки": [
            {
"текст"«Прекратите рекламные акции»,
"тип""БЫСТРЫЙ ОТВЕТ"
            }
          ],
"тип""КНОПКИ"
        }
      ],
"идентификатор""920070352646140",
"язык""en_US",
"имя""Акция апреля 2023 года",
«статус»"ОДОБРЕННЫЙ"
    }
  }
}

Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Путь Параметры
Версиянить·необходимый
Выберите язык
TEMPLATE_IDнить·необходимый

Ответы
Выберите код состояния

Справочная информация по конечной точке: Шаблон сообщения WhatsApp
200
Пример ответа

Выберите язык

Выберите код состояния

Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

категориянить

компонентымножество
из
объект
Выберите язык
Показать дочерние атрибуты

компоненты[]объект
Показать дочерние атрибуты

кнопкимассив объектов
Показать дочерние атрибуты

кнопки[]объект
Показать дочерние атрибуты

текстнить

Выберите код состояния


Выберите язык

Выберите код состояния

Аутентификация

Схема
Тип
Расположение
тип
нитьbearerAuth

примеробъект
Показывать дочерние атрибуты

body_textмассив массивов строк
Показать дочерние атрибуты

body_text[]массив строк
Показать дочерние атрибуты

body_text[][]нить

форматнить

текстнить

типнить

идентификаторнить

языкнить

имянить

статуснить
Выберите язык

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{TEMPLATE_ID}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"категория"«МАРКЕТИНГ»,
«компоненты»: [
        {
"формат""ТЕКСТ",
"текст""Осенняя распродажа",
"тип""ЗАГОЛОВОК"
        },
        {
"пример": {
"body_text": [
              [
"ОСЕНЬ 25"
              ]
            ]
          },
"текст"Привет, {{1}}, наша осенняя распродажа началась! Используйте промокод {{2}}Получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!,
"тип""ТЕЛО"
        },
        {
"текст"«Не интересуетесь нашими акциями? Tap Stop Prom»варианты",
"тип"«Нижний колонтитул»
        },
        {
"кнопки": [
            {
"текст"«Прекратите рекламные акции»,
"тип""БЫСТРЫЙ ОТВЕТ"
            }
          ],
"тип""КНОПКИ"
        }
      ],
"идентификатор""920070352646140",
"язык""en_US",
"имя""Акция апреля 2023 года",
«статус»"ОДОБРЕННЫЙ"
    }
  }
}

POST /{Version}/{TEMPLATE_ID}

Справочная информация по конечной точке: Шаблон сообщения WhatsApp

Синтаксис запроса

ПОЧТА /{Версия}/{TEMPLATE_ID}
Попробуйте!
Выберите язык

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{TEMPLATE_ID}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "категория": "МАРКЕТИНГ",
  "компоненты": [
    {
      "формат": "ТЕКСТ",
      "текст": "Осенняя распродажа",
      "type": "HEADER"
    },
    {
      "пример": {
        "body_text": [
          [
            "ОСЕНЬ 25"
          ]
        ]
      },
      "текст": "Привет, {{1}}, наша осенняя распродажа началась! Используйте Промокод {{2}} Получите дополнительную скидку 25% на каждый заказ выше 350 долларов!"
      "type": "BODY"
    },
    {
      "текст": "Вас не интересуют наши предложения?" «Нажмите, чтобы остановить акции»
      "type": "FOOTTER"
    },
    {
      "кнопки": [
        {
          "текст": "Прекратить рекламные акции",
          "type": "QUICK_REPLY"
        }
      ],
      "type": "BUTTONS"
    }
  ],
  "language": "en_US",
  "name": "2023_april_promo"
}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"успех"истинный
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Версиянить·необходимый
TEMPLATE_IDнить·необходимый
Текст запросаНеобязательный
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

категориянить

компонентымассив объектов
Показать дочерние атрибуты

компоненты[]объект
Показать дочерние атрибуты

кнопкимассив объектов
Показать дочерние атрибуты

кнопки[]объект
Показать дочерние атрибуты

текстнить

типнить

примеробъект
Показать дочерние атрибуты

body_textмассив массивов строк
Показать дочерние атрибуты

body_text[]массив строк
Показать дочерние атрибуты

body_text[][]нить

форматнить

текстнить

типнить

языкнить

имянить
Ответы
Справочная информация по конечной точке: Шаблон сообщения WhatsApp
200
Пример ответа
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

успехлогический
Выберите язык

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{TEMPLATE_ID}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "категория": "МАРКЕТИНГ",
  "компоненты": [
    {
      "формат": "ТЕКСТ",
      "текст": "Осенняя распродажа",
      "type": "HEADER"
    },
    {
      "пример": {
        "body_text": [
          [
            "ОСЕНЬ 25"
          ]
        ]
      },
      "текст": "Привет, {{1}}, наша осенняя распродажа началась! Используйте Промокод {{2}} Получите дополнительную скидку 25% на каждый заказ выше 350 долларов!"
      "type": "BODY"
    },
    {
      "текст": "Вас не интересуют наши предложения?" «Нажмите, чтобы остановить акции»
      "type": "FOOTTER"
    },
    {
      "кнопки": [
        {
          "текст": "Прекратить рекламные акции",
          "type": "QUICK_REPLY"
        }
      ],
      "type": "BUTTONS"
    }
  ],
  "language": "en_US",
  "name": "2023_april_promo"
}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"успех"истинный
    }
  }
}

GET /{Version}/{WABA-ID}/message_templates

Синтаксис запроса

ПОЛУЧАТЬ /{Версия}/{WABA-ID}/message_templates
Попробуйте!
Выберите язык

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"данные": [
        {
"категория"«МАРКЕТИНГ»,
«компоненты»: [
            {
"формат""ТЕКСТ",
"текст""Привет, мир",
"тип""ЗАГОЛОВОК"
            },
            {
"текст"«Добро пожаловать и поздравляем!! Это сообщение демонстрирует вашу способность отправлять сообщения уведомление от платформы WhatsApp Business Облачный API. Спасибо, что уделили время тестированию с нами.",
"тип""ТЕЛО"
            },
            {
"текст"Команда разработчиков WhatsApp Business API,
"тип"«Нижний колонтитул»
            }
          ],
"идентификатор""1192339204654487",
"язык""en_US",
"имя""Привет, мир",
"предыдущая_категория""ОБНОВЛЕНИЕ УЧЕТНОЙ ЗАПИСИ",
«статус»"ОДОБРЕННЫЙ"
        },
        {
"категория"«МАРКЕТИНГ»,
«компоненты»: [
            {
"формат""ТЕКСТ",
"текст""Осенняя распродажа",
"тип""ЗАГОЛОВОК"
            },
            {
"пример": {
"body_text": [
                  [
"ОСЕНЬ 25"
                  ]
                ]
              },
"текст"Привет, {{1}}, наша осенняя распродажа началась! Используйте промокод {{2}}Получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!,
"тип""ТЕЛО"
            },
            {
"текст"«Не интересуетесь нашими акциями? Tap Stop Prom»варианты",
"тип"«Нижний колонтитул»
            },
            {
"кнопки": [
                {
"текст"«Прекратите рекламные акции»,
"тип""БЫСТРЫЙ ОТВЕТ"
                }
              ],
"тип""КНОПКИ"
            }
          ],
"идентификатор""920070352646140",
"язык""en_US",
"имя""Акция апреля 2023 года",
«статус»"ОДОБРЕННЫЙ"
        }
      ],
"пейджинг": {
"курсоры": {
"после""MjQZD",
"до""МАЗДЗД"
        }
      }
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Версиянить·необходимый
WABA-IDнить·необходимый
Параметры запроса
имянить
Ответы
200
Пример ответа / Пример ответа
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

данныемассив объектов
Показать дочерние атрибуты

данные[]объект
Показать дочерние атрибуты

категориянить

компонентымассив объектов
Показать дочерние атрибуты

компоненты[]объект
Показать дочерние атрибуты

кнопкимассив объектов
Показать дочерние атрибуты

кнопки[]объект
Показать дочерние атрибуты

текстнить

типнить

примеробъект
Показать дочерние атрибуты

body_textмассив массивов строк
Показать дочерние атрибуты

body_text[]массив строк
Показать дочерние атрибуты

body_text[][]нить

форматнить

текстнить

типнить

идентификаторнить

языкнить

имянить

статуснить

пейджингобъект
Показать дочерние атрибуты

курсорыобъект
Показать дочерние атрибуты

посленить

донить
Выберите язык

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"данные": [
        {
"категория"«МАРКЕТИНГ»,
«компоненты»: [
            {
"формат""ТЕКСТ",
"текст""Привет, мир",
"тип""ЗАГОЛОВОК"
            },
            {
"текст"«Добро пожаловать и поздравляем!! Это сообщение демонстрирует вашу способность отправлять сообщения уведомление от платформы WhatsApp Business Облачный API. Спасибо, что уделили время тестированию с нами.",
"тип""ТЕЛО"
            },
            {
"текст"Команда разработчиков WhatsApp Business API,
"тип"«Нижний колонтитул»
            }
          ],
"идентификатор""1192339204654487",
"язык""en_US",
"имя""Привет, мир",
"предыдущая_категория""ОБНОВЛЕНИЕ УЧЕТНОЙ ЗАПИСИ",
«статус»"ОДОБРЕННЫЙ"
        },
        {
"категория"«МАРКЕТИНГ»,
«компоненты»: [
            {
"формат""ТЕКСТ",
"текст""Осенняя распродажа",
"тип""ЗАГОЛОВОК"
            },
            {
"пример": {
"body_text": [
                  [
"ОСЕНЬ 25"
                  ]
                ]
              },
"текст"Привет, {{1}}, наша осенняя распродажа началась! Используйте промокод {{2}}Получите дополнительную скидку 25% на каждый заказ свыше 350 долларов!,
"тип""ТЕЛО"
            },
            {
"текст"«Не интересуетесь нашими акциями? Tap Stop Prom»варианты",
"тип"«Нижний колонтитул»
            },
            {
"кнопки": [
                {
"текст"«Прекратите рекламные акции»,
"тип""БЫСТРЫЙ ОТВЕТ"
                }
              ],
"тип""КНОПКИ"
            }
          ],
"идентификатор""920070352646140",
"язык""en_US",
"имя""Акция апреля 2023 года",
«статус»"ОДОБРЕННЫЙ"
        }
      ],
"пейджинг": {
"курсоры": {
"после""MjQZD",
"до""МАЗДЗД"
        }
      }
    }
  }
}

POST /{Version}/{WABA-ID}/message_templates

Синтаксис запроса

ПОЧТА /{Версия}/{WABA-ID}/message_templates
Попробуйте!
Выберите язык

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "категория": "МАРКЕТИНГ",
  "компоненты": [
    {
      "текст": "Ознакомьтесь с этим новым предложением",
      "type": "body"
    },
    {
      "кнопки": [
        {
          "flow_action": "navigate",
          "flow_json": "{\"version\":\"5.0\",\"screens\":[{\"id\":\"WELCOME_SCREEN\",\"layout\":{\"type\":\"SingleColumnLayout\",\"children\":[{\"type\":\"TextHeading\",\"text\":\"Hello World\"},{\"type\":\"Нижний колонтитул\",\"метка\":\"Завершить\",\"при нажатии-действие\":{\"имя\":\"завершено\",\"полезная нагрузка\":{}}}]},\"title\":\"Добро пожаловать\",\"terminal\":true,\"успех\":true,\"data\":{}}]}",
          "navigate_screen": "WELCOME_SCREEN",
          "текст": "Ознакомьтесь с этим предложением!",
          "type": "FLOW"
        }
      ],
      "type": "BUTTONS"
    }
  ],
  "language": "en_US",
  "имя": "<TEMPLATE_NAME> "
}'
Выберите код состояния

{
"Создание шаблона сообщения потока с помощью JSON-файла потока": {
"ценить": {
"категория"«МАРКЕТИНГ»,
"идентификатор""шаблон-1",
«статус»"В ОЖИДАНИИ"
    }
  },
"Создать сообщение шаблона потока по идентификатору": {
"ценить": {
"категория"«МАРКЕТИНГ»,
"идентификатор""шаблон-1",
«статус»"В ОЖИДАНИИ"
    }
  },
"Создать сообщение шаблона потока по имени": {
"ценить": {
"категория"«МАРКЕТИНГ»,
"идентификатор""шаблон-1",
«статус»"В ОЖИДАНИИ"
    }
  },
«Пример ответа»: {
"ценить": {
"категория""Утилиты",
"идентификатор""1689556908129832",
«статус»"В ОЖИДАНИИ"
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Версиянить·необходимый
WABA-IDнить·необходимый
Текст запросаНеобязательный
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

категориянить

компонентымассив объектов
Показать дочерние атрибуты

компоненты[]объект
Показать дочерние атрибуты

кнопкимассив объектов
Показать дочерние атрибуты

кнопки[]объект
Показать дочерние атрибуты

flow_actionнить

flow_idнить

navigate_screenнить

текстнить

типнить

текстнить

типнить

языкнить

имянить
Ответы
200
Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Пример ответа / Создать сообщение шаблона потока по имени / Создать сообщение шаблона потока по JSON потока / Создать сообщение шаблона потока по ID
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

категориянить

идентификаторнить

статуснить
Выберите язык

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "категория": "МАРКЕТИНГ",
  "компоненты": [
    {
      "текст": "Ознакомьтесь с этим новым предложением",
      "type": "body"
    },
    {
      "кнопки": [
        {
          "flow_action": "navigate",
          "flow_json": "{\"version\":\"5.0\",\"screens\":[{\"id\":\"WELCOME_SCREEN\",\"layout\":{\"type\":\"SingleColumnLayout\",\"children\":[{\"type\":\"TextHeading\",\"text\":\"Hello World\"},{\"type\":\"Нижний колонтитул\",\"метка\":\"Завершить\",\"при нажатии-действие\":{\"имя\":\"завершено\",\"полезная нагрузка\":{}}}]},\"title\":\"Добро пожаловать\",\"terminal\":true,\"успех\":true,\"data\":{}}]}",
          "navigate_screen": "WELCOME_SCREEN",
          "текст": "Ознакомьтесь с этим предложением!",
          "type": "FLOW"
        }
      ],
      "type": "BUTTONS"
    }
  ],
  "language": "en_US",
  "имя": "<TEMPLATE_NAME> "
}'
Выберите код состояния

{
"Создание шаблона сообщения потока с помощью JSON-файла потока": {
"ценить": {
"категория"«МАРКЕТИНГ»,
"идентификатор""шаблон-1",
«статус»"В ОЖИДАНИИ"
    }
  },
"Создать сообщение шаблона потока по идентификатору": {
"ценить": {
"категория"«МАРКЕТИНГ»,
"идентификатор""шаблон-1",
«статус»"В ОЖИДАНИИ"
    }
  },
"Создать сообщение шаблона потока по имени": {
"ценить": {
"категория"«МАРКЕТИНГ»,
"идентификатор""шаблон-1",
«статус»"В ОЖИДАНИИ"
    }
  },
«Пример ответа»: {
"ценить": {
"категория""Утилиты",
"идентификатор""1689556908129832",
«статус»"В ОЖИДАНИИ"
    }
  }
}

Удалить /{Версия}/{WABA-ID}/message_templates

Синтаксис запроса

УДАЛИТЬ /{Версия}/{WABA-ID}/message_templates
Попробуйте!
Выберите язык

локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"успех"истинный
    }
  }
}
Параметры заголовка
Агент пользователянить
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Авторизациянить·необходимый
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Версиянить·необходимый
WABA-IDнить·необходимый
Параметры запроса
имянить
hsm_idнить
Идентификатор шаблона
Ответы
200
Пример ответа / Пример ответа
Тип контента: приложение/json
Схема: объект
Показать дочерние атрибуты

успехлогический
Выберите язык

локон--запрос УДАЛИТЬ \
--url'https://graph.facebook.com/{Version}/{WABA-ID}/message_templates' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'
Выберите код состояния

{
«Пример ответа»: {
"ценить": {
"успех"истинный
    }
  }
}

Аутентификация

Схема
Тип
Расположение
bearerAuth
HTTP Bearer
Заголовок: Авторизация

Примеры использования

bearerAuth:
Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:
bearerAuth