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

標頭參數

路徑參數

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 的游標即使你省略 limit 也會繼續回傳即時時間軸。分頁過程中無法在兩者之間切換。
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 以上。