Skip to main content
GET
取得訊息平台上的訊息或對話。 各社群網路的擷取時效不同。在 Facebook、Instagram 與 WhatsApp 上,訊息可透過 Ayrshare 即時取得。在 X/Twitter 上,看到新訊息更新最多會有 3 分鐘的延遲。若您需要 X/Twitter 訊息的即時存取,請聯絡我們了解 Enterprise Plan 的更多資訊。
回應快取: 對於 FacebookInstagram,回應會被快取 60 秒。對於 X/Twitter,回應會被快取 15 秒,以便更好地支援輪詢 (polling)。WhatsApp 會讀取已透過 Meta webhook 收到的訊息,因此新收到的訊息只要 Ayrshare 完成處理其 webhook 即可顯示。回應仍會包含 lastUpdatednextUpdate 中繼資料。
Facebook 與 Instagram 的初始訊息歷程擷取上限為 最後 20 則訊息。詳細資訊請參閱 Facebook 與 Instagram 的訊息歷程擷取章節。
WhatsApp 對話以對方的電話號碼識別(僅數字,E.164 格式且不含前導 +)。已儲存的外送訊息可能包含 status 值為 sentdeliveredreadfailed
目前透過 Send Message 傳送的 WhatsApp 訊息不會加入 Get Messages 歷程中。透過 webhook 收到的傳入 WhatsApp 訊息則會被儲存並在此回傳。

標頭參數

路徑參數

string
必填
用來取得訊息的平台:facebookinstagramtwitterwhatsapp

查詢參數

string
默认值:"active"
必填
回傳活躍或已封存的對話。值:activearchived
string
只回傳特定對話。
boolean
默认值:false
回傳所有對話。若為 true,則忽略 conversationId 欄位。
conversationsOnly=true 時,對話詳細資訊會回傳於 converstationsDetails。這個拼寫是目前 API 回應的一部分。
integer
僅 X/Twitter。 限制每次請求回傳的訊息數 (1–100)。可有效輪詢而不需完整同步歷史資料。與 next 搭配使用以進行分頁。若省略,則使用預設行為(完整訊息擷取)。
string
僅 X/Twitter。 從前一次請求 meta.pagination.next 欄位取得的加密分頁游標。與 limit 搭配使用以擷取下一頁結果。