Interface ISmsControllerApiSync

Represents a collection of functions to interact with the API endpoints

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

Methods

View Source

DeleteSentSmsMessage(Guid, int)

Delete sent SMS message.

Declaration
void DeleteSentSmsMessage(Guid sentSmsId, int operationIndex = 0)
Parameters
Type Name Description
Guid sentSmsId
int operationIndex

Index associated with the operation.
Remarks

Delete a sent SMS message

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteSentSmsMessageWithHttpInfo(Guid, int)

Delete sent SMS message.

Declaration
ApiResponse<object> DeleteSentSmsMessageWithHttpInfo(Guid sentSmsId, int operationIndex = 0)
Parameters
Type Name Description
Guid sentSmsId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

Delete a sent SMS message

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteSentSmsMessages(Guid?, int)

Delete all sent SMS messages

Declaration
void DeleteSentSmsMessages(Guid? phoneNumberId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? phoneNumberId

(optional)
int operationIndex

Index associated with the operation.
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

DeleteSentSmsMessagesWithHttpInfo(Guid?, int)

Delete all sent SMS messages

Declaration
ApiResponse<object> DeleteSentSmsMessagesWithHttpInfo(Guid? phoneNumberId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? phoneNumberId

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(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

DeleteSmsMessage(Guid, int)

Delete SMS message.

Declaration
void DeleteSmsMessage(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
int operationIndex

Index associated with the operation.
Remarks

Delete an SMS message

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteSmsMessageWithHttpInfo(Guid, int)

Delete SMS message.

Declaration
ApiResponse<object> DeleteSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(void)
Remarks

Delete an SMS message

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

DeleteSmsMessages(Guid?, int)

Delete all SMS messages

Declaration
void DeleteSmsMessages(Guid? phoneNumberId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? phoneNumberId

(optional)
int operationIndex

Index associated with the operation.
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

DeleteSmsMessagesWithHttpInfo(Guid?, int)

Delete all SMS messages

Declaration
ApiResponse<object> DeleteSmsMessagesWithHttpInfo(Guid? phoneNumberId = null, int operationIndex = 0)
Parameters
Type Name Description
Guid? phoneNumberId

(optional)
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<object>

ApiResponse of Object(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

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

Declaration
PageSmsProjection GetAllSmsMessages(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)
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.
Returns
Type Description
PageSmsProjection

PageSmsProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

Declaration
ApiResponse<PageSmsProjection> GetAllSmsMessagesWithHttpInfo(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)
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.
Returns
Type Description
ApiResponse<PageSmsProjection>

ApiResponse of PageSmsProjection
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetReplyForSmsMessage(Guid, int)

Get reply for an SMS message

Declaration
ReplyForSms GetReplyForSmsMessage(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
int operationIndex

Index associated with the operation.
Returns
Type Description
ReplyForSms

ReplyForSms
Remarks

Get reply for an SMS message.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetReplyForSmsMessageWithHttpInfo(Guid, int)

Get reply for an SMS message

Declaration
ApiResponse<ReplyForSms> GetReplyForSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<ReplyForSms>

ApiResponse of ReplyForSms
Remarks

Get reply for an SMS message.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSentSmsCount(int)

Get sent SMS count

Declaration
CountDto GetSentSmsCount(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
CountDto

CountDto
Remarks

Get number of sent SMS

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSentSmsCountWithHttpInfo(int)

Get sent SMS count

Declaration
ApiResponse<CountDto> GetSentSmsCountWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CountDto>

ApiResponse of CountDto
Remarks

Get number of sent SMS

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSentSmsMessage(Guid, int)

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

Declaration
SentSmsDto GetSentSmsMessage(Guid sentSmsId, int operationIndex = 0)
Parameters
Type Name Description
Guid sentSmsId
int operationIndex

Index associated with the operation.
Returns
Type Description
SentSmsDto

SentSmsDto
Remarks

Returns an SMS summary object with content.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSentSmsMessageWithHttpInfo(Guid, int)

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

Declaration
ApiResponse<SentSmsDto> GetSentSmsMessageWithHttpInfo(Guid sentSmsId, int operationIndex = 0)
Parameters
Type Name Description
Guid sentSmsId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SentSmsDto>

ApiResponse of SentSmsDto
Remarks

Returns an SMS summary object with content.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

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

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

Declaration
PageSentSmsProjection GetSentSmsMessagesPaginated(Guid? phoneNumber = null, 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? 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.
Returns
Type Description
PageSentSmsProjection

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

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

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

Declaration
ApiResponse<PageSentSmsProjection> GetSentSmsMessagesPaginatedWithHttpInfo(Guid? phoneNumber = null, 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? 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.
Returns
Type Description
ApiResponse<PageSentSmsProjection>

ApiResponse 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

GetSmsCount(int)

Get SMS count

Declaration
CountDto GetSmsCount(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
CountDto

CountDto
Remarks

Get number of SMS

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSmsCountWithHttpInfo(int)

Get SMS count

Declaration
ApiResponse<CountDto> GetSmsCountWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<CountDto>

ApiResponse of CountDto
Remarks

Get number of SMS

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSmsMessage(Guid, int)

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

Declaration
SmsDto GetSmsMessage(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
int operationIndex

Index associated with the operation.
Returns
Type Description
SmsDto

SmsDto
Remarks

Returns a SMS summary object with content.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetSmsMessageWithHttpInfo(Guid, int)

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

Declaration
ApiResponse<SmsDto> GetSmsMessageWithHttpInfo(Guid smsId, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SmsDto>

ApiResponse of SmsDto
Remarks

Returns a SMS summary object with content.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

GetUnreadSmsCount(int)

Get unread SMS count

Declaration
UnreadCount GetUnreadSmsCount(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
UnreadCount

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

GetUnreadSmsCountWithHttpInfo(int)

Get unread SMS count

Declaration
ApiResponse<UnreadCount> GetUnreadSmsCountWithHttpInfo(int operationIndex = 0)
Parameters
Type Name Description
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<UnreadCount>

ApiResponse 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

ReplyToSmsMessage(Guid, SmsReplyOptions, int)

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

Declaration
SentSmsDto ReplyToSmsMessage(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
SmsReplyOptions smsReplyOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
SentSmsDto

SentSmsDto
Remarks

Reply to an SMS message.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

ReplyToSmsMessageWithHttpInfo(Guid, SmsReplyOptions, int)

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

Declaration
ApiResponse<SentSmsDto> ReplyToSmsMessageWithHttpInfo(Guid smsId, SmsReplyOptions smsReplyOptions, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId
SmsReplyOptions smsReplyOptions
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SentSmsDto>

ApiResponse of SentSmsDto
Remarks

Reply to an SMS message.

Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendSms(SmsSendOptions, string, Guid?, int)

Declaration
SentSmsDto SendSms(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0)
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.
Returns
Type Description
SentSmsDto

SentSmsDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SendSmsWithHttpInfo(SmsSendOptions, string, Guid?, int)

Declaration
ApiResponse<SentSmsDto> SendSmsWithHttpInfo(SmsSendOptions smsSendOptions, string fromPhoneNumber = null, Guid? fromPhoneId = null, int operationIndex = 0)
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.
Returns
Type Description
ApiResponse<SentSmsDto>

ApiResponse of SentSmsDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetSmsFavourited(Guid, bool, int)

Declaration
SmsDto SetSmsFavourited(Guid smsId, bool favourited, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId

ID of SMS to set favourite state
bool favourited
int operationIndex

Index associated with the operation.
Returns
Type Description
SmsDto

SmsDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call
View Source

SetSmsFavouritedWithHttpInfo(Guid, bool, int)

Declaration
ApiResponse<SmsDto> SetSmsFavouritedWithHttpInfo(Guid smsId, bool favourited, int operationIndex = 0)
Parameters
Type Name Description
Guid smsId

ID of SMS to set favourite state
bool favourited
int operationIndex

Index associated with the operation.
Returns
Type Description
ApiResponse<SmsDto>

ApiResponse of SmsDto
Exceptions
Type Condition
ApiException

Thrown when fails to make API call