Class PhoneControllerApi

Represents a collection of functions to interact with the API endpoints

Inheritance

object

PhoneControllerApi

Implements

IPhoneControllerApi

IPhoneControllerApiSync

IPhoneControllerApiAsync

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public class PhoneControllerApi : IPhoneControllerApi, IPhoneControllerApiSync, IPhoneControllerApiAsync, IApiAccessor

Constructors

PhoneControllerApi()

Initializes a new instance of the PhoneControllerApi class.

Declaration

public PhoneControllerApi()

PhoneControllerApi(string)

Initializes a new instance of the PhoneControllerApi class.

Declaration

public PhoneControllerApi(string basePath)

Parameters

Type	Name	Description
string	basePath

PhoneControllerApi(Configuration)

Initializes a new instance of the PhoneControllerApi class using Configuration object

Declaration

public PhoneControllerApi(Configuration configuration)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

PhoneControllerApi(ISynchronousClient, IAsynchronousClient, IReadableConfiguration)

Initializes a new instance of the PhoneControllerApi class using a Configuration object and client instance.

Declaration

public PhoneControllerApi(ISynchronousClient client, IAsynchronousClient asyncClient, IReadableConfiguration configuration)

Parameters

Type	Name	Description
ISynchronousClient	client	The client interface for synchronous API access.
IAsynchronousClient	asyncClient	The client interface for asynchronous API access.
IReadableConfiguration	configuration	The configuration object.

Properties

AsynchronousClient

The client for accessing this underlying API asynchronously.

Declaration

public IAsynchronousClient AsynchronousClient { get; set; }

Property Value

Type	Description
IAsynchronousClient

Client

The client for accessing this underlying API synchronously.

Declaration

public ISynchronousClient Client { get; set; }

Property Value

Type	Description
ISynchronousClient

Configuration

Gets or sets the configuration object

Declaration

public IReadableConfiguration Configuration { get; set; }

Property Value

Type	Description
IReadableConfiguration	An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

CreateEmergencyAddress(CreateEmergencyAddressOptions, int)

Create an emergency address Add an emergency address to a phone number

Declaration

public EmergencyAddress CreateEmergencyAddress(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateEmergencyAddressOptions	createEmergencyAddressOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmergencyAddress	EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEmergencyAddressAsync(CreateEmergencyAddressOptions, int, CancellationToken)

Create an emergency address Add an emergency address to a phone number

Declaration

public Task<EmergencyAddress> CreateEmergencyAddressAsync(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEmergencyAddressOptions	createEmergencyAddressOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmergencyAddress>	Task of EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions, int)

Create an emergency address Add an emergency address to a phone number

Declaration

public ApiResponse<EmergencyAddress> CreateEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreateEmergencyAddressOptions	createEmergencyAddressOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmergencyAddress>	ApiResponse of EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreateEmergencyAddressWithHttpInfoAsync(CreateEmergencyAddressOptions, int, CancellationToken)

Create an emergency address Add an emergency address to a phone number

Declaration

public Task<ApiResponse<EmergencyAddress>> CreateEmergencyAddressWithHttpInfoAsync(CreateEmergencyAddressOptions createEmergencyAddressOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreateEmergencyAddressOptions	createEmergencyAddressOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmergencyAddress>>	Task of ApiResponse (EmergencyAddress)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreatePhoneNumber(CreatePhoneNumberOptions, int)

Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation. Create new phone number

Declaration

public PhoneNumberDto CreatePhoneNumber(CreatePhoneNumberOptions createPhoneNumberOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreatePhoneNumberOptions	createPhoneNumberOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberDto	PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreatePhoneNumberAsync(CreatePhoneNumberOptions, int, CancellationToken)

Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation. Create new phone number

Declaration

public Task<PhoneNumberDto> CreatePhoneNumberAsync(CreatePhoneNumberOptions createPhoneNumberOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreatePhoneNumberOptions	createPhoneNumberOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreatePhoneNumberWithHttpInfo(CreatePhoneNumberOptions, int)

Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation. Create new phone number

Declaration

public ApiResponse<PhoneNumberDto> CreatePhoneNumberWithHttpInfo(CreatePhoneNumberOptions createPhoneNumberOptions, int operationIndex = 0)

Parameters

Type	Name	Description
CreatePhoneNumberOptions	createPhoneNumberOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberDto>	ApiResponse of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

CreatePhoneNumberWithHttpInfoAsync(CreatePhoneNumberOptions, int, CancellationToken)

Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation. Create new phone number

Declaration

public Task<ApiResponse<PhoneNumberDto>> CreatePhoneNumberWithHttpInfoAsync(CreatePhoneNumberOptions createPhoneNumberOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CreatePhoneNumberOptions	createPhoneNumberOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberDto>>	Task of ApiResponse (PhoneNumberDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmergencyAddress(Guid, int)

Delete an emergency address Delete an emergency address

Declaration

public EmptyResponseDto DeleteEmergencyAddress(Guid addressId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmptyResponseDto	EmptyResponseDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmergencyAddressAsync(Guid, int, CancellationToken)

Delete an emergency address Delete an emergency address

Declaration

public Task<EmptyResponseDto> DeleteEmergencyAddressAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmptyResponseDto>	Task of EmptyResponseDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmergencyAddressWithHttpInfo(Guid, int)

Delete an emergency address Delete an emergency address

Declaration

public ApiResponse<EmptyResponseDto> DeleteEmergencyAddressWithHttpInfo(Guid addressId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmptyResponseDto>	ApiResponse of EmptyResponseDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeleteEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an emergency address Delete an emergency address

Declaration

public Task<ApiResponse<EmptyResponseDto>> DeleteEmergencyAddressWithHttpInfoAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmptyResponseDto>>	Task of ApiResponse (EmptyResponseDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeletePhoneNumber(Guid, int)

Delete a phone number Remove phone number from account

Declaration

public void DeletePhoneNumber(Guid phoneNumberId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeletePhoneNumberAsync(Guid, int, CancellationToken)

Delete a phone number Remove phone number from account

Declaration

public Task DeletePhoneNumberAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeletePhoneNumberWithHttpInfo(Guid, int)

Delete a phone number Remove phone number from account

Declaration

public ApiResponse<object> DeletePhoneNumberWithHttpInfo(Guid phoneNumberId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

DeletePhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a phone number Remove phone number from account

Declaration

public Task<ApiResponse<object>> DeletePhoneNumberWithHttpInfoAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllPhoneMessageThreads(int?, int?, int)

Get the latest messages for all phones List all message threads for all phones

Declaration

public PagePhoneMessageThreadProjection GetAllPhoneMessageThreads(int? page = null, int? size = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PagePhoneMessageThreadProjection	PagePhoneMessageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllPhoneMessageThreadsAsync(int?, int?, int, CancellationToken)

Get the latest messages for all phones List all message threads for all phones

Declaration

public Task<PagePhoneMessageThreadProjection> GetAllPhoneMessageThreadsAsync(int? page = null, int? size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PagePhoneMessageThreadProjection>	Task of PagePhoneMessageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllPhoneMessageThreadsWithHttpInfo(int?, int?, int)

Get the latest messages for all phones List all message threads for all phones

Declaration

public ApiResponse<PagePhoneMessageThreadProjection> GetAllPhoneMessageThreadsWithHttpInfo(int? page = null, int? size = null, int operationIndex = 0)

Parameters

Type	Name	Description
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PagePhoneMessageThreadProjection>	ApiResponse of PagePhoneMessageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetAllPhoneMessageThreadsWithHttpInfoAsync(int?, int?, int, CancellationToken)

Get the latest messages for all phones List all message threads for all phones

Declaration

public Task<ApiResponse<PagePhoneMessageThreadProjection>> GetAllPhoneMessageThreadsWithHttpInfoAsync(int? page = null, int? size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PagePhoneMessageThreadProjection>>	Task of ApiResponse (PagePhoneMessageThreadProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
string	The base path

GetConsentStatus(int)

Get consent status Get the status of phone usage consent

Declaration

public ConsentStatusDto GetConsentStatus(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConsentStatusDto	ConsentStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConsentStatusAsync(int, CancellationToken)

Get consent status Get the status of phone usage consent

Declaration

public Task<ConsentStatusDto> GetConsentStatusAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConsentStatusDto>	Task of ConsentStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConsentStatusWithHttpInfo(int)

Get consent status Get the status of phone usage consent

Declaration

public ApiResponse<ConsentStatusDto> GetConsentStatusWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConsentStatusDto>	ApiResponse of ConsentStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetConsentStatusWithHttpInfoAsync(int, CancellationToken)

Get consent status Get the status of phone usage consent

Declaration

public Task<ApiResponse<ConsentStatusDto>> GetConsentStatusWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConsentStatusDto>>	Task of ApiResponse (ConsentStatusDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddress(Guid, int)

Get an emergency address Fetch an emergency address by ID

Declaration

public EmergencyAddress GetEmergencyAddress(Guid addressId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
EmergencyAddress	EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddressAsync(Guid, int, CancellationToken)

Get an emergency address Fetch an emergency address by ID

Declaration

public Task<EmergencyAddress> GetEmergencyAddressAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<EmergencyAddress>	Task of EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddressWithHttpInfo(Guid, int)

Get an emergency address Fetch an emergency address by ID

Declaration

public ApiResponse<EmergencyAddress> GetEmergencyAddressWithHttpInfo(Guid addressId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<EmergencyAddress>	ApiResponse of EmergencyAddress

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Get an emergency address Fetch an emergency address by ID

Declaration

public Task<ApiResponse<EmergencyAddress>> GetEmergencyAddressWithHttpInfoAsync(Guid addressId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	addressId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<EmergencyAddress>>	Task of ApiResponse (EmergencyAddress)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddresses(int)

Get emergency addresses List emergency addresses

Declaration

public List<EmergencyAddressDto> GetEmergencyAddresses(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<EmergencyAddressDto>	List<EmergencyAddressDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddressesAsync(int, CancellationToken)

Get emergency addresses List emergency addresses

Declaration

public Task<List<EmergencyAddressDto>> GetEmergencyAddressesAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<EmergencyAddressDto>>	Task of List<EmergencyAddressDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddressesWithHttpInfo(int)

Get emergency addresses List emergency addresses

Declaration

public ApiResponse<List<EmergencyAddressDto>> GetEmergencyAddressesWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<EmergencyAddressDto>>	ApiResponse of List<EmergencyAddressDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetEmergencyAddressesWithHttpInfoAsync(int, CancellationToken)

Get emergency addresses List emergency addresses

Declaration

public Task<ApiResponse<List<EmergencyAddressDto>>> GetEmergencyAddressesWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<EmergencyAddressDto>>>	Task of ApiResponse (List<EmergencyAddressDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadItems(Guid, string, int?, int?, int)

Get messages in a phone thread List message thread messages for a phone message thread

Declaration

public PagePhoneMessageThreadItemProjection GetPhoneMessageThreadItems(Guid phoneNumberId, string otherNumber, int? page = null, int? size = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
string	otherNumber
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PagePhoneMessageThreadItemProjection	PagePhoneMessageThreadItemProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadItemsAsync(Guid, string, int?, int?, int, CancellationToken)

Get messages in a phone thread List message thread messages for a phone message thread

Declaration

public Task<PagePhoneMessageThreadItemProjection> GetPhoneMessageThreadItemsAsync(Guid phoneNumberId, string otherNumber, int? page = null, int? size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
string	otherNumber
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PagePhoneMessageThreadItemProjection>	Task of PagePhoneMessageThreadItemProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadItemsWithHttpInfo(Guid, string, int?, int?, int)

Get messages in a phone thread List message thread messages for a phone message thread

Declaration

public ApiResponse<PagePhoneMessageThreadItemProjection> GetPhoneMessageThreadItemsWithHttpInfo(Guid phoneNumberId, string otherNumber, int? page = null, int? size = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
string	otherNumber
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PagePhoneMessageThreadItemProjection>	ApiResponse of PagePhoneMessageThreadItemProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadItemsWithHttpInfoAsync(Guid, string, int?, int?, int, CancellationToken)

Get messages in a phone thread List message thread messages for a phone message thread

Declaration

public Task<ApiResponse<PagePhoneMessageThreadItemProjection>> GetPhoneMessageThreadItemsWithHttpInfoAsync(Guid phoneNumberId, string otherNumber, int? page = null, int? size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
string	otherNumber
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PagePhoneMessageThreadItemProjection>>	Task of ApiResponse (PagePhoneMessageThreadItemProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreads(Guid, int?, int?, int)

Get the latest message preview for a thread List message threads for a phone

Declaration

public PagePhoneMessageThreadProjection GetPhoneMessageThreads(Guid phoneNumberId, int? page = null, int? size = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PagePhoneMessageThreadProjection	PagePhoneMessageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadsAsync(Guid, int?, int?, int, CancellationToken)

Get the latest message preview for a thread List message threads for a phone

Declaration

public Task<PagePhoneMessageThreadProjection> GetPhoneMessageThreadsAsync(Guid phoneNumberId, int? page = null, int? size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PagePhoneMessageThreadProjection>	Task of PagePhoneMessageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadsWithHttpInfo(Guid, int?, int?, int)

Get the latest message preview for a thread List message threads for a phone

Declaration

public ApiResponse<PagePhoneMessageThreadProjection> GetPhoneMessageThreadsWithHttpInfo(Guid phoneNumberId, int? page = null, int? size = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PagePhoneMessageThreadProjection>	ApiResponse of PagePhoneMessageThreadProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneMessageThreadsWithHttpInfoAsync(Guid, int?, int?, int, CancellationToken)

Get the latest message preview for a thread List message threads for a phone

Declaration

public Task<ApiResponse<PagePhoneMessageThreadProjection>> GetPhoneMessageThreadsWithHttpInfoAsync(Guid phoneNumberId, int? page = null, int? size = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	(optional, default to 0)
int?	size	(optional, default to 20)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PagePhoneMessageThreadProjection>>	Task of ApiResponse (PagePhoneMessageThreadProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumber(Guid, int)

Get a phone number by ID Get a phone number by ID

Declaration

public PhoneNumberDto GetPhoneNumber(Guid phoneNumberId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberDto	PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberAsync(Guid, int, CancellationToken)

Get a phone number by ID Get a phone number by ID

Declaration

public Task<PhoneNumberDto> GetPhoneNumberAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByName(string, int)

Get a phone number by name Get a phone number by name

Declaration

public PhoneNumberDto GetPhoneNumberByName(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberDto	PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByNameAsync(string, int, CancellationToken)

Get a phone number by name Get a phone number by name

Declaration

public Task<PhoneNumberDto> GetPhoneNumberByNameAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByNameWithHttpInfo(string, int)

Get a phone number by name Get a phone number by name

Declaration

public ApiResponse<PhoneNumberDto> GetPhoneNumberByNameWithHttpInfo(string name, int operationIndex = 0)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberDto>	ApiResponse of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByNameWithHttpInfoAsync(string, int, CancellationToken)

Get a phone number by name Get a phone number by name

Declaration

public Task<ApiResponse<PhoneNumberDto>> GetPhoneNumberByNameWithHttpInfoAsync(string name, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberDto>>	Task of ApiResponse (PhoneNumberDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByPhoneNumber(string, int)

Get a phone number by phone number Get a phone number by phone number

Declaration

public PhoneNumberDto GetPhoneNumberByPhoneNumber(string phoneNumber, int operationIndex = 0)

Parameters

Type	Name	Description
string	phoneNumber
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberDto	PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByPhoneNumberAsync(string, int, CancellationToken)

Get a phone number by phone number Get a phone number by phone number

Declaration

public Task<PhoneNumberDto> GetPhoneNumberByPhoneNumberAsync(string phoneNumber, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	phoneNumber
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByPhoneNumberWithHttpInfo(string, int)

Get a phone number by phone number Get a phone number by phone number

Declaration

public ApiResponse<PhoneNumberDto> GetPhoneNumberByPhoneNumberWithHttpInfo(string phoneNumber, int operationIndex = 0)

Parameters

Type	Name	Description
string	phoneNumber
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberDto>	ApiResponse of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberByPhoneNumberWithHttpInfoAsync(string, int, CancellationToken)

Get a phone number by phone number Get a phone number by phone number

Declaration

public Task<ApiResponse<PhoneNumberDto>> GetPhoneNumberByPhoneNumberWithHttpInfoAsync(string phoneNumber, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	phoneNumber
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberDto>>	Task of ApiResponse (PhoneNumberDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberWithHttpInfo(Guid, int)

Get a phone number by ID Get a phone number by ID

Declaration

public ApiResponse<PhoneNumberDto> GetPhoneNumberWithHttpInfo(Guid phoneNumberId, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberDto>	ApiResponse of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

Get a phone number by ID Get a phone number by ID

Declaration

public Task<ApiResponse<PhoneNumberDto>> GetPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberDto>>	Task of ApiResponse (PhoneNumberDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumbers(string, int?, int?, string, DateTime?, DateTime?, string, List<Guid>, bool?, int)

Get phone numbers List phone numbers for account

Declaration

public PagePhoneNumberProjection GetPhoneNumbers(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, List<Guid> include = null, bool? favourite = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	phoneCountry	Optional phone country (optional)
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
string	search	Optional search filter (optional)
List<Guid>	include	Optional phoneIds to include in result (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PagePhoneNumberProjection	PagePhoneNumberProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumbersAsync(string, int?, int?, string, DateTime?, DateTime?, string, List<Guid>, bool?, int, CancellationToken)

Get phone numbers List phone numbers for account

Declaration

public Task<PagePhoneNumberProjection> GetPhoneNumbersAsync(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, List<Guid> include = null, bool? favourite = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	phoneCountry	Optional phone country (optional)
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
string	search	Optional search filter (optional)
List<Guid>	include	Optional phoneIds to include in result (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PagePhoneNumberProjection>	Task of PagePhoneNumberProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumbersWithHttpInfo(string, int?, int?, string, DateTime?, DateTime?, string, List<Guid>, bool?, int)

Get phone numbers List phone numbers for account

Declaration

public ApiResponse<PagePhoneNumberProjection> GetPhoneNumbersWithHttpInfo(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, List<Guid> include = null, bool? favourite = null, int operationIndex = 0)

Parameters

Type	Name	Description
string	phoneCountry	Optional phone country (optional)
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
string	search	Optional search filter (optional)
List<Guid>	include	Optional phoneIds to include in result (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PagePhoneNumberProjection>	ApiResponse of PagePhoneNumberProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhoneNumbersWithHttpInfoAsync(string, int?, int?, string, DateTime?, DateTime?, string, List<Guid>, bool?, int, CancellationToken)

Get phone numbers List phone numbers for account

Declaration

public Task<ApiResponse<PagePhoneNumberProjection>> GetPhoneNumbersWithHttpInfoAsync(string phoneCountry = null, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, List<Guid> include = null, bool? favourite = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	phoneCountry	Optional phone country (optional)
int?	page	Optional page index for list pagination (optional, default to 0)
int?	size	Optional page size for list pagination (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Filter by created at after the given timestamp (optional)
DateTime?	before	Filter by created at before the given timestamp (optional)
string	search	Optional search filter (optional)
List<Guid>	include	Optional phoneIds to include in result (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PagePhoneNumberProjection>>	Task of ApiResponse (PagePhoneNumberProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlans(int)

Get phone plans Get phone number plans

Declaration

public List<PhonePlanDto> GetPhonePlans(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
List<PhonePlanDto>	List<PhonePlanDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansAsync(int, CancellationToken)

Get phone plans Get phone number plans

Declaration

public Task<List<PhonePlanDto>> GetPhonePlansAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<List<PhonePlanDto>>	Task of List<PhonePlanDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansAvailability(int)

Get phone plans availability

Declaration

public PhonePlanAvailability GetPhonePlansAvailability(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhonePlanAvailability	PhonePlanAvailability

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansAvailabilityAsync(int, CancellationToken)

Get phone plans availability

Declaration

public Task<PhonePlanAvailability> GetPhonePlansAvailabilityAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhonePlanAvailability>	Task of PhonePlanAvailability

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansAvailabilityWithHttpInfo(int)

Get phone plans availability

Declaration

public ApiResponse<PhonePlanAvailability> GetPhonePlansAvailabilityWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhonePlanAvailability>	ApiResponse of PhonePlanAvailability

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansAvailabilityWithHttpInfoAsync(int, CancellationToken)

Get phone plans availability

Declaration

public Task<ApiResponse<PhonePlanAvailability>> GetPhonePlansAvailabilityWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhonePlanAvailability>>	Task of ApiResponse (PhonePlanAvailability)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansWithHttpInfo(int)

Get phone plans Get phone number plans

Declaration

public ApiResponse<List<PhonePlanDto>> GetPhonePlansWithHttpInfo(int operationIndex = 0)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<List<PhonePlanDto>>	ApiResponse of List<PhonePlanDto>

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetPhonePlansWithHttpInfoAsync(int, CancellationToken)

Get phone plans Get phone number plans

Declaration

public Task<ApiResponse<List<PhonePlanDto>>> GetPhonePlansWithHttpInfoAsync(int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<List<PhonePlanDto>>>	Task of ApiResponse (List<PhonePlanDto>)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsByPhoneNumber(Guid, int?, int?, string, DateTime?, DateTime?, string, int)

List sent TXT messages for a phone number Get sent SMS messages for a phone number

Declaration

public PageSentSmsProjection GetSentSmsByPhoneNumber(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSentSmsProjection	PageSentSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsByPhoneNumberAsync(Guid, int?, int?, string, DateTime?, DateTime?, string, int, CancellationToken)

List sent TXT messages for a phone number Get sent SMS messages for a phone number

Declaration

public Task<PageSentSmsProjection> GetSentSmsByPhoneNumberAsync(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSentSmsProjection>	Task of PageSentSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsByPhoneNumberWithHttpInfo(Guid, int?, int?, string, DateTime?, DateTime?, string, int)

List sent TXT messages for a phone number Get sent SMS messages for a phone number

Declaration

public ApiResponse<PageSentSmsProjection> GetSentSmsByPhoneNumberWithHttpInfo(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSentSmsProjection>	ApiResponse of PageSentSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSentSmsByPhoneNumberWithHttpInfoAsync(Guid, int?, int?, string, DateTime?, DateTime?, string, int, CancellationToken)

List sent TXT messages for a phone number Get sent SMS messages for a phone number

Declaration

public Task<ApiResponse<PageSentSmsProjection>> GetSentSmsByPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null, string search = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageSentSmsProjection>>	Task of ApiResponse (PageSentSmsProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsByPhoneNumber(Guid, int?, int?, string, bool?, DateTime?, DateTime?, string, bool?, int)

List SMS messages for a phone number Get SMS messages for a phone number

Declaration

public PageSmsProjection GetSmsByPhoneNumber(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PageSmsProjection	PageSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsByPhoneNumberAsync(Guid, int?, int?, string, bool?, DateTime?, DateTime?, string, bool?, int, CancellationToken)

List SMS messages for a phone number Get SMS messages for a phone number

Declaration

public Task<PageSmsProjection> GetSmsByPhoneNumberAsync(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PageSmsProjection>	Task of PageSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsByPhoneNumberWithHttpInfo(Guid, int?, int?, string, bool?, DateTime?, DateTime?, string, bool?, int)

List SMS messages for a phone number Get SMS messages for a phone number

Declaration

public ApiResponse<PageSmsProjection> GetSmsByPhoneNumberWithHttpInfo(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PageSmsProjection>	ApiResponse of PageSmsProjection

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

GetSmsByPhoneNumberWithHttpInfoAsync(Guid, int?, int?, string, bool?, DateTime?, DateTime?, string, bool?, int, CancellationToken)

List SMS messages for a phone number Get SMS messages for a phone number

Declaration

public Task<ApiResponse<PageSmsProjection>> GetSmsByPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, string search = null, bool? favourite = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
int?	page	Optional page index in SMS list pagination (optional, default to 0)
int?	size	Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (optional, default to 20)
string	sort	Optional createdAt sort direction ASC or DESC (optional, default to ASC)
bool?	unreadOnly	Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (optional, default to false)
DateTime?	since	Optional filter SMSs received after given date time (optional)
DateTime?	before	Optional filter SMSs received before given date time (optional)
string	search	Optional search filter (optional)
bool?	favourite	Optionally filter results for favourites only (optional, default to false)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PageSmsProjection>>	Task of ApiResponse (PageSmsProjection)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsFromPhoneNumber(Guid, SmsSendOptions, int)

Send TXT message from a phone number Send SMS from a phone number

Declaration

public SentSmsDto SendSmsFromPhoneNumber(Guid phoneNumberId, SmsSendOptions smsSendOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
SmsSendOptions	smsSendOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
SentSmsDto	SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsFromPhoneNumberAsync(Guid, SmsSendOptions, int, CancellationToken)

Send TXT message from a phone number Send SMS from a phone number

Declaration

public Task<SentSmsDto> SendSmsFromPhoneNumberAsync(Guid phoneNumberId, SmsSendOptions smsSendOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
SmsSendOptions	smsSendOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SentSmsDto>	Task of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsFromPhoneNumberWithHttpInfo(Guid, SmsSendOptions, int)

Send TXT message from a phone number Send SMS from a phone number

Declaration

public ApiResponse<SentSmsDto> SendSmsFromPhoneNumberWithHttpInfo(Guid phoneNumberId, SmsSendOptions smsSendOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
SmsSendOptions	smsSendOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<SentSmsDto>	ApiResponse of SentSmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SendSmsFromPhoneNumberWithHttpInfoAsync(Guid, SmsSendOptions, int, CancellationToken)

Send TXT message from a phone number Send SMS from a phone number

Declaration

public Task<ApiResponse<SentSmsDto>> SendSmsFromPhoneNumberWithHttpInfoAsync(Guid phoneNumberId, SmsSendOptions smsSendOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
SmsSendOptions	smsSendOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<SentSmsDto>>	Task of ApiResponse (SentSmsDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetConsentStatus(bool, int)

Set consent status Give or revoke consent for phone usage

Declaration

public ConsentStatusDto SetConsentStatus(bool agree, int operationIndex = 0)

Parameters

Type	Name	Description
bool	agree
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ConsentStatusDto	ConsentStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetConsentStatusAsync(bool, int, CancellationToken)

Set consent status Give or revoke consent for phone usage

Declaration

public Task<ConsentStatusDto> SetConsentStatusAsync(bool agree, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool	agree
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ConsentStatusDto>	Task of ConsentStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetConsentStatusWithHttpInfo(bool, int)

Set consent status Give or revoke consent for phone usage

Declaration

public ApiResponse<ConsentStatusDto> SetConsentStatusWithHttpInfo(bool agree, int operationIndex = 0)

Parameters

Type	Name	Description
bool	agree
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<ConsentStatusDto>	ApiResponse of ConsentStatusDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetConsentStatusWithHttpInfoAsync(bool, int, CancellationToken)

Set consent status Give or revoke consent for phone usage

Declaration

public Task<ApiResponse<ConsentStatusDto>> SetConsentStatusWithHttpInfoAsync(bool agree, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
bool	agree
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<ConsentStatusDto>>	Task of ApiResponse (ConsentStatusDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetPhoneFavourited(Guid, SetPhoneFavouritedOptions, int)

Set phone favourited state Set and return new favorite state for a phone

Declaration

public PhoneNumberDto SetPhoneFavourited(Guid phoneNumberId, SetPhoneFavouritedOptions setPhoneFavouritedOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
SetPhoneFavouritedOptions	setPhoneFavouritedOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberDto	PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetPhoneFavouritedAsync(Guid, SetPhoneFavouritedOptions, int, CancellationToken)

Set phone favourited state Set and return new favorite state for a phone

Declaration

public Task<PhoneNumberDto> SetPhoneFavouritedAsync(Guid phoneNumberId, SetPhoneFavouritedOptions setPhoneFavouritedOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
SetPhoneFavouritedOptions	setPhoneFavouritedOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetPhoneFavouritedWithHttpInfo(Guid, SetPhoneFavouritedOptions, int)

Set phone favourited state Set and return new favorite state for a phone

Declaration

public ApiResponse<PhoneNumberDto> SetPhoneFavouritedWithHttpInfo(Guid phoneNumberId, SetPhoneFavouritedOptions setPhoneFavouritedOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
SetPhoneFavouritedOptions	setPhoneFavouritedOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberDto>	ApiResponse of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

SetPhoneFavouritedWithHttpInfoAsync(Guid, SetPhoneFavouritedOptions, int, CancellationToken)

Set phone favourited state Set and return new favorite state for a phone

Declaration

public Task<ApiResponse<PhoneNumberDto>> SetPhoneFavouritedWithHttpInfoAsync(Guid phoneNumberId, SetPhoneFavouritedOptions setPhoneFavouritedOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
SetPhoneFavouritedOptions	setPhoneFavouritedOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberDto>>	Task of ApiResponse (PhoneNumberDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestPhoneNumberSendSms(Guid, TestPhoneNumberOptions, string, int)

Test sending an SMS to a number Test a phone number by sending an SMS to it

Declaration

public void TestPhoneNumberSendSms(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
TestPhoneNumberOptions	testPhoneNumberOptions
string	xTestId	(optional)
int	operationIndex	Index associated with the operation.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestPhoneNumberSendSmsAsync(Guid, TestPhoneNumberOptions, string, int, CancellationToken)

Test sending an SMS to a number Test a phone number by sending an SMS to it

Declaration

public Task TestPhoneNumberSendSmsAsync(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
TestPhoneNumberOptions	testPhoneNumberOptions
string	xTestId	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task	Task of void

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestPhoneNumberSendSmsWithHttpInfo(Guid, TestPhoneNumberOptions, string, int)

Test sending an SMS to a number Test a phone number by sending an SMS to it

Declaration

public ApiResponse<object> TestPhoneNumberSendSmsWithHttpInfo(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId
TestPhoneNumberOptions	testPhoneNumberOptions
string	xTestId	(optional)
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<object>	ApiResponse of Object(void)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

TestPhoneNumberSendSmsWithHttpInfoAsync(Guid, TestPhoneNumberOptions, string, int, CancellationToken)

Test sending an SMS to a number Test a phone number by sending an SMS to it

Declaration

public Task<ApiResponse<object>> TestPhoneNumberSendSmsWithHttpInfoAsync(Guid phoneNumberId, TestPhoneNumberOptions testPhoneNumberOptions, string xTestId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId
TestPhoneNumberOptions	testPhoneNumberOptions
string	xTestId	(optional)
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<object>>	Task of ApiResponse

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdatePhoneNumber(Guid, UpdatePhoneNumberOptions, int)

Update a phone number Set field for phone number

Declaration

public PhoneNumberDto UpdatePhoneNumber(Guid phoneNumberId, UpdatePhoneNumberOptions updatePhoneNumberOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
UpdatePhoneNumberOptions	updatePhoneNumberOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberDto	PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdatePhoneNumberAsync(Guid, UpdatePhoneNumberOptions, int, CancellationToken)

Update a phone number Set field for phone number

Declaration

public Task<PhoneNumberDto> UpdatePhoneNumberAsync(Guid phoneNumberId, UpdatePhoneNumberOptions updatePhoneNumberOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
UpdatePhoneNumberOptions	updatePhoneNumberOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberDto>	Task of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdatePhoneNumberWithHttpInfo(Guid, UpdatePhoneNumberOptions, int)

Update a phone number Set field for phone number

Declaration

public ApiResponse<PhoneNumberDto> UpdatePhoneNumberWithHttpInfo(Guid phoneNumberId, UpdatePhoneNumberOptions updatePhoneNumberOptions, int operationIndex = 0)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
UpdatePhoneNumberOptions	updatePhoneNumberOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberDto>	ApiResponse of PhoneNumberDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

UpdatePhoneNumberWithHttpInfoAsync(Guid, UpdatePhoneNumberOptions, int, CancellationToken)

Update a phone number Set field for phone number

Declaration

public Task<ApiResponse<PhoneNumberDto>> UpdatePhoneNumberWithHttpInfoAsync(Guid phoneNumberId, UpdatePhoneNumberOptions updatePhoneNumberOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	phoneNumberId	ID of phone to set favourite state
UpdatePhoneNumberOptions	updatePhoneNumberOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberDto>>	Task of ApiResponse (PhoneNumberDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidatePhoneNumber(ValidatePhoneNumberOptions, int)

Verify validity of a phone number Validate a phone number

Declaration

public PhoneNumberValidationDto ValidatePhoneNumber(ValidatePhoneNumberOptions validatePhoneNumberOptions, int operationIndex = 0)

Parameters

Type	Name	Description
ValidatePhoneNumberOptions	validatePhoneNumberOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
PhoneNumberValidationDto	PhoneNumberValidationDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidatePhoneNumberAsync(ValidatePhoneNumberOptions, int, CancellationToken)

Verify validity of a phone number Validate a phone number

Declaration

public Task<PhoneNumberValidationDto> ValidatePhoneNumberAsync(ValidatePhoneNumberOptions validatePhoneNumberOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ValidatePhoneNumberOptions	validatePhoneNumberOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<PhoneNumberValidationDto>	Task of PhoneNumberValidationDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidatePhoneNumberWithHttpInfo(ValidatePhoneNumberOptions, int)

Verify validity of a phone number Validate a phone number

Declaration

public ApiResponse<PhoneNumberValidationDto> ValidatePhoneNumberWithHttpInfo(ValidatePhoneNumberOptions validatePhoneNumberOptions, int operationIndex = 0)

Parameters

Type	Name	Description
ValidatePhoneNumberOptions	validatePhoneNumberOptions
int	operationIndex	Index associated with the operation.

Returns

Type	Description
ApiResponse<PhoneNumberValidationDto>	ApiResponse of PhoneNumberValidationDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

ValidatePhoneNumberWithHttpInfoAsync(ValidatePhoneNumberOptions, int, CancellationToken)

Verify validity of a phone number Validate a phone number

Declaration

public Task<ApiResponse<PhoneNumberValidationDto>> ValidatePhoneNumberWithHttpInfoAsync(ValidatePhoneNumberOptions validatePhoneNumberOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ValidatePhoneNumberOptions	validatePhoneNumberOptions
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<ApiResponse<PhoneNumberValidationDto>>	Task of ApiResponse (PhoneNumberValidationDto)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

Implements

IPhoneControllerApi

IPhoneControllerApiSync

IPhoneControllerApiAsync

IApiAccessor