SmsControllerApi
in package
SmsControllerApi Class Doc Comment
Tags
Table of Contents
- contentTypes = ['deleteSmsMessage' => ['application/json'], 'deleteSmsMessages' => ['application/json'], 'getReplyForSmsMessage' => ['application/json'], 'getSmsCount' => ['application/json'], 'getSmsMessage' => ['application/json'], 'getSmsMessagesPaginated' => ['application/json'], 'getUnreadSmsCount' => ['application/json'], 'replyToSmsMessage' => ['application/json']]
- $client : ClientInterface
- $config : Configuration
- $headerSelector : HeaderSelector
- $hostIndex : int
- __construct() : mixed
- deleteSmsMessage() : void
- Operation deleteSmsMessage
- deleteSmsMessageAsync() : PromiseInterface
- Operation deleteSmsMessageAsync
- deleteSmsMessageAsyncWithHttpInfo() : PromiseInterface
- Operation deleteSmsMessageAsyncWithHttpInfo
- deleteSmsMessageRequest() : Request
- Create request for operation 'deleteSmsMessage'
- deleteSmsMessages() : void
- Operation deleteSmsMessages
- deleteSmsMessagesAsync() : PromiseInterface
- Operation deleteSmsMessagesAsync
- deleteSmsMessagesAsyncWithHttpInfo() : PromiseInterface
- Operation deleteSmsMessagesAsyncWithHttpInfo
- deleteSmsMessagesRequest() : Request
- Create request for operation 'deleteSmsMessages'
- deleteSmsMessagesWithHttpInfo() : array<string|int, mixed>
- Operation deleteSmsMessagesWithHttpInfo
- deleteSmsMessageWithHttpInfo() : array<string|int, mixed>
- Operation deleteSmsMessageWithHttpInfo
- getConfig() : Configuration
- getHostIndex() : int
- Get the host index
- getReplyForSmsMessage() : ReplyForSms
- Operation getReplyForSmsMessage
- getReplyForSmsMessageAsync() : PromiseInterface
- Operation getReplyForSmsMessageAsync
- getReplyForSmsMessageAsyncWithHttpInfo() : PromiseInterface
- Operation getReplyForSmsMessageAsyncWithHttpInfo
- getReplyForSmsMessageRequest() : Request
- Create request for operation 'getReplyForSmsMessage'
- getReplyForSmsMessageWithHttpInfo() : array<string|int, mixed>
- Operation getReplyForSmsMessageWithHttpInfo
- getSmsCount() : CountDto
- Operation getSmsCount
- getSmsCountAsync() : PromiseInterface
- Operation getSmsCountAsync
- getSmsCountAsyncWithHttpInfo() : PromiseInterface
- Operation getSmsCountAsyncWithHttpInfo
- getSmsCountRequest() : Request
- Create request for operation 'getSmsCount'
- getSmsCountWithHttpInfo() : array<string|int, mixed>
- Operation getSmsCountWithHttpInfo
- getSmsMessage() : SmsDto
- Operation getSmsMessage
- getSmsMessageAsync() : PromiseInterface
- Operation getSmsMessageAsync
- getSmsMessageAsyncWithHttpInfo() : PromiseInterface
- Operation getSmsMessageAsyncWithHttpInfo
- getSmsMessageRequest() : Request
- Create request for operation 'getSmsMessage'
- getSmsMessagesPaginated() : PageSmsProjection
- Operation getSmsMessagesPaginated
- getSmsMessagesPaginatedAsync() : PromiseInterface
- Operation getSmsMessagesPaginatedAsync
- getSmsMessagesPaginatedAsyncWithHttpInfo() : PromiseInterface
- Operation getSmsMessagesPaginatedAsyncWithHttpInfo
- getSmsMessagesPaginatedRequest() : Request
- Create request for operation 'getSmsMessagesPaginated'
- getSmsMessagesPaginatedWithHttpInfo() : array<string|int, mixed>
- Operation getSmsMessagesPaginatedWithHttpInfo
- getSmsMessageWithHttpInfo() : array<string|int, mixed>
- Operation getSmsMessageWithHttpInfo
- getUnreadSmsCount() : UnreadCount
- Operation getUnreadSmsCount
- getUnreadSmsCountAsync() : PromiseInterface
- Operation getUnreadSmsCountAsync
- getUnreadSmsCountAsyncWithHttpInfo() : PromiseInterface
- Operation getUnreadSmsCountAsyncWithHttpInfo
- getUnreadSmsCountRequest() : Request
- Create request for operation 'getUnreadSmsCount'
- getUnreadSmsCountWithHttpInfo() : array<string|int, mixed>
- Operation getUnreadSmsCountWithHttpInfo
- replyToSmsMessage() : SentSmsDto
- Operation replyToSmsMessage
- replyToSmsMessageAsync() : PromiseInterface
- Operation replyToSmsMessageAsync
- replyToSmsMessageAsyncWithHttpInfo() : PromiseInterface
- Operation replyToSmsMessageAsyncWithHttpInfo
- replyToSmsMessageRequest() : Request
- Create request for operation 'replyToSmsMessage'
- replyToSmsMessageWithHttpInfo() : array<string|int, mixed>
- Operation replyToSmsMessageWithHttpInfo
- setHostIndex() : void
- Set the host index
- createHttpClientOption() : array<string|int, mixed>
- Create http client option
Constants
contentTypes
public
array<string|int, string>
contentTypes
= ['deleteSmsMessage' => ['application/json'], 'deleteSmsMessages' => ['application/json'], 'getReplyForSmsMessage' => ['application/json'], 'getSmsCount' => ['application/json'], 'getSmsMessage' => ['application/json'], 'getSmsMessagesPaginated' => ['application/json'], 'getUnreadSmsCount' => ['application/json'], 'replyToSmsMessage' => ['application/json']]
Properties
$client
protected
ClientInterface
$client
$config
protected
Configuration
$config
$headerSelector
protected
HeaderSelector
$headerSelector
$hostIndex
protected
int
$hostIndex
Host index
Methods
__construct()
public
__construct([ClientInterface $client = null ][, Configuration $config = null ][, HeaderSelector $selector = null ], int $hostIndex) : mixed
Parameters
- $client : ClientInterface = null
- $config : Configuration = null
- $selector : HeaderSelector = null
- $hostIndex : int
-
(Optional) host index to select the list of hosts if defined in the OpenAPI spec
Return values
mixed —deleteSmsMessage()
Operation deleteSmsMessage
public
deleteSmsMessage(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : void
Delete SMS message.
Parameters
- $sms_id : string
-
sms_id (required)
- $contentType : string = self::contentTypes['deleteSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation
Tags
Return values
void —deleteSmsMessageAsync()
Operation deleteSmsMessageAsync
public
deleteSmsMessageAsync(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : PromiseInterface
Delete SMS message.
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSmsMessageAsyncWithHttpInfo()
Operation deleteSmsMessageAsyncWithHttpInfo
public
deleteSmsMessageAsyncWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : PromiseInterface
Delete SMS message.
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSmsMessageRequest()
Create request for operation 'deleteSmsMessage'
public
deleteSmsMessageRequest(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : Request
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation
Tags
Return values
Request —deleteSmsMessages()
Operation deleteSmsMessages
public
deleteSmsMessages([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : void
Delete all SMS messages
Parameters
- $phone_number_id : string = null
-
phone_number_id (optional)
- $contentType : string = self::contentTypes['deleteSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation
Tags
Return values
void —deleteSmsMessagesAsync()
Operation deleteSmsMessagesAsync
public
deleteSmsMessagesAsync([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : PromiseInterface
Delete all SMS messages
Parameters
- $phone_number_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSmsMessagesAsyncWithHttpInfo()
Operation deleteSmsMessagesAsyncWithHttpInfo
public
deleteSmsMessagesAsyncWithHttpInfo([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : PromiseInterface
Delete all SMS messages
Parameters
- $phone_number_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation
Tags
Return values
PromiseInterface —deleteSmsMessagesRequest()
Create request for operation 'deleteSmsMessages'
public
deleteSmsMessagesRequest([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : Request
Parameters
- $phone_number_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation
Tags
Return values
Request —deleteSmsMessagesWithHttpInfo()
Operation deleteSmsMessagesWithHttpInfo
public
deleteSmsMessagesWithHttpInfo([string $phone_number_id = null ][, string $contentType = self::contentTypes['deleteSmsMessages'][0] ]) : array<string|int, mixed>
Delete all SMS messages
Parameters
- $phone_number_id : string = null
-
(optional)
- $contentType : string = self::contentTypes['deleteSmsMessages'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessages'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
deleteSmsMessageWithHttpInfo()
Operation deleteSmsMessageWithHttpInfo
public
deleteSmsMessageWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['deleteSmsMessage'][0] ]) : array<string|int, mixed>
Delete SMS message.
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['deleteSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['deleteSmsMessage'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of null, HTTP status code, HTTP response headers (array of strings)
getConfig()
public
getConfig() : Configuration
Return values
Configuration —getHostIndex()
Get the host index
public
getHostIndex() : int
Return values
int —Host index
getReplyForSmsMessage()
Operation getReplyForSmsMessage
public
getReplyForSmsMessage(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : ReplyForSms
Get reply for an SMS message
Parameters
- $sms_id : string
-
sms_id (required)
- $contentType : string = self::contentTypes['getReplyForSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation
Tags
Return values
ReplyForSms —getReplyForSmsMessageAsync()
Operation getReplyForSmsMessageAsync
public
getReplyForSmsMessageAsync(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : PromiseInterface
Get reply for an SMS message
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getReplyForSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getReplyForSmsMessageAsyncWithHttpInfo()
Operation getReplyForSmsMessageAsyncWithHttpInfo
public
getReplyForSmsMessageAsyncWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : PromiseInterface
Get reply for an SMS message
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getReplyForSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getReplyForSmsMessageRequest()
Create request for operation 'getReplyForSmsMessage'
public
getReplyForSmsMessageRequest(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : Request
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getReplyForSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation
Tags
Return values
Request —getReplyForSmsMessageWithHttpInfo()
Operation getReplyForSmsMessageWithHttpInfo
public
getReplyForSmsMessageWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getReplyForSmsMessage'][0] ]) : array<string|int, mixed>
Get reply for an SMS message
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getReplyForSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getReplyForSmsMessage'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\ReplyForSms, HTTP status code, HTTP response headers (array of strings)
getSmsCount()
Operation getSmsCount
public
getSmsCount([string $contentType = self::contentTypes['getSmsCount'][0] ]) : CountDto
Get SMS count
Parameters
- $contentType : string = self::contentTypes['getSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation
Tags
Return values
CountDto —getSmsCountAsync()
Operation getSmsCountAsync
public
getSmsCountAsync([string $contentType = self::contentTypes['getSmsCount'][0] ]) : PromiseInterface
Get SMS count
Parameters
- $contentType : string = self::contentTypes['getSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSmsCountAsyncWithHttpInfo()
Operation getSmsCountAsyncWithHttpInfo
public
getSmsCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getSmsCount'][0] ]) : PromiseInterface
Get SMS count
Parameters
- $contentType : string = self::contentTypes['getSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSmsCountRequest()
Create request for operation 'getSmsCount'
public
getSmsCountRequest([string $contentType = self::contentTypes['getSmsCount'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation
Tags
Return values
Request —getSmsCountWithHttpInfo()
Operation getSmsCountWithHttpInfo
public
getSmsCountWithHttpInfo([string $contentType = self::contentTypes['getSmsCount'][0] ]) : array<string|int, mixed>
Get SMS count
Parameters
- $contentType : string = self::contentTypes['getSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsCount'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\CountDto, HTTP status code, HTTP response headers (array of strings)
getSmsMessage()
Operation getSmsMessage
public
getSmsMessage(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : SmsDto
Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
Parameters
- $sms_id : string
-
sms_id (required)
- $contentType : string = self::contentTypes['getSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation
Tags
Return values
SmsDto —getSmsMessageAsync()
Operation getSmsMessageAsync
public
getSmsMessageAsync(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : PromiseInterface
Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSmsMessageAsyncWithHttpInfo()
Operation getSmsMessageAsyncWithHttpInfo
public
getSmsMessageAsyncWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : PromiseInterface
Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSmsMessageRequest()
Create request for operation 'getSmsMessage'
public
getSmsMessageRequest(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : Request
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation
Tags
Return values
Request —getSmsMessagesPaginated()
Operation getSmsMessagesPaginated
public
getSmsMessagesPaginated([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSmsMessagesPaginated'][0] ]) : PageSmsProjection
Get all SMS messages in all phone numbers in paginated form. .
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter SMS messages for (optional)
- $page : int
-
Optional page index in SMS list pagination (optional, default to 0)
- $size : int = 20
-
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)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $unread_only : bool = false
-
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)
- $since : DateTime = null
-
Optional filter SMSs received after given date time (optional)
- $before : DateTime = null
-
Optional filter SMSs received before given date time (optional)
- $contentType : string = self::contentTypes['getSmsMessagesPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessagesPaginated'] to see the possible values for this operation
Tags
Return values
PageSmsProjection —getSmsMessagesPaginatedAsync()
Operation getSmsMessagesPaginatedAsync
public
getSmsMessagesPaginatedAsync([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSmsMessagesPaginated'][0] ]) : PromiseInterface
Get all SMS messages in all phone numbers in paginated form. .
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter SMS messages for (optional)
- $page : int
-
Optional page index in SMS list pagination (optional, default to 0)
- $size : int = 20
-
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)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $unread_only : bool = false
-
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)
- $since : DateTime = null
-
Optional filter SMSs received after given date time (optional)
- $before : DateTime = null
-
Optional filter SMSs received before given date time (optional)
- $contentType : string = self::contentTypes['getSmsMessagesPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessagesPaginated'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSmsMessagesPaginatedAsyncWithHttpInfo()
Operation getSmsMessagesPaginatedAsyncWithHttpInfo
public
getSmsMessagesPaginatedAsyncWithHttpInfo([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSmsMessagesPaginated'][0] ]) : PromiseInterface
Get all SMS messages in all phone numbers in paginated form. .
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter SMS messages for (optional)
- $page : int
-
Optional page index in SMS list pagination (optional, default to 0)
- $size : int = 20
-
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)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $unread_only : bool = false
-
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)
- $since : DateTime = null
-
Optional filter SMSs received after given date time (optional)
- $before : DateTime = null
-
Optional filter SMSs received before given date time (optional)
- $contentType : string = self::contentTypes['getSmsMessagesPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessagesPaginated'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getSmsMessagesPaginatedRequest()
Create request for operation 'getSmsMessagesPaginated'
public
getSmsMessagesPaginatedRequest([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSmsMessagesPaginated'][0] ]) : Request
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter SMS messages for (optional)
- $page : int
-
Optional page index in SMS list pagination (optional, default to 0)
- $size : int = 20
-
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)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $unread_only : bool = false
-
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)
- $since : DateTime = null
-
Optional filter SMSs received after given date time (optional)
- $before : DateTime = null
-
Optional filter SMSs received before given date time (optional)
- $contentType : string = self::contentTypes['getSmsMessagesPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessagesPaginated'] to see the possible values for this operation
Tags
Return values
Request —getSmsMessagesPaginatedWithHttpInfo()
Operation getSmsMessagesPaginatedWithHttpInfo
public
getSmsMessagesPaginatedWithHttpInfo([string $phone_number = null ], int $page[, int $size = 20 ][, string $sort = 'ASC' ][, bool $unread_only = false ][, DateTime $since = null ][, DateTime $before = null ][, string $contentType = self::contentTypes['getSmsMessagesPaginated'][0] ]) : array<string|int, mixed>
Get all SMS messages in all phone numbers in paginated form. .
Parameters
- $phone_number : string = null
-
Optional receiving phone number to filter SMS messages for (optional)
- $page : int
-
Optional page index in SMS list pagination (optional, default to 0)
- $size : int = 20
-
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)
- $sort : string = 'ASC'
-
Optional createdAt sort direction ASC or DESC (optional, default to 'ASC')
- $unread_only : bool = false
-
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)
- $since : DateTime = null
-
Optional filter SMSs received after given date time (optional)
- $before : DateTime = null
-
Optional filter SMSs received before given date time (optional)
- $contentType : string = self::contentTypes['getSmsMessagesPaginated'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessagesPaginated'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\PageSmsProjection, HTTP status code, HTTP response headers (array of strings)
getSmsMessageWithHttpInfo()
Operation getSmsMessageWithHttpInfo
public
getSmsMessageWithHttpInfo(string $sms_id[, string $contentType = self::contentTypes['getSmsMessage'][0] ]) : array<string|int, mixed>
Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController.
Parameters
- $sms_id : string
-
(required)
- $contentType : string = self::contentTypes['getSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['getSmsMessage'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SmsDto, HTTP status code, HTTP response headers (array of strings)
getUnreadSmsCount()
Operation getUnreadSmsCount
public
getUnreadSmsCount([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : UnreadCount
Get unread SMS count
Parameters
- $contentType : string = self::contentTypes['getUnreadSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation
Tags
Return values
UnreadCount —getUnreadSmsCountAsync()
Operation getUnreadSmsCountAsync
public
getUnreadSmsCountAsync([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : PromiseInterface
Get unread SMS count
Parameters
- $contentType : string = self::contentTypes['getUnreadSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUnreadSmsCountAsyncWithHttpInfo()
Operation getUnreadSmsCountAsyncWithHttpInfo
public
getUnreadSmsCountAsyncWithHttpInfo([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : PromiseInterface
Get unread SMS count
Parameters
- $contentType : string = self::contentTypes['getUnreadSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation
Tags
Return values
PromiseInterface —getUnreadSmsCountRequest()
Create request for operation 'getUnreadSmsCount'
public
getUnreadSmsCountRequest([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : Request
Parameters
- $contentType : string = self::contentTypes['getUnreadSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation
Tags
Return values
Request —getUnreadSmsCountWithHttpInfo()
Operation getUnreadSmsCountWithHttpInfo
public
getUnreadSmsCountWithHttpInfo([string $contentType = self::contentTypes['getUnreadSmsCount'][0] ]) : array<string|int, mixed>
Get unread SMS count
Parameters
- $contentType : string = self::contentTypes['getUnreadSmsCount'][0]
-
The value for the Content-Type header. Check self::contentTypes['getUnreadSmsCount'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\UnreadCount, HTTP status code, HTTP response headers (array of strings)
replyToSmsMessage()
Operation replyToSmsMessage
public
replyToSmsMessage(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : SentSmsDto
Send a reply to a received SMS message. Replies are sent from the receiving number.
Parameters
- $sms_id : string
-
sms_id (required)
- $sms_reply_options : SmsReplyOptions
-
sms_reply_options (required)
- $contentType : string = self::contentTypes['replyToSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation
Tags
Return values
SentSmsDto —replyToSmsMessageAsync()
Operation replyToSmsMessageAsync
public
replyToSmsMessageAsync(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : PromiseInterface
Send a reply to a received SMS message. Replies are sent from the receiving number.
Parameters
- $sms_id : string
-
(required)
- $sms_reply_options : SmsReplyOptions
-
(required)
- $contentType : string = self::contentTypes['replyToSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —replyToSmsMessageAsyncWithHttpInfo()
Operation replyToSmsMessageAsyncWithHttpInfo
public
replyToSmsMessageAsyncWithHttpInfo(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : PromiseInterface
Send a reply to a received SMS message. Replies are sent from the receiving number.
Parameters
- $sms_id : string
-
(required)
- $sms_reply_options : SmsReplyOptions
-
(required)
- $contentType : string = self::contentTypes['replyToSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation
Tags
Return values
PromiseInterface —replyToSmsMessageRequest()
Create request for operation 'replyToSmsMessage'
public
replyToSmsMessageRequest(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : Request
Parameters
- $sms_id : string
-
(required)
- $sms_reply_options : SmsReplyOptions
-
(required)
- $contentType : string = self::contentTypes['replyToSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation
Tags
Return values
Request —replyToSmsMessageWithHttpInfo()
Operation replyToSmsMessageWithHttpInfo
public
replyToSmsMessageWithHttpInfo(string $sms_id, SmsReplyOptions $sms_reply_options[, string $contentType = self::contentTypes['replyToSmsMessage'][0] ]) : array<string|int, mixed>
Send a reply to a received SMS message. Replies are sent from the receiving number.
Parameters
- $sms_id : string
-
(required)
- $sms_reply_options : SmsReplyOptions
-
(required)
- $contentType : string = self::contentTypes['replyToSmsMessage'][0]
-
The value for the Content-Type header. Check self::contentTypes['replyToSmsMessage'] to see the possible values for this operation
Tags
Return values
array<string|int, mixed> —of \MailSlurp\Models\SentSmsDto, HTTP status code, HTTP response headers (array of strings)
setHostIndex()
Set the host index
public
setHostIndex(int $hostIndex) : void
Parameters
- $hostIndex : int
-
Host index (required)
Return values
void —createHttpClientOption()
Create http client option
protected
createHttpClientOption() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of http client options