README

Comprehensive API for sending SMS, Viber messages, HLR/MNP requests and service management

For more information, please visit https://bsg.world.

Installation

composer require bsgworld/php-sdk-v1

Requirements

• PHP 7.4 or later
• Guzzle HTTP client (installed automatically)

Getting Started

Please follow the installation procedure and then run the following:

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


// Configure API key authorization: ApiKeyAuth
$config = BSG\Api\V1\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BSG\Api\V1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');


$apiInstance = new BSG\Api\V1\Api\SMSMessagingApi(
    // 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_price_check_request = new \BSG\Api\V1\Model\SmsPriceCheckRequest([
    'destination' => 'phone',
    'msisdn' => '380953227271',
    'originator' => 'BSG',
    'body' => 'Hello! This is a test message for price calculation.',
    'transliterate' => true,
]);
try {
    $result = $apiInstance->smsCheckPrice($sms_price_check_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSMessagingApi->smsCheckPrice: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return type

\BSG\Api\V1\Model\SmsPriceCheckResponse

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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

smsCheckPricePut()

smsCheckPricePut($sms_price_check_request): \BSG\Api\V1\Model\SmsPriceCheckResponse

Check SMS price (PUT)

Calculate SMS price without sending using PUT method

Example

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


// Configure API key authorization: ApiKeyAuth
$config = BSG\Api\V1\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BSG\Api\V1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');


$apiInstance = new BSG\Api\V1\Api\SMSMessagingApi(
    // 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_price_check_request = new \BSG\Api\V1\Model\SmsPriceCheckRequest([
    'destination' => 'phone',
    'msisdn' => '380953227271',
    'originator' => 'BSG',
    'body' => 'Hello! This is a test message for price calculation.',
    'transliterate' => true,
]);
try {
    $result = $apiInstance->smsCheckPricePut($sms_price_check_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSMessagingApi->smsCheckPricePut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Return type

\BSG\Api\V1\Model\SmsPriceCheckResponse

Authorization

ApiKeyAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

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

smsCreateObjects()

smsCreateObjects($sms_create_request): \BSG\Api\V1\Model\SmsCreateResponse

Send SMS message

Send SMS message to one or multiple recipients

Example

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


// Configure API key authorization: ApiKeyAuth
$config = BSG\Api\V1\Configuration::getDefaultConfiguration()->setApiKey('X-API-KEY', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BSG\Api\V1\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-KEY', 'Bearer');


$apiInstance = new BSG\Api\V1\Api\SMSMessagingApi(
    // 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_create_request = new \BSG\Api\V1\Model\SmsCreateRequest([
    'destination' => 'phone',
    'msisdn' => '380953227271',
    'originator' => 'testsms',
    'body' => 'k TEST Hello12 SMS 1115222',
    'reference' => '1737033400123',
    'validity' => 72,
    'callback_url' => 'https://webhook.site/wh-delivery-reports',
    '2way' => 0,
    'transliterate' => false,
]);
try {
    $result = $apiInstance->smsCreateObjects($sms_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSMessagingApi->smsCreateObjects: ', $e->getMessage(), PHP_EOL;
}

Endpoints

All URIs are relative to https://api.sms-service.local

Models

• BalanceResponse
• ErrorResponse
• ExportCreateRequest
• ExportCreateResponse
• ExportListItem
• ExportListResponse
• HlrCreateRequest
• HlrCreateResponse
• HlrCreateResultItem
• HlrDetails
• HlrPriceItem
• HlrPricesResponse
• HlrRequestItem
• HlrSingleRequest
• HlrStatusResponse
• HlrSyncRequest
• HlrSyncResponse
• HttpError500Response
• MnpBatchItem
• MnpBatchRequest
• MnpCreateRequest
• MnpCreateResponse
• MnpCreateResultItem
• MnpInfo
• MnpPriceItem
• MnpPricesResponse
• MnpSingleRequest
• MnpStatusResponse
• Sms2WayIncomingMessage
• Sms2WayIncomingResponse
• SmsBalanceResponse
• SmsCreateOtpResultItem
• SmsCreateRequest
• SmsCreateResponse
• SmsCreateResultItem
• SmsCreateSingleResult
• SmsIndividualCreateRequest
• SmsIndividualPhoneItem
• SmsMassStatusItem
• SmsMassStatusRequest
• SmsMassStatusResponse
• SmsMultipleCreateRequest
• SmsMultipleResponse
• SmsOtpCreateRequest
• SmsPhoneItem
• SmsPriceCheckMultipleRequest
• SmsPriceCheckPhoneItem
• SmsPriceCheckRequest
• SmsPriceCheckResponse
• SmsPriceCheckSingleRequest
• SmsPriceInfo
• SmsPricesListResponse
• SmsSingleCreateRequest
• SmsSingleResponse
• SmsStatusResponse
• SmsTaskResponse
• SmsTaskStatusResponse
• SuccessResponse
• ViberAltRouteItem
• ViberAltRouteMessage
• ViberChannelOptions
• ViberCreateRequest
• ViberCreateResponse
• ViberCreateResultItem
• ViberMessageItem
• ViberMessageOptions
• ViberPriceCheckMessageItem
• ViberPriceCheckRequest
• ViberPriceCheckResponse
• ViberPriceItem
• ViberPricesResponse
• ViberRecipient
• ViberSmsFallback
• ViberStatusResponse

Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

support@bsg.world

About this package

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

• API version: 1.0.0
  • Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen