メインコンテンツへスキップ
GET
メッセージングプラットフォームのメッセージまたは会話を取得します。 各ソーシャルネットワークによって取得時間が異なります。FacebookとInstagramでは、メッセージはAyrshareを介してリアルタイムで利用可能です。X/Twitterでは、新しいメッセージの更新を確認するのに最大3分の遅延があります。X/Twitterメッセージへのリアルタイムアクセスが必要な場合、Enterprise Planの詳細についてはサポートまでお問い合わせください。
レスポンスキャッシュ: パフォーマンスを最適化するため、GET messagesレスポンスはキャッシュされます。FacebookInstagramでは、レスポンスは60秒間キャッシュされます。X/Twitterでは、ポーリングをより適切にサポートするためレスポンスは15秒間キャッシュされます。レスポンスのlastUpdatednextUpdateフィールドは、データが最後に取得された時期と、新しいデータが利用可能になる時期を示します。
FacebookおよびInstagramの初回メッセージ履歴取得は、最新20件のメッセージに制限されます。詳細については、FacebookおよびInstagramのメッセージ履歴取得セクションをご覧ください。

ヘッダーパラメータ

パスパラメータ

platform
string
必須
メッセージを取得するプラットフォーム: facebookinstagramtwitter

クエリパラメータ

status
string
デフォルト:"active"
必須
アクティブな会話またはアーカイブされた会話を返します。値: activeまたはarchived
conversationId
string
特定の会話のみを返します。
conversationsOnly
boolean
デフォルト:false
すべての会話を返します。trueの場合、conversationIdフィールドは無視されます。
limit
integer
X/Twitterのみ。 リクエストあたりに返されるメッセージの数を制限します(1〜100)。完全な履歴同期なしで効率的なポーリングを可能にします。ページネーションにはnextと共に使用します。省略された場合、デフォルトの動作(完全なメッセージ取得)が使用されます。
next
string
X/Twitterのみ。 前のリクエストのmeta.pagination.nextフィールドから返された暗号化されたページネーションカーソル。次のページの結果を取得するためにlimitと共に使用します。