Messaging Gateway SDK for PHP 8 - GSMService.pl
MIT License
This package includes Messaging SDK for PHP (>8.2) to send SMS & MMS messages directly from your app via https://bramka.gsmservice.pl messaging platform.
A documentation of all methods and types is available below in section Available Resources and Operations .
Also you can refer to the REST API documentation for additional details about the basics of this SDK.
The SDK relies on Composer to manage its dependencies.
To install the SDK and add it as a dependency to an existing composer.json
file:
composer require "gsmservice-pl/messaging-sdk-php"
This example demonstrates simple sending SMS message to a single recipient:
declare(strict_types=1);
require 'vendor/autoload.php';
use Gsmservice\Gateway;
use Gsmservice\Gateway\Models\Components;
$security = '<YOUR API ACCESS TOKEN>';
$sdk = Gateway\Client::builder()->setSecurity($security)->build();
$request = [
new Components\SmsMessage(
recipients: [
'+48999999999',
],
message: 'To jest treść wiadomości',
sender: 'Bramka SMS',
type: Components\SmsType::SmsPro,
unicode: true,
flash: false,
date: null,
),
];
$response = $sdk->outgoing->sms->send(
request: $request
);
if ($response->messages !== null) {
// handle response
}
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception.
By default an API error will raise a Errors\SDKException
exception, which has the following properties:
Property | Type | Description |
---|---|---|
$message |
string | The error message |
$statusCode |
int | The HTTP status code |
$rawResponse |
?\Psr\Http\Message\ResponseInterface | The raw HTTP response |
$body |
string | The response content |
When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the get
method throws the following exceptions:
Error Type | Status Code | Content Type |
---|---|---|
Errors\ErrorResponse | 401, 403, 4XX, 5XX | application/problem+json |
declare(strict_types=1);
require 'vendor/autoload.php';
use Gsmservice\Gateway;
$security = '<YOUR API ACCESS TOKEN>';
$sdk = Gateway\Client::builder()->setSecurity($security)->build();
try {
$response = $sdk->accounts->get(
);
if ($response->accountResponse !== null) {
// handle response
}
} catch (Errors\ErrorResponseThrowable $e) {
// handle $e->$container data
throw $e;
} catch (Errors\SDKException $e) {
// handle default exception
throw $e;
}
You can override the default server globally by passing a server name to the server: str
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:
Name | Server | Variables |
---|---|---|
prod |
https://api.gsmservice.pl/rest |
None |
sandbox |
https://api.gsmservice.pl/rest-sandbox |
None |
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
This SDK is in continuous development and there may be breaking changes between a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.