nikolasmelui / php-smartcalls-sdk

Voximplant Kit PHP SDK

smartcalls

Basic description

HTTP API is available via the https://kit.voximplant.com/api/v3/{method} endpoint. To use the methods marked with the LOCK symbol, you need to generate an access_token via the getAccessToken method. Pass this access token to each HTTP API call.

Authentication

This API uses Custom Query Parameter for its authentication.

The parameters that are needed to be sent for this type of authentication are as follows:

• access_token
• domain

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

• API version: 2.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/smartcalls/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 Smartcalls\client\AccountApi(
    // 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()
);

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

$apiInstance = new Smartcalls\client\AccountApi(
    // 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()
);
$key = "key_example"; // string | Name of the setting, such as account_id, domain_name, etc

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

Documentation for API Endpoints

All URIs are relative to https://kit.voximplant.com/api/v3

Class	Method	HTTP request	Description
AccountApi	accountGetAccountInfoGet	GET /account/getAccountInfo
AccountApi	settingSearchSettingsGet	GET /setting/searchSettings
CallsApi	callsDownloadHistoryReportPost	POST /calls/downloadHistoryReport
CallsApi	callsExportHistoryReportPost	POST /calls/exportHistoryReport
CallsApi	callsGetHistoryReportStatusPost	POST /calls/getHistoryReportStatus
CallsApi	callsSearchCallsGet	GET /calls/searchCalls
CampaignsApi	attemptDownloadStatReportGet	GET /attempt/downloadStatReport
CampaignsApi	attemptExportStatReportPost	POST /attempt/exportStatReport
CampaignsApi	attemptGetStatReportStatusPost	POST /attempt/getStatReportStatus
CampaignsApi	attemptSearchAttemptsGet	GET /attempt/searchAttempts
CampaignsApi	outboundAppendToCampaignPost	POST /outbound/appendToCampaign
CampaignsApi	outboundDeleteCampaignPost	POST /outbound/deleteCampaign
CampaignsApi	outboundInitCampaignPost	POST /outbound/initCampaign
CampaignsApi	outboundPauseCampaignPost	POST /outbound/pauseCampaign
CampaignsApi	outboundResumeCampaignPost	POST /outbound/resumeCampaign
CampaignsApi	outboundSearchCampaignsGet	GET /outbound/searchCampaigns
CampaignsApi	outboundStatPost	POST /outbound/stat
HelperApi	helperGetListTimezonesGet	GET /helper/getListTimezones
HelperApi	helperGetTimezonesByNumberPost	POST /helper/getTimezonesByNumber
NumbersApi	calleridSearchCallerIDsGet	GET /callerid/searchCallerIDs
NumbersApi	phoneSearchNumbersGet	GET /phone/searchNumbers
ScenariosApi	scenarioGetScenarioVariablesPost	POST /scenario/getScenarioVariables
ScenariosApi	scenarioRunScenarioPost	POST /scenario/runScenario
ScenariosApi	scenarioSearchScenariosGet	GET /scenario/searchScenarios

Documentation For Models

• AccountDomainPartnerType
• AccountDomainTariffType
• AccountDomainType
• AccountProfileItemType
• AccountProfileType
• AccountType
• AccountUserType
• AppendFailType
• AppendToCampaignResponseType
• AppendToCampaignResponseTypeResult
• AttemptType
• Body
• Body1
• CallerIDType
• CallsType
• CampaignStatResponseType
• CampaignStatType
• CampaignType
• DeleteCampaignResponseType
• ErrorResultType
• ErrorType
• ExportHistoryReportResponseType
• ExportStatReportResponseType
• ExportStatReportResponseTypeResult
• GetAccountInfoResponseType
• GetHistoryReportStatusResponseType
• GetListTimezonesResponseType
• GetScenarioVariablesRequestType
• GetScenarioVariablesResponseType
• GetStatReportStatusResponseType
• GetStatReportStatusResponseTypeResult
• GetTimezonesByNumberRequestType
• GetTimezonesByNumberResponseType
• InitCampaignRequestType
• InitCampaignResponseType
• InlineResponse200
• Meta
• PauseCampaignResponseType
• PhoneNumberCampaignType
• PhoneNumberScenarioType
• PhoneNumberType
• ResumeCampaignResponseType
• ScenarioCampaignType
• ScenarioPhoneNumberType
• ScenarioType
• SearchAttemptsResponseType
• SearchCallerIDsResponseType
• SearchCallsResponseType
• SearchCampaignsResponseType
• SearchNumbersResponseType
• SearchScenariosResponseType
• SearchSettingsResponseType
• SettingType
• SettingsType
• StatRequestType
• TestNumberType
• TimezoneByPhoneType
• TimezoneType
• VariablesType

Documentation For Authorization

All endpoints do not require authorization.

Author