Interface IPhoneControllerApiSync
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: mailslurp.Api
Assembly: mailslurp.dll
Syntax
public interface IPhoneControllerApiSync : IApiAccessorMethods
View SourceCreateEmergencyAddress(CreateEmergencyAddressOptions, int)
Create an emergency address
Declaration
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 |
Remarks
Add an emergency address to a phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
CreateEmergencyAddressWithHttpInfo(CreateEmergencyAddressOptions, int)
Create an emergency address
Declaration
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 |
Remarks
Add an emergency address to a phone number
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.
Declaration
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 |
Remarks
Create new phone number
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.
Declaration
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 |
Remarks
Create new phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteEmergencyAddress(Guid, int)
Delete an emergency address
Declaration
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 |
Remarks
Delete an emergency address
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeleteEmergencyAddressWithHttpInfo(Guid, int)
Delete an emergency address
Declaration
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 |
Remarks
Delete an emergency address
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeletePhoneNumber(Guid, int)
Delete a phone number
Declaration
void DeletePhoneNumber(Guid phoneNumberId, int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Guid | phoneNumberId | |
| int | operationIndex | Index associated with the operation. |
Remarks
Remove phone number from account
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
DeletePhoneNumberWithHttpInfo(Guid, int)
Delete a phone number
Declaration
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) |
Remarks
Remove phone number from account
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAllPhoneMessageThreads(int?, int?, int)
Get the latest messages for all phones
Declaration
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 |
Remarks
List all message threads for all phones
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetAllPhoneMessageThreadsWithHttpInfo(int?, int?, int)
Get the latest messages for all phones
Declaration
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 |
Remarks
List all message threads for all phones
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetConsentStatus(int)
Get consent status
Declaration
ConsentStatusDto GetConsentStatus(int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| ConsentStatusDto | ConsentStatusDto |
Remarks
Get the status of phone usage consent
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetConsentStatusWithHttpInfo(int)
Get consent status
Declaration
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 |
Remarks
Get the status of phone usage consent
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmergencyAddress(Guid, int)
Get an emergency address
Declaration
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 |
Remarks
Fetch an emergency address by ID
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmergencyAddressWithHttpInfo(Guid, int)
Get an emergency address
Declaration
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 |
Remarks
Fetch an emergency address by ID
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmergencyAddresses(int)
Get emergency addresses
Declaration
List<EmergencyAddressDto> GetEmergencyAddresses(int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<EmergencyAddressDto> | List<EmergencyAddressDto> |
Remarks
List emergency addresses
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetEmergencyAddressesWithHttpInfo(int)
Get emergency addresses
Declaration
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> |
Remarks
List emergency addresses
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneMessageThreadItems(Guid, string, int?, int?, int)
Get messages in a phone thread
Declaration
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 |
Remarks
List message thread messages for a phone message thread
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneMessageThreadItemsWithHttpInfo(Guid, string, int?, int?, int)
Get messages in a phone thread
Declaration
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 |
Remarks
List message thread messages for a phone message thread
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneMessageThreads(Guid, int?, int?, int)
Get the latest message preview for a thread
Declaration
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 |
Remarks
List message threads for a phone
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneMessageThreadsWithHttpInfo(Guid, int?, int?, int)
Get the latest message preview for a thread
Declaration
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 |
Remarks
List message threads for a phone
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumber(Guid, int)
Get a phone number by ID
Declaration
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 |
Remarks
Get a phone number by ID
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumberByName(string, int)
Get a phone number by name
Declaration
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 |
Remarks
Get a phone number by name
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumberByNameWithHttpInfo(string, int)
Get a phone number by name
Declaration
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 |
Remarks
Get a phone number by name
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumberByPhoneNumber(string, int)
Get a phone number by phone number
Declaration
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 |
Remarks
Get a phone number by phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumberByPhoneNumberWithHttpInfo(string, int)
Get a phone number by phone number
Declaration
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 |
Remarks
Get a phone number by phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhoneNumberWithHttpInfo(Guid, int)
Get a phone number by ID
Declaration
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 |
Remarks
Get a phone number by ID
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
Declaration
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 |
Remarks
List phone numbers for account
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
Declaration
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 |
Remarks
List phone numbers for account
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhonePlans(int)
Get phone plans
Declaration
List<PhonePlanDto> GetPhonePlans(int operationIndex = 0)Parameters
| Type | Name | Description |
|---|---|---|
| int | operationIndex | Index associated with the operation. |
Returns
| Type | Description |
|---|---|
| List<PhonePlanDto> | List<PhonePlanDto> |
Remarks
Get phone number plans
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
GetPhonePlansAvailability(int)
Get phone plans availability
Declaration
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 |
GetPhonePlansAvailabilityWithHttpInfo(int)
Get phone plans availability
Declaration
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 |
GetPhonePlansWithHttpInfo(int)
Get phone plans
Declaration
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> |
Remarks
Get phone number plans
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
Declaration
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 |
Remarks
Get sent SMS messages for a phone number
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
Declaration
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 |
Remarks
Get sent SMS messages for a phone number
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
Declaration
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 |
Remarks
Get SMS messages for a phone number
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
Declaration
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 |
Remarks
Get SMS messages for a phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SendSmsFromPhoneNumber(Guid, SmsSendOptions, int)
Send TXT message from a phone number
Declaration
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 |
Remarks
Send SMS from a phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SendSmsFromPhoneNumberWithHttpInfo(Guid, SmsSendOptions, int)
Send TXT message from a phone number
Declaration
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 |
Remarks
Send SMS from a phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SetConsentStatus(bool, int)
Set consent status
Declaration
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 |
Remarks
Give or revoke consent for phone usage
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SetConsentStatusWithHttpInfo(bool, int)
Set consent status
Declaration
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 |
Remarks
Give or revoke consent for phone usage
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SetPhoneFavourited(Guid, SetPhoneFavouritedOptions, int)
Set phone favourited state
Declaration
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 |
Remarks
Set and return new favorite state for a phone
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
SetPhoneFavouritedWithHttpInfo(Guid, SetPhoneFavouritedOptions, int)
Set phone favourited state
Declaration
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 |
Remarks
Set and return new favorite state for a phone
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
TestPhoneNumberSendSms(Guid, TestPhoneNumberOptions, string, int)
Test sending an SMS to a number
Declaration
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. |
Remarks
Test a phone number by sending an SMS to it
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
TestPhoneNumberSendSmsWithHttpInfo(Guid, TestPhoneNumberOptions, string, int)
Test sending an SMS to a number
Declaration
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) |
Remarks
Test a phone number by sending an SMS to it
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdatePhoneNumber(Guid, UpdatePhoneNumberOptions, int)
Update a phone number
Declaration
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 |
Remarks
Set field for phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
UpdatePhoneNumberWithHttpInfo(Guid, UpdatePhoneNumberOptions, int)
Update a phone number
Declaration
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 |
Remarks
Set field for phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ValidatePhoneNumber(ValidatePhoneNumberOptions, int)
Verify validity of a phone number
Declaration
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 |
Remarks
Validate a phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |
ValidatePhoneNumberWithHttpInfo(ValidatePhoneNumberOptions, int)
Verify validity of a phone number
Declaration
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 |
Remarks
Validate a phone number
Exceptions
| Type | Condition |
|---|---|
| ApiException | Thrown when fails to make API call |