Skip to main content
GET
获取某个消息平台的消息或会话。 不同社交网络的检索时间有所不同。在 Facebook、Instagram 和 WhatsApp 上,消息可通过 Ayrshare 实时获得。在 X/Twitter 上,查看新消息更新最多有 3 分钟延迟。若你需要实时访问 X/Twitter 消息,请联系支持团队了解 Enterprise Plan 的详情。
**响应缓存:**对于 FacebookInstagram,响应缓存 60 秒。对于 X/Twitter,响应缓存 15 秒,以更好地支持轮询。WhatsApp 读取的是已通过 Meta webhook 接收到的消息,因此新收到的消息会在 Ayrshare 处理其 webhook 后立即可见。响应中仍会包含 lastUpdatednextUpdate 元数据。
对于 Facebook 和 Instagram,首次消息历史检索仅限于最近 20 条消息。详情请参阅 Facebook 和 Instagram 的消息历史检索 部分。
WhatsApp 会话通过通信对象的电话号码标识(仅数字,采用 E.164 且不含前导 +)。已存储的出站消息可能包含 status 字段,其值为 sentdeliveredreadfailed。这些状态在 Ayrshare 内部被跟踪,但 statusSentstatusDeliveredstatusReadstatusFailed 事件不会包含在 API 响应中。
通过 Send Message 发送的 WhatsApp 消息目前不会被加入 Get Messages 历史。通过 webhook 收到的 WhatsApp 入站消息会被存储并在此返回。

Header Parameters

Path Parameters

string
必填
用于获取消息的平台:facebookinstagramtwitterwhatsapp

Query Parameters

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 一起使用以获取下一页结果。