AgentsListTelephonyCallsOptionalParams interface

省略可能なパラメーター。

Extends

プロパティ

after

改ページ位置付けに使用するカーソル。 after は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト取得要求を行い、obj_foo で終わる 100 個のオブジェクトを受け取った場合、後続の呼び出しに after=obj_foo を含めて、リストの次のページをフェッチできます。

before

改ページ位置付けに使用するカーソル。 before は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。

foundryFeatures

プレビュー操作を使用したり、永続化されたプレビュー リソースを変更したりする場合は、機能フラグのオプトインが必要です。

limit

返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。

order

オブジェクトの created_at タイムスタンプによる並べ替え順序。 ascは昇順用、descは降順用です。

provider

通話をプロバイダーごとにフィルタリングします。

startedAfter

このUnixタイムスタンプ以降に開始された呼び出しも数秒単位で含まれます。

startedBefore

このUnixタイムスタンプから開始された通話も数秒単位で含まれます。

status

ライフサイクルステータスで通話をフィルタリングします。

継承されたプロパティ

abortSignal

要求を中止するために使用できるシグナル。

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

tracingOptions

トレースが有効な場合に使用されるオプション。

プロパティの詳細

after

改ページ位置付けに使用するカーソル。 after は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト取得要求を行い、obj_foo で終わる 100 個のオブジェクトを受け取った場合、後続の呼び出しに after=obj_foo を含めて、リストの次のページをフェッチできます。

after?: string

プロパティ値

string

before

改ページ位置付けに使用するカーソル。 before は、リスト内の場所を定義するオブジェクト ID です。 たとえば、リスト要求を行い、obj_fooで終わる 100 個のオブジェクトを受信した場合、後続の呼び出しには、リストの前のページをフェッチするために before=obj_foo を含めることができます。

before?: string

プロパティ値

string

foundryFeatures

プレビュー操作を使用したり、永続化されたプレビュー リソースを変更したりする場合は、機能フラグのオプトインが必要です。

foundryFeatures?: "VoiceAgents=V1Preview"

プロパティ値

"VoiceAgents=V1Preview"

limit

返されるオブジェクトの数の制限。 制限の範囲は 1 から 100 で、既定値は 20 です。

limit?: number

プロパティ値

number

order

オブジェクトの created_at タイムスタンプによる並べ替え順序。 ascは昇順用、descは降順用です。

order?: PageOrder

プロパティ値

provider

通話をプロバイダーごとにフィルタリングします。

provider?: TelephonyProvider

プロパティ値

startedAfter

このUnixタイムスタンプ以降に開始された呼び出しも数秒単位で含まれます。

startedAfter?: Date

プロパティ値

Date

startedBefore

このUnixタイムスタンプから開始された通話も数秒単位で含まれます。

startedBefore?: Date

プロパティ値

Date

status

ライフサイクルステータスで通話をフィルタリングします。

status?: TelephonyCallStatus

プロパティ値

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

OperationOptions.abortSignal から継承された

onResponse

要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。

onResponse?: RawResponseCallback

プロパティ値

OperationOptions.onResponse から継承された

requestOptions

この操作の HTTP 要求を作成および送信するときに使用されるオプション。

requestOptions?: OperationRequestOptions

プロパティ値

OperationOptions.requestOptions から継承された

tracingOptions

トレースが有効な場合に使用されるオプション。

tracingOptions?: OperationTracingOptions

プロパティ値

OperationOptions.tracingOptions から継承された