Interface ISmsControllerApiAsync

Represents a collection of functions to interact with the API endpoints

Inherited Members

Namespace: mailslurp.Api

Assembly: mailslurp.dll

Syntax

public interface ISmsControllerApiAsync : IApiAccessor

Methods

View Source

DeleteSentSmsMessageAsync(Guid, int, CancellationToken)

Delete sent SMS message.

Declaration

Task DeleteSentSmsMessageAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete a sent SMS message

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSentSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Delete sent SMS message.

Declaration

Task<ApiResponse<object>> DeleteSentSmsMessageWithHttpInfoAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	sentSmsId
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

Delete a sent SMS message

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSentSmsMessagesAsync(Guid?, int, CancellationToken)

Delete all sent SMS messages

Declaration

Task DeleteSentSmsMessagesAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete all sent SMS messages or all messages for a given phone number

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSentSmsMessagesWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete all sent SMS messages

Declaration

Task<ApiResponse<object>> DeleteSentSmsMessagesWithHttpInfoAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(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

Delete all sent SMS messages or all messages for a given phone number

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSmsMessageAsync(Guid, int, CancellationToken)

Delete SMS message.

Declaration

Task DeleteSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete an SMS message

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Delete SMS message.

Declaration

Task<ApiResponse<object>> DeleteSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	smsId
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

Delete an SMS message

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSmsMessagesAsync(Guid?, int, CancellationToken)

Delete all SMS messages

Declaration

Task DeleteSmsMessagesAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task	Task of void

Remarks

Delete all SMS messages or all messages for a given phone number

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

DeleteSmsMessagesWithHttpInfoAsync(Guid?, int, CancellationToken)

Delete all SMS messages

Declaration

Task<ApiResponse<object>> DeleteSmsMessagesWithHttpInfoAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid?	phoneNumberId	(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

Delete all SMS messages or all messages for a given phone number

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Declaration

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

Parameters

Type	Name	Description
Guid?	phoneNumber	Optional receiving phone number to filter SMS messages for (optional)
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)
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

View Source

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

Declaration

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

Parameters

Type	Name	Description
Guid?	phoneNumber	Optional receiving phone number to filter SMS messages for (optional)
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)
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

View Source

GetReplyForSmsMessageAsync(Guid, int, CancellationToken)

Get reply for an SMS message

Declaration

Task<ReplyForSms> GetReplyForSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<ReplyForSms>	Task of ReplyForSms

Remarks

Get reply for an SMS message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetReplyForSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get reply for an SMS message

Declaration

Task<ApiResponse<ReplyForSms>> GetReplyForSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Get reply for an SMS message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSentSmsCountAsync(int, CancellationToken)

Get sent SMS count

Declaration

