ドキュメント

サポート

Vivox Safe Text

Vivox Safe Text

エビデンスレポート API

Use the Evidence report API to retrieve select messages from a channel or direct message conversation.
読み終わるまでの所要時間 1 分最終更新 24日前
エビデンスレポート API を使用して、サーバーから選択したメッセージを取得できます。 以下は、テキストエビデンス管理に対するリクエストの形式を設定する方法の例です。 
curl "https://services.api.unity.com/vivox/text-evidence-management/v1/organizations/:yourOrgID/projects/:yourProjectID/text-evidence-report?target_uri=add-your-vivox-channel-uri" -u service-acct-username:service-account-password
target_uri
パラメーターは必須です。これは、Vivox チャンネル ID、またはダイレクトメッセージリクエストのユーザー ID にマップされます。ダイレクトメッセージリクエストでは 
target_uri
と 
sender_uri
が必須であり、これらの値はいずれもユーザー URI です。ダイレクトメッセージリクエストでは 2 人のユーザー間の会話全体が返されるため、
target_uri
と 
sender_uri
の順序はどちらでもかまいません。 このリクエストは、オプションで以下のクエリパラメーターを受け取ります。

パラメーター

説明

sender_uri
Vivox ユーザー URI。メッセージの送信者別にレスポンスをフィルター処理するために使用します。この値は、ダイレクトメッセージリクエストでは必須です。
target_uri
テキストメッセージを受信しているエンティティ（チャンネルまたはユーザー）の URI。
start_ts
この Unix 時刻形式のタイムスタンプ以降のすべてのメッセージがレポートされます。
end_ts
この Unix 時刻形式のタイムスタンプ以前のすべてのメッセージがレポートされます。
as_file
レスポンスをファイルとして返すかを示す true または false 値。
file_type
as_file が trueの場合は、ファイルの形式を指定します。デフォルト値は CSV です。
num_messages
返すメッセージの数。この数値が指定されていない場合は、リクエストクエリあたり最大 500 件のメッセージが返されます。
存在するメッセージの数にかかわらず、クエリあたり最大 500 件のメッセージ (message_id) が返されます。500 件を超えるメッセージが必要な場合は、結果がそれ以上なくなるまで新しいクエリを送信し続けて後続のメッセージ結果を取得できます。 メッセージ結果の次のページを取得するには、
next
値 (結果内で 
start_ts
パラメーターとして提供) を次のクエリで使用します。
next
値が null の場合は、返すべきメッセージがそれ以上ないことを示します。