README

Ducksms is a leading SMS messaging service provider offering one-way SMS communication services from your internet enabled computer. The API allow you to directly communicate and manage a SMS with our SMS gateway system.

Official API Documentation

https://ducksms.stoplight.io/

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

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen For more information, please visit https://ducksms.com/

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer from Packagist, run in console:

composer require ducksms/ducksms-php

If you prefer to install the bindings via Composer from Github repository, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/ducksms/ducksms-php.git"
    }
  ],
  "require": {
    "ducksms/ducksms-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

require_once('/path/to/ducksms-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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



$apiInstance = new Ducksms\Api\CreditApi(
    // 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
);

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

?>

Documentation For Authorization

BearerToken

Type: Bearer authentication (JWT)

// Configure Bearer (JWT) authorization: BearerToken
$config = Ducksms\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

Documentation for API Endpoints

All URIs are relative to https://ducksms.com

Class	Method	HTTP request	Description
CreditApi	creditBalance	GET /api/v1/credits/balance	Credit Balance
CreditApi	creditHistory	GET /api/v1/credits/history	Credit History
SenderIDApi	createSender	POST /api/v1/senders	Create a Sender ID
SenderIDApi	deleteSender	DELETE /api/v1/senders/{id}	Delete a Sender ID
SenderIDApi	getSender	GET /api/v1/senders/{id}	Get a single Sender ID
SenderIDApi	listSender	GET /api/v1/senders	List Sender ID
SenderIDApi	updateSender	POST /api/v1/senders/{id}	Update a Sender ID
SmsApi	smsSend	POST /api/v1/sms/send	Send Sms
SmsScheduleApi	cancelSmsSchedule	DELETE /api/v1/sms/scheduled/{id}	Cancel Sms Schedule
SmsScheduleApi	listSmsSchedule	GET /api/v1/sms/scheduled	List Sms Schedule

Documentation For Models

Get help / support

Please contact support@ducksms.com and we can take more direct action toward finding a solution.

ducksms / ducksms-php

Maintainers

Details