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

DeleteSmsMessageAsync(Guid, int, CancellationToken)

Delete SMS message.

Declaration
Task DeleteSmsMessageAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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

DeleteSmsMessagesAsync(Guid?, int, CancellationToken)

Delete all SMS messages

Declaration
Task DeleteSmsMessagesAsync(Guid? phoneNumberId = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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
System.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

DeleteSmsMessageWithHttpInfoAsync(Guid, int, CancellationToken)

Delete SMS message.

Declaration
Task<ApiResponse<object>> DeleteSmsMessageWithHttpInfoAsync(Guid smsId, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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

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
System.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
System.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

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
System.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

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

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

Declaration
Task<PageSmsProjection> GetSmsMessagesPaginatedAsync(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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)
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)
int operationIndex

Index associated with the operation.
CancellationToken cancellationToken

Cancellation Token to cancel the request.
Returns
Type Description
Task<PageSmsProjection>

Task of PageSmsProjection
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

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

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

Declaration
Task<ApiResponse<PageSmsProjection>> GetSmsMessagesPaginatedWithHttpInfoAsync(Guid? phoneNumber = null, int? page = null, int? size = null, string sort = null, bool? unreadOnly = null, DateTime? since = null, DateTime? before = null, int operationIndex = 0, CancellationToken cancellationToken = default)
Parameters
Type Name Description
System.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)
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)
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

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

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
System.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
System.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
System.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