OpenAPIClient-php

The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed UK messages are refunded.

For more information, please visit https://thesmsworks.co.uk/contact.

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/thesmsworks/smsw-php-sdk-73.git"
    }
  ],
  "require": {
    "thesmsworks/smsw-php-sdk-73": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?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\BatchMessagesApi(
    // 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
);
$messages = array('key' => new \stdClass); // object | An array of messages

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

API Endpoints

All URIs are relative to https://api.thesmsworks.co.uk/v1

Class	Method	HTTP request	Description
BatchMessagesApi	batchAnyPost	POST /batch/any	Send a collection of unique SMS messages
BatchMessagesApi	batchBatchidGet	GET /batch/{batchid}
BatchMessagesApi	batchSchedulePost	POST /batch/schedule	Schedule a batch of SMS messages
BatchMessagesApi	batchSendPost	POST /batch/send	Send an SMS message to multiple recipients
BatchMessagesApi	batchesScheduleBatchidDelete	DELETE /batches/schedule/{batchid}	Cancel a scheduled batch
CreditsApi	creditsBalanceGet	GET /credits/balance
MessagesApi	binarySendPost	POST /binary/send	Send a binary SMS message
MessagesApi	messageFlashPost	POST /message/flash
MessagesApi	messageSchedulePost	POST /message/schedule	Schedule an SMS message
MessagesApi	messageSendPost	POST /message/send
MessagesApi	messagesFailedPost	POST /messages/failed
MessagesApi	messagesInboxPost	POST /messages/inbox	Retrieve unread uncoming messages
MessagesApi	messagesMessageidDelete	DELETE /messages/{messageid}
MessagesApi	messagesMessageidGet	GET /messages/{messageid}	Get message by messageid
MessagesApi	messagesPost	POST /messages	Get messages matching your criteria
MessagesApi	messagesScheduleGet	GET /messages/schedule	Retrieve scheduled messages
MessagesApi	messagesScheduleMessageidDelete	DELETE /messages/schedule/{messageid}	Cancel scheduled SMS message
MessagesApi	messagesVolumeGet	GET /messages/volume	Volume of messages sent since midnight
OneTimePasswordApi	otpMessageidGet	GET /otp/{messageid}
OneTimePasswordApi	otpSendPost	POST /otp/send
OneTimePasswordApi	otpVerifyPost	POST /otp/verify
UtilsApi	utilsErrorsErrorcodeGet	GET /utils/errors/{errorcode}	Get error by code
UtilsApi	utilsTestGet	GET /utils/test	Return the customer ID to the caller

Models

• BatchMessage
• BatchMessageResponse
• CancelledMessageResponse
• CreditsResponse
• DeletedMessageResponse
• ErrorModel
• ExtendedErrorModel
• ExtendedErrorModelAllOf
• Message
• MessageMetadata
• MessageResponse
• MessageResponseFailurereason
• MessageVolumeResponse
• MetaData
• OTP
• OTPResponse
• OTPVerify
• OTPVerifyResponse
• Query
• QueryMetadata
• ScheduledBatchResponse
• ScheduledMessage
• ScheduledMessageResponse
• ScheduledMessagesResponse
• ScheduledMessagesResponseMessage
• SendMessageResponse
• TestResponse

Authorization

JWT

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@thesmsworks.co.uk

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.10.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen