Skip to content

SMSDeliveryReceiptRulesApi.md

Latest commit

 

History

History
293 lines (210 loc) · 9.52 KB

SMSDeliveryReceiptRulesApi.md

File metadata and controls

293 lines (210 loc) · 9.52 KB

ClickSend\SMSDeliveryReceiptRulesApi

All URIs are relative to https://rest.clicksend.com/v3

Method HTTP request Description
smsDeliveryReceiptAutomationDelete DELETE /automations/sms/receipts/{receipt_rule_id} Delete sms delivery receipt automation
smsDeliveryReceiptAutomationGet GET /automations/sms/receipts/{receipt_rule_id} Get specific sms delivery receipt automation
smsDeliveryReceiptAutomationPost POST /automations/sms/receipts Create sms delivery receipt automations
smsDeliveryReceiptAutomationPut PUT /automations/sms/receipts/{receipt_rule_id} Update sms delivery receipt automation
smsDeliveryReceiptAutomationsGet GET /automations/sms/receipts Get all sms delivery receipt automations

smsDeliveryReceiptAutomationDelete

string smsDeliveryReceiptAutomationDelete($receipt_rule_id)

Delete sms delivery receipt automation

Delete sms delivery receipt automation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\SMSDeliveryReceiptRulesApi(
    // 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
);
$receipt_rule_id = 56; // int | Receipt rule id

try {
    $result = $apiInstance->smsDeliveryReceiptAutomationDelete($receipt_rule_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSDeliveryReceiptRulesApi->smsDeliveryReceiptAutomationDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
receipt_rule_id int Receipt rule id

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

smsDeliveryReceiptAutomationGet

string smsDeliveryReceiptAutomationGet($receipt_rule_id)

Get specific sms delivery receipt automation

Get specific sms delivery receipt automation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\SMSDeliveryReceiptRulesApi(
    // 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
);
$receipt_rule_id = 56; // int | Receipt rule id

try {
    $result = $apiInstance->smsDeliveryReceiptAutomationGet($receipt_rule_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSDeliveryReceiptRulesApi->smsDeliveryReceiptAutomationGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
receipt_rule_id int Receipt rule id

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

smsDeliveryReceiptAutomationPost

string smsDeliveryReceiptAutomationPost($body)

Create sms delivery receipt automations

Create sms delivery receipt automations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\SMSDeliveryReceiptRulesApi(
    // 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
);
$body = new \ClickSend\Model\DeliveryReceiptRule(); // \ClickSend\Model\DeliveryReceiptRule | sms delivery receipt rule model

try {
    $result = $apiInstance->smsDeliveryReceiptAutomationPost($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSDeliveryReceiptRulesApi->smsDeliveryReceiptAutomationPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \ClickSend\Model\DeliveryReceiptRule sms delivery receipt rule model

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

smsDeliveryReceiptAutomationPut

string smsDeliveryReceiptAutomationPut($body, $receipt_rule_id)

Update sms delivery receipt automation

Update sms delivery receipt automation

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\SMSDeliveryReceiptRulesApi(
    // 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
);
$body = new \ClickSend\Model\DeliveryReceiptRule(); // \ClickSend\Model\DeliveryReceiptRule | Delivery receipt rule model
$receipt_rule_id = 56; // int | Receipt rule id

try {
    $result = $apiInstance->smsDeliveryReceiptAutomationPut($body, $receipt_rule_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSDeliveryReceiptRulesApi->smsDeliveryReceiptAutomationPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \ClickSend\Model\DeliveryReceiptRule Delivery receipt rule model
receipt_rule_id int Receipt rule id

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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

smsDeliveryReceiptAutomationsGet

string smsDeliveryReceiptAutomationsGet($q, $page, $limit)

Get all sms delivery receipt automations

Get all sms delivery receipt automations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: BasicAuth
$config = ClickSend\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new ClickSend\Api\SMSDeliveryReceiptRulesApi(
    // 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
);
$q = "q_example"; // string | Your keyword or query.
$page = 1; // int | Page number
$limit = 10; // int | Number of records per page

try {
    $result = $apiInstance->smsDeliveryReceiptAutomationsGet($q, $page, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SMSDeliveryReceiptRulesApi->smsDeliveryReceiptAutomationsGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
q string Your keyword or query. [optional]
page int Page number [optional] [default to 1]
limit int Number of records per page [optional] [default to 10]

Return type

string

Authorization

BasicAuth

HTTP request headers

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

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