Package com.sinch.sdk.domains.numbers.models.v1.request

Interface AvailableNumberListRequest

public interface AvailableNumberListRequest

Parameters request to list available numbers for a project

Since:

1.2

See Also:

• https://developers.sinch.com/docs/numbers/api-reference/numbers/tag/Available-Number/#tag/Available-Number/operation/NumberService_ListAvailableNumbers/

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AvailableNumberListRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AvailableNumberListRequest.Builder	builder()
Collection<Capability>	getCapabilities()
String	getRegionCode()
SearchPattern	getSearchPattern()
Integer	getSize()
NumberType	getType()

Method Details

getRegionCode

String getRegionCode()

Returns:

Region code to filter by. ISO 3166-1 alpha-2 country code of the phone number. Example: `US`, `GB` or `SE`. (required)

getType

NumberType getType()

Returns:

Number type to filter by. Options include, `MOBILE`, `LOCAL` or `TOLL_FREE`. (required)

getSearchPattern

SearchPattern getSearchPattern()

Returns:

Search criteria

getCapabilities

Collection<Capability> getCapabilities()

Returns:

Number capabilities to filter by, `SMS` and/or `VOICE`.

getSize

Integer getSize()

Returns:

The maximum number of items to return

builder

static AvailableNumberListRequest.Builder builder()