Skip to content

Latest commit

 

History

History
206 lines (142 loc) · 6.56 KB

CallbackApi.md

File metadata and controls

206 lines (142 loc) · 6.56 KB
Raw

SMSGatewayMe\Client\CallbackApi

All URIs are relative to https://smsgateway.me/api/v4

Method HTTP request Description
createCallback POST /callback Create Callback
getCallback GET /callback/{id} Get a specific callback
searchCallbacks POST /callback/search Search callbacks
updateCallback PUT /callback/{id} Update callback

createCallback

\SMSGatewayMe\Client\Model\Callback createCallback($callback)

Create Callback

Example

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

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

$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$callback = new \SMSGatewayMe\Client\Model\CreateCallbackRequest(); // \SMSGatewayMe\Client\Model\CreateCallbackRequest | callback to create

try { 
    $result = $api_instance->createCallback($callback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackApi->createCallback: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
callback \SMSGatewayMe\Client\Model\CreateCallbackRequest callback to create

Return type

\SMSGatewayMe\Client\Model\Callback

Authorization

Authorization

HTTP reuqest headers

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

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

getCallback

\SMSGatewayMe\Client\Model\Callback getCallback($id)

Get a specific callback

Example

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

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

$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$id = "id_example"; // string | 

try { 
    $result = $api_instance->getCallback($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackApi->getCallback: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string

Return type

\SMSGatewayMe\Client\Model\Callback

Authorization

Authorization

HTTP reuqest headers

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

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

searchCallbacks

\SMSGatewayMe\Client\Model\CallbackSearchResult searchCallbacks($search)

Search callbacks

Example

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

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

$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$search = new \SMSGatewayMe\Client\Model\Search(); // \SMSGatewayMe\Client\Model\Search | Search Criteria

try { 
    $result = $api_instance->searchCallbacks($search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackApi->searchCallbacks: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
search \SMSGatewayMe\Client\Model\Search Search Criteria [optional]

Return type

\SMSGatewayMe\Client\Model\CallbackSearchResult

Authorization

Authorization

HTTP reuqest headers

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

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

updateCallback

\SMSGatewayMe\Client\Model\Callback updateCallback($id, $callback)

Update callback

Example

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

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

$api_instance = new SMSGatewayMe\Client\Api\CallbackApi();
$id = "id_example"; // string | 
$callback = array(new UpdateCallbackRequest()); // \SMSGatewayMe\Client\Model\UpdateCallbackRequest[] | callback update data

try { 
    $result = $api_instance->updateCallback($id, $callback);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CallbackApi->updateCallback: ', $e->getMessage(), "\n";
}
?>

Parameters

Name Type Description Notes
id string
callback \SMSGatewayMe\Client\Model\UpdateCallbackRequest[] callback update data

Return type

\SMSGatewayMe\Client\Model\Callback

Authorization

Authorization

HTTP reuqest headers

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

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