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

请求头

查询参数

响应

错误