Skip to main content
GET
メッセージングプラットフォームのメッセージまたは会話を取得します。 各ソーシャルネットワークによって取得時間が異なります。Facebook、Instagram、および WhatsApp では、メッセージは Ayrshare を介してリアルタイムで利用可能です。X/Twitter では、新しいメッセージの更新を確認するのに最大 3 分の遅延があります。X/Twitter メッセージへのリアルタイムアクセスが必要な場合、Enterprise Plan の詳細についてはサポートまでお問い合わせください。
レスポンスキャッシュ: FacebookとInstagramでは、レスポンスは60秒間キャッシュされます。X/Twitterでは、ポーリングをより適切にサポートするためレスポンスは15秒間キャッシュされます。WhatsApp は Meta の webhook 経由ですでに受信済みのメッセージを読み取るため、新しく受信したメッセージは Ayrshare がその webhook を処理し次第すぐに表示されます。レスポンスには引き続き lastUpdated および nextUpdate メタデータが含まれます。
FacebookおよびInstagramの初回メッセージ履歴取得は、最新20件のメッセージに制限されます。詳細については、FacebookおよびInstagramのメッセージ履歴取得セクションをご覧ください。
WhatsApp の会話は、相手の電話番号(数字のみ、先頭の + を含まない E.164 形式)で識別されます。保存されたアウトバウンドメッセージには、sent、delivered、read、または failed のいずれかの status 値が含まれる場合があります。
メッセージ送信を通じて送信された WhatsApp メッセージは、現在 Get Messages の履歴には追加されません。webhook 経由で受信した WhatsApp メッセージはここに保存され、返されます。

ヘッダーパラメータ

パスパラメータ

string
必須
メッセージを取得するプラットフォーム: facebook、instagram、twitter、whatsapp

クエリパラメータ

string
デフォルト:"active"
必須
アクティブな会話またはアーカイブされた会話を返します。値: activeまたはarchived。
string
特定の会話のみを返します。
string
一方向のメッセージのみを返します。値: sent または received。省略すると両方を返します。
boolean
デフォルト:false
メッセージではなく会話を返します。会話を1ページ返します。残りは meta.pagination.next をたどってください。true の場合、conversationId は無視されます。
conversationsOnly=true の場合、会話の詳細は converstationsDetails で返されます。このスペルは現在の API レスポンスの一部です。
integer
メッセージおよび会話一覧のページサイズ。1〜100の整数で、既定値と最大値はいずれも 100 です。X/Twitter では、limit はどのメッセージ群を読むかも決めます。省略すると保存済みメッセージをページングし、これは他のすべてのプラットフォームと同じ動作で、status、action、conversationsOnly が適用されるのはこの場合だけです。指定すると代わりに X 独自のカーソルで X のライブタイムラインをページングし、これら3つのフィルターはいずれも適用されません。この選択は最初のリクエストでのみ行われます。カーソルをたどり始めたあとはカーソルが決めます。保存済みメッセージのカーソルは 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> を送信します。パラメータは cursor ではなく next です。全体を通して同じ Profile-Key とクエリフィルターを維持してください。 停止するタイミングは、結果の件数ではなく meta.pagination.hasMore で判断してください。各リクエストは履歴の限られた範囲をスキャンするため、フィルター付きのリクエストは limit より少ない結果を返したり、継続カーソル付きの空のページを返したりすることがあります。保存履歴内のメッセージは新しい順に並び、同順位はドキュメント ID で解決されます。会話一覧はドキュメント ID 順に並びます。ページングは固定されたスナップショットではありません: 最初のページからやり直すと新しいメッセージが現れ、会話のステータスが変わるとフィルター後の結果も変わることがあります。 既存のメッセージフィールドと converstationsDetails のスペルは変更されていません。これまで 1 回のリクエストで完全な一覧(メッセージでも会話でも、どのプラットフォームでも)を取得できることを想定していた連携は、継続カーソルに従う必要があります。limit を 100 より大きくすることはサポートされていません。