Skip to content

ngarg-vail/php-sdk

BranchesTags
 
 

Repository files navigation

FreeClimb

FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.

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

  • API version: 1.0.0
  • Package version: 1.1.2
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/FreeClimb/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');



// Configure HTTP basic authorization: fc
$config = FreeClimb\Api\Configuration::getDefaultConfiguration()
              ->setUsername('ACCOUNT_ID')
              ->setPassword('AUTH_TOKEN');


$apiInstance = new FreeClimb\Api\Api\DefaultApi(
    // 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->getAnAccount();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAnAccount: ', $e->getMessage(), PHP_EOL;
}

?>

API Endpoints

All URIs are relative to https://www.freeclimb.com/apiserver

Class Method HTTP request Description
DefaultApi buyAPhoneNumber POST /Accounts/{accountId}/IncomingPhoneNumbers Buy a Phone Number
DefaultApi createAConference POST /Accounts/{accountId}/Conferences Create a Conference
DefaultApi createAQueue POST /Accounts/{accountId}/Queues Create a Queue
DefaultApi createAnApplication POST /Accounts/{accountId}/Applications Create an application
DefaultApi deleteARecording DELETE /Accounts/{accountId}/Recordings/{recordingId} Delete a Recording
DefaultApi deleteAnApplication DELETE /Accounts/{accountId}/Applications/{applicationId} Delete an application
DefaultApi deleteAnIncomingNumber DELETE /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} Delete an Incoming Number
DefaultApi dequeueAMember POST /Accounts/{accountId}/Queues/{queueId}/Members/{callId} Dequeue a Member
DefaultApi dequeueHeadMember POST /Accounts/{accountId}/Queues/{queueId}/Members/Front Dequeue Head Member
DefaultApi downloadARecordingFile GET /Accounts/{accountId}/Recordings/{recordingId}/Download Download a Recording File
DefaultApi filterLogs POST /Accounts/{accountId}/Logs Filter Logs
DefaultApi getACall GET /Accounts/{accountId}/Calls/{callId} Get a Call
DefaultApi getAConference GET /Accounts/{accountId}/Conferences/{conferenceId} Get a Conference
DefaultApi getAMember GET /Accounts/{accountId}/Queues/{queueId}/Members/{callId} Get a Member
DefaultApi getAParticipant GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} Get a Participant
DefaultApi getAQueue GET /Accounts/{accountId}/Queues/{queueId} Get a Queue
DefaultApi getARecording GET /Accounts/{accountId}/Recordings/{recordingId} Get a Recording
DefaultApi getAnAccount GET /Accounts/{accountId} Get an Account
DefaultApi getAnApplication GET /Accounts/{accountId}/Applications/{applicationId} Get an Application
DefaultApi getAnIncomingNumber GET /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} Get an Incoming Number
DefaultApi getAnSmsMessage GET /Accounts/{accountId}/Messages/{messageId} Get an SMS Message
DefaultApi getHeadMember GET /Accounts/{accountId}/Queues/{queueId}/Members/Front Get Head Member
DefaultApi listActiveQueues GET /Accounts/{accountId}/Queues List Active Queues
DefaultApi listAllAccountLogs GET /Accounts/{accountId}/Logs List All Account Logs
DefaultApi listAnApplication GET /Accounts/{accountId}/Applications List applications
DefaultApi listAvailableNumbers GET /AvailablePhoneNumbers List available numbers
DefaultApi listCallLogs GET /Accounts/{accountId}/Calls/{callId}/Logs List Call Logs
DefaultApi listCallRecordings GET /Accounts/{accountId}/Calls/{callId}/Recordings List Call Recordings
DefaultApi listCalls GET /Accounts/{accountId}/Calls List Calls
DefaultApi listConferences GET /Accounts/{accountId}/Conferences List Conferences
DefaultApi listIncomingNumbers GET /Accounts/{accountId}/IncomingPhoneNumbers List Incoming Numbers
DefaultApi listMembers GET /Accounts/{accountId}/Queues/{queueId}/Members List Members
DefaultApi listParticipants GET /Accounts/{accountId}/Conferences/{conferenceId}/Participants List Participants
DefaultApi listRecordings GET /Accounts/{accountId}/Recordings List Recordings
DefaultApi listSmsMessages GET /Accounts/{accountId}/Messages List SMS Messages
DefaultApi makeACall POST /Accounts/{accountId}/Calls Make a Call
DefaultApi removeAParticipant DELETE /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} Remove a Participant
DefaultApi sendAnSmsMessage POST /Accounts/{accountId}/Messages Send an SMS Message
DefaultApi streamARecordingFile GET /Accounts/{accountId}/Recordings/{recordingId}/Stream Stream a Recording File
DefaultApi updateAConference POST /Accounts/{accountId}/Conferences/{conferenceId} Update a Conference
DefaultApi updateALiveCall POST /Accounts/{accountId}/Calls/{callId} Update a Live Call
DefaultApi updateAParticipant POST /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} Update a Participant
DefaultApi updateAQueue POST /Accounts/{accountId}/Queues/{queueId} Update a Queue
DefaultApi updateAnAccount POST /Accounts/{accountId} Manage an account
DefaultApi updateAnApplication POST /Accounts/{accountId}/Applications/{applicationId} Update an application
DefaultApi updateAnIncomingNumber POST /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} Update an Incoming Number

Models

Authorization

fc

  • Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Getting Help

If you are experiencing difficulties, contact support.

About this package

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

  • API version: 1.0.0
    • Package version: 1.1.2
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

PHP SDK for the FreeClimb API

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • PHP 99.9%
  • Shell 0.1%