thesmsworks / smsw-php-sdk
The SMS Works provides a low-cost, reliable SMS API for developers. Pay only for delivered texts, all failed UK messages are refunded.
Installs: 7 563
Dependents: 1
Suggesters: 0
Security: 0
Stars: 3
Watchers: 0
Forks: 10
Open Issues: 0
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-10-20 14:44:11 UTC
README
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.4 and later. Should also work with PHP 8.0.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/thesmsworks/smsw-php-sdk.git" } ], "require": { "thesmsworks/smsw-php-sdk": "*@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
Models
- BatchMessage
- BatchMessageResponse
- CancelledMessageResponse
- CreditsResponse
- DeletedMessageResponse
- ErrorModel
- ExtendedErrorModel
- Message
- MessageMetadata
- MessageResponse
- MessageResponseFailurereason
- MetaData
- OTP
- OTPResponse
- OTPVerify
- OTPVerifyResponse
- Query
- QueryMetadata
- ScheduledBatchResponse
- ScheduledMessage
- ScheduledMessageResponse
- ScheduledMessagesResponse
- ScheduledMessagesResponseMessage
- SendMessageResponse
- TestResponse
Authorization
Authentication schemes defined for the API:
JWT
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.9.0
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen