Skip to main content
GET
Отримайте повідомлення або розмови для платформи обміну повідомленнями. Час отримання відрізняється для кожної соціальної мережі. У Facebook, Instagram та WhatsApp повідомлення доступні через Ayrshare у режимі реального часу. У X/Twitter є затримка до 3 хвилин перед появою нових оновлень повідомлень. Будь ласка, зверніться до служби підтримки, щоб дізнатися більше про Enterprise-план, якщо вам потрібен доступ до повідомлень X/Twitter у режимі реального часу.
Кешування відповіді: для Facebook та Instagram відповіді кешуються 60 секунд. Для X/Twitter відповіді кешуються 15 секунд для кращої підтримки опитувань. WhatsApp читає повідомлення, вже отримані через webhooks Meta, тож нове отримане повідомлення може з’явитися одразу, щойно Ayrshare обробить свій webhook. Відповідь усе одно містить метадані lastUpdated та nextUpdate.
Початкове отримання історії повідомлень для Facebook та Instagram обмежене останніми 20 повідомленнями. Будь ласка, ознайомтеся з розділом Отримання історії повідомлень для Facebook та Instagram для отримання додаткової інформації.
Розмови WhatsApp ідентифікуються за номером телефону кореспондента (лише цифри, E.164 без провідного +). Збережене вихідне повідомлення може містити значення status — sent, delivered, read або failed. Внутрішньо Ayrshare відстежує окремі поля statusSent, statusDelivered, statusRead та statusFailed, але вони виключені з відповіді API.
Повідомлення WhatsApp, надіслані через Send Message, наразі не додаються до історії Get Messages. Вхідні повідомлення WhatsApp, отримані через webhooks, зберігаються та повертаються тут.

Параметри заголовка

Параметри шляху

string
обов'язково
Платформа, з якої отримати повідомлення: facebook, instagram, twitter, whatsapp

Параметри запиту

string
за замовчуванням:"active"
обов'язково
Повернути активні або архівовані розмови. Значення: active або archived.
string
Повернути лише конкретну розмову.
string
Повертати лише повідомлення одного напрямку. Значення: sent або received. Не вказуйте, щоб отримати обидва.
boolean
за замовчуванням:false
Повертає розмови замість повідомлень. Повертає одну сторінку розмов — для решти йдіть за meta.pagination.next. Якщо true, conversationId ігнорується.
Коли conversationsOnly=true, деталі розмов повертаються в converstationsDetails. Це написання є частиною поточної відповіді API.
integer
Розмір сторінки для повідомлень і для списків розмов: ціле число від 1 до 100, типове й максимальне значення — 100.У X/Twitter limit також визначає, який набір повідомлень ви читаєте. Не передавайте його, щоб гортати збережені повідомлення — так працюють усі інші платформи, і саме тут застосовуються status, action і conversationsOnly. Передайте його, щоб замість цього гортати живу хронологію X через власний курсор X, який не застосовує жодного з цих трьох фільтрів.Цей вибір робить лише перший запит. Коли ви вже йдете за курсором, вирішує курсор: курсор збережених повідомлень і далі повертає збережені повідомлення, навіть якщо ви передасте limit, а курсор X і далі повертає живу хронологію, навіть якщо ви його не передасте. Перемкнутися між ними посеред гортання не можна.
string
Непрозорий курсор із meta.pagination.next. Передайте його як next із тим самим профілем, платформою та фільтрами. Продовжуйте, доки meta.pagination.hasMore дорівнює true, навіть якщо відфільтрована сторінка повернулася короткою або порожньою. У наступних запитах limit можна не вказувати (типово 100); у X/Twitter курсор уже фіксує, з якого набору він походить, тож передавання або пропуск limit не перемкне вас на інший.

Отримання наступної сторінки

Почніть із GET /api/messages/instagram?limit=100. Щоб продовжити, закодуйте отримане значення meta.pagination.next для URL і надішліть GET /api/messages/instagram?limit=100&next=<opaque cursor>. Параметр називається next, а не cursor. Зберігайте той самий Profile-Key і фільтри запиту впродовж усієї пагінації. Щоб вирішити, коли зупинитися, перевіряйте meta.pagination.hasMore, а не кількість результатів. Відфільтрований запит може повернути менше за limit результатів або порожню сторінку з продовженням, оскільки кожен запит сканує обмежену частину історії. Повідомлення у збереженій історії впорядковані від найновіших до найстаріших, а рівні позиції розв’язуються за ID документа. Списки розмов упорядковані за ID документа. Пагінація — це не заморожений знімок: нові повідомлення з’являються, коли ви перезапускаєте з першої сторінки, а зміна статусів розмов може змінити відфільтровані результати. Наявні поля повідомлень і написання converstationsDetails не змінилися. Інтеграції, які раніше очікували повний список з одного запиту — чи то повідомлень, чи розмов, на будь-якій платформі — мають слідувати за курсором продовження; збільшення limit понад 100 не підтримується.