Отправить Карусель
Вы можете отправлять карточки товаров через Карусель следующими способами:
Шаблонные сообщения (Template messages): не требуют наличия 24-часового окна обслуживания клиента между вами и получателем для отправки сообщения. Используйте метод sendTemplate.
Произвольные сообщения (Free-form messages): могут быть отправлены пользователю только при наличии открытого окна обслуживания клиента между вами и пользователем. Используйте метод sendCarousel.
Структура сообщения в /sendCarousel во многом аналогична отправке шаблона. Однако в данном случае необходимо явно указывать все элементы, которые при работе с шаблонами создаются заранее. Это связано с тем, что сообщение отправляется без использования шаблона.
В шаблоне /sendCarousel для отправки Карусели Каталога могут быть либо 1 кнопка URL либо одна или несколько кнопок быстрого ответа.
JWT tokentoken<token>- body
body?stringТекст над каруселью. Необязателен. Если не передан и в params есть компонент body, текст будет взят из params.
params?array<>Альтернатива cards. Структура, как в sendTemplate params. Должен быть компонент CAROUSEL и его карточки.
Структура:
- элемент params[] с type CAROUSEL и cards (2..10)
- cards[] элемент:
- card_index: номер
- components[] элементы:
- header: parameters[0] с type image/video/product
- image: {"image": {"link": "https://..."}}
- video: {"video": {"link": "https://..."}}
- product: {"product": {"catalog_id": "...", "product_retailer_id": "..."}}
- body: parameters[] c {"type": "text", "text": "..."}
- button: sub_type url или quick_reply
- url: parameters {"text": "Button", "url": "https://..."}
- quick_reply: parameters[] из {"id": "...", "text": "..."}
- header: parameters[0] с type image/video/product
- cards[] элемент:
- Опционально элемент params[] с type body для текста над каруселью.
cards?array<>Карточки карусели (2–10). Свободная форма: у каждой карточки type = cta_url или product, header image/video и action (URL или quick reply). Альтернатива params.
2 <= items <= 10quotedMsgId?stringИдентификатор цитируемого сообщения (Cloud API)
chatId?stringОбязателен, если не указаны phone и bsuid
ID чата из списка сообщений. Примеры: [email protected], RU.1504711984690866@lid, username@username или [email protected] (группа). Используется вместо параметра phone.
phone?stringОбязателен, если не указаны chatId и bsuid
Идентификатор получателя. Принимает номер телефона с кодом страны или BSUID, например RU.1504711984690866.
Для chatId используйте полные ID чатов: [email protected], bsuid@lid, username@username или [email protected].
bsuid?stringНеобязательная альтернатива phone/chatId
BSUID получателя без суффикса @lid. Пример: RU.1504711984690866.
Server response example
application/json- response
sent?booleanid?stringУникальный идентификатор сообщения
message?stringУведомление о статусе отправки сообщения
description?stringКомментарий к результату отправки
curl -X POST 'https://api.1msg.io/123/sendCarousel' \ -H 'Content-Type: application/json' \ -d '{ "phone": "77474016132", "params": [ { "type": "CAROUSEL", "cards": [ { "card_index": 0, "components": [ { "type": "header", "parameters": [ { "type": "video", "video": { "link": "https://sample-videos.com/video321/mp4/720/big_buck_bunny_720p_1mb.mp4" } } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "Video Card 1" } ] }, { "type": "button", "sub_type": "quick_reply", "parameters": [ { "id": "learn-1", "text": "Learn more" }, { "id": "fav-1", "text": "Fav" } ] } ] }, { "card_index": 1, "components": [ { "type": "header", "parameters": [ { "type": "video", "video": { "link": "https://sample-videos.com/video321/mp4/720/big_buck_bunny_720p_1mb.mp4" } } ] }, { "type": "body", "parameters": [ { "type": "text", "text": "Video Card 2" } ] }, { "type": "button", "sub_type": "quick_reply", "parameters": [ { "id": "learn-2", "text": "Learn more" }, { "id": "fav-2", "text": "Fav" } ] } ] } ] } ]}'{ "sent": true, "id": "gBGGeRhGZTEfAgkJCh2wAz4ZH-8", "message": "Sent to [email protected]", "description": "Message has been sent to the provider"}