Task<CountDto> GetSentSmsCountAsync(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<CountDto>	Task of CountDto

Remarks

Get number of sent SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSentSmsCountWithHttpInfoAsync(int, CancellationToken)

Get sent SMS count

Declaration

Task<ApiResponse<CountDto>> GetSentSmsCountWithHttpInfoAsync(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<CountDto>>	Task of ApiResponse (CountDto)

Remarks

Get number of sent SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSentSmsMessageAsync(Guid, int, CancellationToken)

Get sent SMS content including body. Expects sent SMS to exist by ID.

Declaration

Task<SentSmsDto> GetSentSmsMessageAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SentSmsDto>	Task of SentSmsDto

Remarks

Returns an SMS summary object with content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSentSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get sent SMS content including body. Expects sent SMS to exist by ID.

Declaration

Task<ApiResponse<SentSmsDto>> GetSentSmsMessageWithHttpInfoAsync(Guid sentSmsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	sentSmsId
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

Returns an SMS summary object with content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all SMS messages in all phone numbers in paginated form. .

Declaration

Task<PageSentSmsProjection> GetSentSmsMessagesPaginatedAsync(Guid? phoneNumber = null, 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?	phoneNumber	Optional phone number to filter sent SMS messages for (optional)
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

By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

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

Get all SMS messages in all phone numbers in paginated form. .

Declaration

Task<ApiResponse<PageSentSmsProjection>> GetSentSmsMessagesPaginatedWithHttpInfoAsync(Guid? phoneNumber = null, 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?	phoneNumber	Optional phone number to filter sent SMS messages for (optional)
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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmsCountAsync(int, CancellationToken)

Get SMS count

Declaration

Task<CountDto> GetSmsCountAsync(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<CountDto>	Task of CountDto

Remarks

Get number of SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmsCountWithHttpInfoAsync(int, CancellationToken)

Get SMS count

Declaration

Task<ApiResponse<CountDto>> GetSmsCountWithHttpInfoAsync(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<CountDto>>	Task of ApiResponse (CountDto)

Remarks

Get number of SMS

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmsMessageAsync(Guid, int, CancellationToken)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Declaration

Task<SmsDto> GetSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SmsDto>	Task of SmsDto

Remarks

Returns a SMS summary object with content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.

Declaration

Task<ApiResponse<SmsDto>> GetSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

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

Remarks

Returns a SMS summary object with content.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUnreadSmsCountAsync(int, CancellationToken)

Get unread SMS count

Declaration

Task<UnreadCount> GetUnreadSmsCountAsync(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<UnreadCount>	Task of UnreadCount

Remarks

Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

GetUnreadSmsCountWithHttpInfoAsync(int, CancellationToken)

Get unread SMS count

Declaration

Task<ApiResponse<UnreadCount>> GetUnreadSmsCountWithHttpInfoAsync(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<UnreadCount>>	Task of ApiResponse (UnreadCount)

Remarks

Get number of SMS unread. Unread means has not been viewed in dashboard or returned in an email API response

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ReplyToSmsMessageAsync(Guid, SmsReplyOptions, int, CancellationToken)

Send a reply to a received SMS message. Replies are sent from the receiving number.

Declaration

Task<SentSmsDto> ReplyToSmsMessageAsync(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<SentSmsDto>	Task of SentSmsDto

Remarks

Reply to an SMS message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

ReplyToSmsMessageWithHttpInfoAsync(Guid, SmsReplyOptions, int, CancellationToken)

Send a reply to a received SMS message. Replies are sent from the receiving number.

Declaration

Task<ApiResponse<SentSmsDto>> ReplyToSmsMessageWithHttpInfoAsync(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	smsId
SmsReplyOptions	smsReplyOptions
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

Reply to an SMS message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SendSmsAsync(SmsSendOptions, string, Guid?, int, CancellationToken)

Declaration

Task<SentSmsDto> SendSmsAsync(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SmsSendOptions	smsSendOptions
string	fromPhoneNumber	Phone number to send from in E.164 format (optional)
Guid?	fromPhoneId	Phone number ID to send from in UUID form (optional)
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

View Source

SendSmsWithHttpInfoAsync(SmsSendOptions, string, Guid?, int, CancellationToken)

Declaration

Task<ApiResponse<SentSmsDto>> SendSmsWithHttpInfoAsync(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SmsSendOptions	smsSendOptions
string	fromPhoneNumber	Phone number to send from in E.164 format (optional)
Guid?	fromPhoneId	Phone number ID to send from in UUID form (optional)
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

View Source

SetSmsFavouritedAsync(Guid, bool, int, CancellationToken)

Declaration

Task<SmsDto> SetSmsFavouritedAsync(Guid smsId, bool favourited, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	smsId	ID of SMS to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

Type	Description
Task<SmsDto>	Task of SmsDto

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

View Source

SetSmsFavouritedWithHttpInfoAsync(Guid, bool, int, CancellationToken)

Declaration

Task<ApiResponse<SmsDto>> SetSmsFavouritedWithHttpInfoAsync(Guid smsId, bool favourited, int operationIndex = 0, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
Guid	smsId	ID of SMS to set favourite state
bool	favourited
int	operationIndex	Index associated with the operation.
CancellationToken	cancellationToken	Cancellation Token to cancel the request.

Returns

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

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call