List Phone Numbers Page

GET

/v1/convai/v2/phone-numbers

Retrieve a page of Phone Numbers

クエリパラメータ

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

Number of phone numbers per page

searchstringオプション<=100 characters

Filter by phone number ID, label, or phone number. A phone number ID must match exactly; label and phone number matching is a case-insensitive substring.

labelstringオプション<=100 characters

Filter by label. Matching is a case-insensitive substring.

phone_numberstringオプション<=100 characters

Filter by phone number

providerenumオプション

Filter by telephony provider

許可された値:

supports_outboundbooleanオプション

Filter by whether the phone number can place outbound calls

agent_idstringオプション

Filter by assigned agent ID

branch_idstringオプション

Filter by assigned branch ID

sort_byenumオプション

The field to sort the results by

許可された値:

sort_directionenumオプション

The direction to sort the results

許可された値:

cursorstringオプション

Used for fetching next page. Cursor is returned in the response.

レスポンス

Successful Response

phone_numberslist of objects

The phone numbers on this page

next_cursorstringオプション

Pass this value as cursor to fetch the next page. Null when there are no more results.

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

Whether there are more results available

エラー

422

Phone Numbers List V2request Unprocessable Entity Error

ヘッダー

クエリパラメータ

レスポンス

エラー