OpenAPI\Client\MessagesApi

All URIs are relative to https://api.thesmsworks.co.uk/v1, except if the operation defines another base path.

Method	HTTP request	Description
messageSchedulePost()	POST /message/schedule
messageSendPost()	POST /message/send
messagesFailedPost()	POST /messages/failed
messagesInboxPost()	POST /messages/inbox
messagesMessageidDelete()	DELETE /messages/{messageid}
messagesMessageidGet()	GET /messages/{messageid}
messagesPost()	POST /messages
messagesScheduleGet()	GET /messages/schedule
messagesScheduleMessageidDelete()	DELETE /messages/schedule/{messageid}
sendFlashMessage()	POST /message/flash

`messageSchedulePost()`

messageSchedulePost($sms_message): \OpenAPI\Client\Model\ScheduledMessageResponse[]

Schedules an SMS message to be sent at the date-time you specify

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sms_message = new \OpenAPI\Client\Model\Message(); // \OpenAPI\Client\Model\Message | Message properties

try {
    $result = $apiInstance->messageSchedulePost($sms_message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messageSchedulePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sms_message	\OpenAPI\Client\Model\Message	Message properties

Return type

\OpenAPI\Client\Model\ScheduledMessageResponse[]

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messageSendPost()`

messageSendPost($sms_message): \OpenAPI\Client\Model\SendMessageResponse

Send an SMS Message

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sms_message = new \OpenAPI\Client\Model\Message(); // \OpenAPI\Client\Model\Message | Message properties

try {
    $result = $apiInstance->messageSendPost($sms_message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messageSendPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sms_message	\OpenAPI\Client\Model\Message	Message properties

Return type

\OpenAPI\Client\Model\SendMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesFailedPost()`

messagesFailedPost($query): \OpenAPI\Client\Model\MessageResponse[]

Get failed messages matching your search criteria

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$query = new \OpenAPI\Client\Model\Query(); // \OpenAPI\Client\Model\Query

try {
    $result = $apiInstance->messagesFailedPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesFailedPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	\OpenAPI\Client\Model\Query

Return type

\OpenAPI\Client\Model\MessageResponse[]

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesInboxPost()`

messagesInboxPost($query): \OpenAPI\Client\Model\MessageResponse[]

Get unread uncoming messages matching your search criteria

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$query = new \OpenAPI\Client\Model\Query(); // \OpenAPI\Client\Model\Query

try {
    $result = $apiInstance->messagesInboxPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesInboxPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	\OpenAPI\Client\Model\Query

Return type

\OpenAPI\Client\Model\MessageResponse[]

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesMessageidDelete()`

messagesMessageidDelete($messageid): \OpenAPI\Client\Model\DeletedMessageResponse

Delete the message with the mathcing messageid

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$messageid = 'messageid_example'; // string | The ID of the message you would like returned

try {
    $result = $apiInstance->messagesMessageidDelete($messageid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesMessageidDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
messageid	string	The ID of the message you would like returned

Return type

\OpenAPI\Client\Model\DeletedMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesMessageidGet()`

messagesMessageidGet($messageid): \OpenAPI\Client\Model\MessageResponse

Retrieve a logged message by the message ID

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$messageid = 'messageid_example'; // string | The ID of the message you would like returned

try {
    $result = $apiInstance->messagesMessageidGet($messageid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesMessageidGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
messageid	string	The ID of the message you would like returned

Return type

\OpenAPI\Client\Model\MessageResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesPost()`

messagesPost($query): \OpenAPI\Client\Model\MessageResponse[]

Retrieve up to 1000 messages matching your search criteria

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$query = new \OpenAPI\Client\Model\Query(); // \OpenAPI\Client\Model\Query

try {
    $result = $apiInstance->messagesPost($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	\OpenAPI\Client\Model\Query

Return type

\OpenAPI\Client\Model\MessageResponse[]

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesScheduleGet()`

messagesScheduleGet(): \OpenAPI\Client\Model\ScheduledMessagesResponse

Returns a list of messages scheduled from your account, comprising any messages scheduled in the last 3 months and any scheduled to send in the future

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->messagesScheduleGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesScheduleGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\ScheduledMessagesResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`messagesScheduleMessageidDelete()`

messagesScheduleMessageidDelete($messageid): \OpenAPI\Client\Model\CancelledMessageResponse

Cancels a scheduled SMS message

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$messageid = 'messageid_example'; // string | The ID of the message you would like returned

try {
    $result = $apiInstance->messagesScheduleMessageidDelete($messageid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->messagesScheduleMessageidDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
messageid	string	The ID of the message you would like returned

Return type

\OpenAPI\Client\Model\CancelledMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`sendFlashMessage()`

sendFlashMessage($sms_message): \OpenAPI\Client\Model\SendMessageResponse

Sends an SMS flash message, which appears on the recipients lock screen

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: JWT
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\MessagesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sms_message = new \OpenAPI\Client\Model\Message(); // \OpenAPI\Client\Model\Message | Message properties

try {
    $result = $apiInstance->sendFlashMessage($sms_message);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MessagesApi->sendFlashMessage: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sms_message	\OpenAPI\Client\Model\Message	Message properties

Return type

\OpenAPI\Client\Model\SendMessageResponse

Authorization

JWT

HTTP request headers

Content-Type: application/json
Accept: application/json;charset=UTF-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

MessagesApi.md

Latest commit

History

MessagesApi.md

File metadata and controls

OpenAPI\Client\MessagesApi

messageSchedulePost()

Example

Parameters

Return type

Authorization

HTTP request headers

messageSendPost()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesFailedPost()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesInboxPost()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesMessageidDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesMessageidGet()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesPost()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesScheduleGet()

Example

Parameters

Return type

Authorization

HTTP request headers

messagesScheduleMessageidDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

sendFlashMessage()

Example

Parameters

Return type

Authorization

HTTP request headers

`messageSchedulePost()`

`messageSendPost()`

`messagesFailedPost()`

`messagesInboxPost()`

`messagesMessageidDelete()`

`messagesMessageidGet()`

`messagesPost()`

`messagesScheduleGet()`

`messagesScheduleMessageidDelete()`

`sendFlashMessage()`