sinch.domains.numbers.api.v1.active_numbers_apis module

class sinch.domains.numbers.api.v1.active_numbers_apis.ActiveNumbers(sinch)[source]

Bases: BaseNumbers

list(

region_code: str | None = None,

number_type: Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | Annotated[str, Strict(strict=True)] | None = None,

number_pattern: str | None = None,

number_search_pattern: Literal['START', 'CONTAINS', 'END'] | Annotated[str, Strict(strict=True)] | None = None,

capabilities: List[Literal['SMS', 'VOICE'] | Annotated[str, Strict(strict=True)]] | None = None,

page_size: int | None = None,

page_token: str | None = None,

order_by: Literal['PHONE_NUMBER', 'DISPLAY_NAME'] | Annotated[str, Strict(strict=True)] | None = None,

**kwargs,

) → Paginator[ActiveNumber][source]

Parameters:

region_code (str | None)
number_type (Literal['MOBILE', 'LOCAL', 'TOLL_FREE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)
number_pattern (str | None)
number_search_pattern (Literal['START', 'CONTAINS', 'END'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)
capabilities (List[Literal['SMS', 'VOICE'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)]] | None)
page_size (int | None)
page_token (str | None)
order_by (Literal['PHONE_NUMBER', 'DISPLAY_NAME'] | ~typing.Annotated[str, ~pydantic.types.Strict(strict=True)] | None)

Return type:

Paginator[ActiveNumber]

update(

phone_number: str,

display_name: str | None = None,

sms_configuration: SmsConfigurationDict | None = None,

voice_configuration: Annotated[VoiceConfigurationFAXDict | VoiceConfigurationRTCDict | VoiceConfigurationESTDict | VoiceConfigurationCustomDict, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | None = None,

event_destination_target: str | None = None,

**kwargs,

) → ActiveNumber[source]

Parameters:

phone_number (str)
display_name (str | None)
sms_configuration (SmsConfigurationDict | None)
voice_configuration (Annotated[VoiceConfigurationFAXDict | VoiceConfigurationRTCDict | VoiceConfigurationESTDict | VoiceConfigurationCustomDict, FieldInfo(annotation=NoneType, required=True, discriminator='type')] | None)
event_destination_target (str | None)

Return type:

ActiveNumber

get(

phone_number: str,

**kwargs,

) → ActiveNumber[source]

Parameters:: phone_number (str)
Return type:: ActiveNumber

release(

phone_number: str,

**kwargs,

) → ActiveNumber[source]

Parameters:: phone_number (str)
Return type:: ActiveNumber