PHP Client for smsgateway.me
Clone or download
Sepehr Sabbagh-pour
Sepehr Sabbagh-pour added client provider
Latest commit 9dd9fd4 May 21, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs inital commit May 16, 2018
lib added client provider May 21, 2018
.travis.yml inital commit May 16, 2018
README.md inital commit May 16, 2018
autoload.php inital commit May 16, 2018
composer.json inital commit May 16, 2018

README.md

SwaggerClient-php

This PHP package is automatically generated by the Swagger Codegen project:

  • API version: 4.0.0
  • Package version: v0.0.1
  • Build date: 2018-05-16T00:56:54.871+01:00
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/smsgatewayme/client-php.git"
    }
  ],
  "require": {
    "smsgatewayme/client": "^0.0.1"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

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

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

<?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";
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
CallbackApi createCallback POST /callback Create Callback
CallbackApi getCallback GET /callback/{id} Get a specific callback
CallbackApi searchCallbacks POST /callback/search Search callbacks
CallbackApi updateCallback PUT /callback/{id} Update callback
ContactApi addPhoneNumber PUT /contact/{id}/phone-number/{phone-number} The phone number to add
ContactApi createContacts POST /contact Create Contacts
ContactApi deletePhoneNumber DELETE /contact/{id}/phone-number/{phone-number} The phone number to delete
ContactApi getContact GET /contact/{id} Get a specific contact
ContactApi searchContacts POST /contact/search Search contacts
ContactApi updateContact PUT /contact/{id} Update contact
DeviceApi getDevice GET /device/{id} Get a specific device
DeviceApi searchDevices POST /device/search Search devices
MessageApi cancelMessages POST /message/cancel Cancel messages
MessageApi getMessage GET /message/{id} Get a specific message
MessageApi searchMessages POST /message/search Search messages
MessageApi sendMessages POST /message/send Send messages

Documentation For Models

Documentation For Authorization

Authorization

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author