Interface IPhoneControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IPhoneControllerApiAsync : IApiAccessor

Methods

View Source

CreateEmergencyAddressAsync(CreateEmergencyAddressOptions, int, CancellationToken)

Create an emergency address

Declaration
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
Remarks

Add an emergency address to a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

CreateEmergencyAddressWithHttpInfoAsync(CreateEmergencyAddressOptions, int, CancellationToken)

Create an emergency address

Declaration
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)
Remarks

Add an emergency address to a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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.

Declaration
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
Remarks

Create new phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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.

Declaration
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)
Remarks

Create new phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteEmergencyAddressAsync(Guid, int, CancellationToken)

Delete an emergency address

Declaration
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
Remarks

Delete an emergency address

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Delete an emergency address

Declaration
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)
Remarks

Delete an emergency address

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeletePhoneNumberAsync(Guid, int, CancellationToken)

Delete a phone number

Declaration
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
Remarks

Remove phone number from account

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeletePhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

Delete a phone number

Declaration
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
Remarks

Remove phone number from account

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get the latest messages for all phones

Declaration
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
Remarks

List all message threads for all phones

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get the latest messages for all phones

Declaration
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)
Remarks

List all message threads for all phones

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetConsentStatusAsync(int, CancellationToken)

Get consent status

Declaration
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
Remarks

Get the status of phone usage consent

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetConsentStatusWithHttpInfoAsync(int, CancellationToken)

Get consent status

Declaration
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)
Remarks

Get the status of phone usage consent

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddressAsync(Guid, int, CancellationToken)

Get an emergency address

Declaration
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
Remarks

Fetch an emergency address by ID

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddressWithHttpInfoAsync(Guid, int, CancellationToken)

Get an emergency address

Declaration
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)
Remarks

Fetch an emergency address by ID

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddressesAsync(int, CancellationToken)

Get emergency addresses

Declaration
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>
Remarks

List emergency addresses

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetEmergencyAddressesWithHttpInfoAsync(int, CancellationToken)

Get emergency addresses

Declaration
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>)
Remarks

List emergency addresses

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get messages in a phone thread

Declaration
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
Remarks

List message thread messages for a phone message thread

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get messages in a phone thread

Declaration
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)
Remarks

List message thread messages for a phone message thread

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get the latest message preview for a thread

Declaration
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
Remarks

List message threads for a phone

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get the latest message preview for a thread

Declaration
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)
Remarks

List message threads for a phone

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberAsync(Guid, int, CancellationToken)

Get a phone number by ID

Declaration
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
Remarks

Get a phone number by ID

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberByNameAsync(string, int, CancellationToken)

Get a phone number by name

Declaration
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
Remarks

Get a phone number by name

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberByNameWithHttpInfoAsync(string, int, CancellationToken)

Get a phone number by name

Declaration
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)
Remarks

Get a phone number by name

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberByPhoneNumberAsync(string, int, CancellationToken)

Get a phone number by phone number

Declaration
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
Remarks

Get a phone number by phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberByPhoneNumberWithHttpInfoAsync(string, int, CancellationToken)

Get a phone number by phone number

Declaration
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)
Remarks

Get a phone number by phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhoneNumberWithHttpInfoAsync(Guid, int, CancellationToken)

Get a phone number by ID

Declaration
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)
Remarks

Get a phone number by ID

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get phone numbers

Declaration
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
Remarks

List phone numbers for account

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Get phone numbers

Declaration
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)
Remarks

List phone numbers for account

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhonePlansAsync(int, CancellationToken)

Get phone plans

Declaration
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>
Remarks

Get phone number plans

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetPhonePlansAvailabilityAsync(int, CancellationToken)

Get phone plans availability

Declaration
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
View Source

GetPhonePlansAvailabilityWithHttpInfoAsync(int, CancellationToken)

Get phone plans availability

Declaration
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
View Source

GetPhonePlansWithHttpInfoAsync(int, CancellationToken)

Get phone plans

Declaration
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>)
Remarks

Get phone number plans

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List sent TXT messages for a phone number

Declaration
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
Remarks

Get sent SMS messages for a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List sent TXT messages for a phone number

Declaration
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)
Remarks

Get sent SMS messages for a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List SMS messages for a phone number

Declaration
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
Remarks

Get SMS messages for a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

List SMS messages for a phone number

Declaration
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)
Remarks

Get SMS messages for a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendSmsFromPhoneNumberAsync(Guid, SmsSendOptions, int, CancellationToken)

Send TXT message from a phone number

Declaration
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
Remarks

Send SMS from a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendSmsFromPhoneNumberWithHttpInfoAsync(Guid, SmsSendOptions, int, CancellationToken)

Send TXT message from a phone number

Declaration
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)
Remarks

Send SMS from a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetConsentStatusAsync(bool, int, CancellationToken)

Set consent status

Declaration
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
Remarks

Give or revoke consent for phone usage

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetConsentStatusWithHttpInfoAsync(bool, int, CancellationToken)

Set consent status

Declaration
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)
Remarks

Give or revoke consent for phone usage

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetPhoneFavouritedAsync(Guid, SetPhoneFavouritedOptions, int, CancellationToken)

Set phone favourited state

Declaration
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
Remarks

Set and return new favorite state for a phone

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetPhoneFavouritedWithHttpInfoAsync(Guid, SetPhoneFavouritedOptions, int, CancellationToken)

Set phone favourited state

Declaration
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)
Remarks

Set and return new favorite state for a phone

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Test sending an SMS to a number

Declaration
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
Remarks

Test a phone number by sending an SMS to it

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Test sending an SMS to a number

Declaration
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
Remarks

Test a phone number by sending an SMS to it

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdatePhoneNumberAsync(Guid, UpdatePhoneNumberOptions, int, CancellationToken)

Update a phone number

Declaration
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
Remarks

Set field for phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

UpdatePhoneNumberWithHttpInfoAsync(Guid, UpdatePhoneNumberOptions, int, CancellationToken)

Update a phone number

Declaration
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)
Remarks

Set field for phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidatePhoneNumberAsync(ValidatePhoneNumberOptions, int, CancellationToken)

Verify validity of a phone number

Declaration
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
Remarks

Validate a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ValidatePhoneNumberWithHttpInfoAsync(ValidatePhoneNumberOptions, int, CancellationToken)

Verify validity of a phone number

Declaration
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)
Remarks

Validate a phone number

Exceptions
Type Condition
ApiException

Thrown when fails to make API call