電話番号ページを一覧表示

電話番号のページを取得

ヘッダー

xi-api-keystringオプション

クエリパラメータ

page_sizeintegerオプション1-1000デフォルト値 100

1ページあたりの電話番号数

searchstring or nullオプション<=100 characters

電話番号ID、ラベル、または電話番号でフィルターします。電話番号IDは完全一致する必要があります。ラベルと電話番号は大文字と小文字を区別しない部分一致です。

labelstring or nullオプション<=100 characters

ラベルでフィルターします。大文字と小文字を区別しない部分一致です。

phone_numberstring or nullオプション<=100 characters

電話番号でフィルター

providerenum or nullオプション

電話プロバイダーでフィルタリングします

許可された値:
supports_outboundboolean or nullオプション

電話番号が発信できるかどうかでフィルタリングします

agent_idstring or nullオプション

割り当て済みエージェントIDでフィルター

branch_idstring or nullオプション

割り当て済みブランチIDでフィルター

sort_byenum or nullオプション

結果の並べ替えに使用するフィールド

許可された値:
sort_directionenumオプション

結果の並べ替え方向

許可された値:
cursorstring or nullオプション

次のページを取得するために使用します。カーソルはレスポンスで返されます。

レスポンス

成功レスポンス。

phone_numberslist of objects

このページの電話番号

next_cursorstring or nullオプション

この値をcursorとして渡すと、次のページを取得できます。結果がこれ以上ない場合はNullです。

has_morebooleanオプションデフォルト値 false

利用可能な結果がさらにあるかどうか

エラー

422
Unprocessable Entity Error