Download the PHP
package voximplant/kit-apiclient-php without Composer
On this page you can find all versions of the php package
voximplant/kit-apiclient-php . It is possible to download/install
these versions without Composer . Possible dependencies are resolved
automatically.
FAQ
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements. In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look
here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package kit-apiclient-php VoximplantKit
Basic description HTTP API is available via the https://kitapi-{{region}}.voximplant.com/api/v3/{method} endpoint. To use the methods marked with the LOCK symbol, you need to create an api token on api tokens page. Pass this token as 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:
## Requirements
PHP 5.5 and later
## Installation & Usage
### Composer
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
Then run `composer install`
### Manual Installation
Download the files and include `autoload.php`:
## Tests
To run the unit tests:
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
## Documentation for API Endpoints
All URIs are relative to *https://kitapi-{{region}}.voximplant.com/api/v3*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountApi* | [**getAccountInfo**](docs/Api/AccountApi.md#getaccountinfo) | **GET** /account/getAccountInfo |
*AccountApi* | [**searchSettings**](docs/Api/AccountApi.md#searchsettings) | **GET** /setting/searchSettings |
*CallsApi* | [**downloadHistoryReport**](docs/Api/CallsApi.md#downloadhistoryreport) | **POST** /calls/downloadHistoryReport |
*CallsApi* | [**exportHistoryReport**](docs/Api/CallsApi.md#exporthistoryreport) | **POST** /calls/exportHistoryReport |
*CallsApi* | [**getHistoryReportStatus**](docs/Api/CallsApi.md#gethistoryreportstatus) | **POST** /calls/getHistoryReportStatus |
*CallsApi* | [**searchCalls**](docs/Api/CallsApi.md#searchcalls) | **GET** /calls/searchCalls |
*CampaignsApi* | [**appendToCampaign**](docs/Api/CampaignsApi.md#appendtocampaign) | **POST** /outbound/appendToCampaign |
*CampaignsApi* | [**deleteCampaign**](docs/Api/CampaignsApi.md#deletecampaign) | **POST** /outbound/deleteCampaign |
*CampaignsApi* | [**downloadStatReport**](docs/Api/CampaignsApi.md#downloadstatreport) | **GET** /attempt/downloadStatReport |
*CampaignsApi* | [**exportStatReport**](docs/Api/CampaignsApi.md#exportstatreport) | **POST** /attempt/exportStatReport |
*CampaignsApi* | [**getStatReportStatus**](docs/Api/CampaignsApi.md#getstatreportstatus) | **POST** /attempt/getStatReportStatus |
*CampaignsApi* | [**initCampaign**](docs/Api/CampaignsApi.md#initcampaign) | **POST** /outbound/initCampaign |
*CampaignsApi* | [**pauseCampaign**](docs/Api/CampaignsApi.md#pausecampaign) | **POST** /outbound/pauseCampaign |
*CampaignsApi* | [**resumeCampaign**](docs/Api/CampaignsApi.md#resumecampaign) | **POST** /outbound/resumeCampaign |
*CampaignsApi* | [**searchAttempts**](docs/Api/CampaignsApi.md#searchattempts) | **GET** /attempt/searchAttempts |
*CampaignsApi* | [**searchCampaigns**](docs/Api/CampaignsApi.md#searchcampaigns) | **GET** /outbound/searchCampaigns |
*CampaignsApi* | [**stat**](docs/Api/CampaignsApi.md#stat) | **POST** /outbound/stat |
*HelperApi* | [**getListTimezones**](docs/Api/HelperApi.md#getlisttimezones) | **GET** /helper/getListTimezones |
*HelperApi* | [**getTimezonesByNumber**](docs/Api/HelperApi.md#gettimezonesbynumber) | **POST** /helper/getTimezonesByNumber |
*HistoryApi* | [**exportCallsHistoryReport**](docs/Api/HistoryApi.md#exportcallshistoryreport) | **POST** /history/exportCallsHistoryReport |
*HistoryApi* | [**searchCalls**](docs/Api/HistoryApi.md#searchcalls) | **GET** /history/searchCalls |
*NumbersApi* | [**searchCallerIDs**](docs/Api/NumbersApi.md#searchcallerids) | **GET** /callerid/searchCallerIDs |
*NumbersApi* | [**searchNumbers**](docs/Api/NumbersApi.md#searchnumbers) | **GET** /phone/searchNumbers |
*ReportApi* | [**downloadReport**](docs/Api/ReportApi.md#downloadreport) | **POST** /report/downloadReport |
*ReportApi* | [**getReportStatus**](docs/Api/ReportApi.md#getreportstatus) | **POST** /report/getReportStatus |
*ScenariosApi* | [**getScenarioVariables**](docs/Api/ScenariosApi.md#getscenariovariables) | **POST** /scenario/getScenarioVariables |
*ScenariosApi* | [**runScenario**](docs/Api/ScenariosApi.md#runscenario) | **POST** /scenario/runScenario |
*ScenariosApi* | [**searchScenarios**](docs/Api/ScenariosApi.md#searchscenarios) | **GET** /scenario/searchScenarios |
## Documentation For Models
- [AccountDomainPartnerType](docs/Model/AccountDomainPartnerType.md)
- [AccountDomainTariffType](docs/Model/AccountDomainTariffType.md)
- [AccountDomainType](docs/Model/AccountDomainType.md)
- [AccountProfileItemType](docs/Model/AccountProfileItemType.md)
- [AccountProfileType](docs/Model/AccountProfileType.md)
- [AccountType](docs/Model/AccountType.md)
- [AccountUserType](docs/Model/AccountUserType.md)
- [AppendFailType](docs/Model/AppendFailType.md)
- [AppendToCampaignResponseType](docs/Model/AppendToCampaignResponseType.md)
- [AppendToCampaignResponseTypeResult](docs/Model/AppendToCampaignResponseTypeResult.md)
- [AttemptType](docs/Model/AttemptType.md)
- [Body](docs/Model/Body.md)
- [Body1](docs/Model/Body1.md)
- [Body2](docs/Model/Body2.md)
- [Body3](docs/Model/Body3.md)
- [Body4](docs/Model/Body4.md)
- [CallerIDType](docs/Model/CallerIDType.md)
- [CallsHistoryResponseType](docs/Model/CallsHistoryResponseType.md)
- [CallsHistoryType](docs/Model/CallsHistoryType.md)
- [CallsType](docs/Model/CallsType.md)
- [CampaignStatResponseType](docs/Model/CampaignStatResponseType.md)
- [CampaignStatType](docs/Model/CampaignStatType.md)
- [CampaignType](docs/Model/CampaignType.md)
- [DeleteCampaignResponseType](docs/Model/DeleteCampaignResponseType.md)
- [ErrorResultType](docs/Model/ErrorResultType.md)
- [ErrorType](docs/Model/ErrorType.md)
- [ExportHistoryReportResponseType](docs/Model/ExportHistoryReportResponseType.md)
- [ExportStatReportResponseType](docs/Model/ExportStatReportResponseType.md)
- [ExportStatReportResponseTypeResult](docs/Model/ExportStatReportResponseTypeResult.md)
- [GetAccountInfoResponseType](docs/Model/GetAccountInfoResponseType.md)
- [GetHistoryReportStatusResponseType](docs/Model/GetHistoryReportStatusResponseType.md)
- [GetListTimezonesResponseType](docs/Model/GetListTimezonesResponseType.md)
- [GetScenarioVariablesRequestType](docs/Model/GetScenarioVariablesRequestType.md)
- [GetScenarioVariablesResponseType](docs/Model/GetScenarioVariablesResponseType.md)
- [GetStatReportStatusResponseType](docs/Model/GetStatReportStatusResponseType.md)
- [GetStatReportStatusResponseTypeResult](docs/Model/GetStatReportStatusResponseTypeResult.md)
- [GetTimezonesByNumberRequestType](docs/Model/GetTimezonesByNumberRequestType.md)
- [GetTimezonesByNumberResponseType](docs/Model/GetTimezonesByNumberResponseType.md)
- [InitCampaignRequestType](docs/Model/InitCampaignRequestType.md)
- [InitCampaignResponseType](docs/Model/InitCampaignResponseType.md)
- [InlineResponse200](docs/Model/InlineResponse200.md)
- [Meta](docs/Model/Meta.md)
- [PauseCampaignResponseType](docs/Model/PauseCampaignResponseType.md)
- [PhoneNumberCampaignType](docs/Model/PhoneNumberCampaignType.md)
- [PhoneNumberScenarioType](docs/Model/PhoneNumberScenarioType.md)
- [PhoneNumberType](docs/Model/PhoneNumberType.md)
- [ResumeCampaignResponseType](docs/Model/ResumeCampaignResponseType.md)
- [ScenarioCampaignType](docs/Model/ScenarioCampaignType.md)
- [ScenarioPhoneNumberType](docs/Model/ScenarioPhoneNumberType.md)
- [ScenarioType](docs/Model/ScenarioType.md)
- [SearchAttemptsResponseType](docs/Model/SearchAttemptsResponseType.md)
- [SearchCallerIDsResponseType](docs/Model/SearchCallerIDsResponseType.md)
- [SearchCallsResponseType](docs/Model/SearchCallsResponseType.md)
- [SearchCampaignsResponseType](docs/Model/SearchCampaignsResponseType.md)
- [SearchNumbersResponseType](docs/Model/SearchNumbersResponseType.md)
- [SearchScenariosResponseType](docs/Model/SearchScenariosResponseType.md)
- [SearchSettingsResponseType](docs/Model/SearchSettingsResponseType.md)
- [SettingType](docs/Model/SettingType.md)
- [SettingsType](docs/Model/SettingsType.md)
- [StatRequestType](docs/Model/StatRequestType.md)
- [TestNumberType](docs/Model/TestNumberType.md)
- [TimezoneByPhoneType](docs/Model/TimezoneByPhoneType.md)
- [TimezoneType](docs/Model/TimezoneType.md)
- [VariablesType](docs/Model/VariablesType.md)
## Documentation For Authorization
Authentication schemes defined for the API:
## access_token
- **Type**: API key
- **API key parameter name**: access_token
- **Location**: URL query string
## domain
- **Type**: API key
- **API key parameter name**: domain
- **Location**: URL query string
## Author
All versions of kit-apiclient-php with dependencies
PHP Build Version
8.0.21 7.3.33
Package Version
v3.0.1
v2.0.1
v2.0.0
v1.0.2
v1.0.1
v1.0.0
Requires
php Version
>=7.1
ext-curl Version
*
ext-json Version
*
ext-mbstring Version
*
guzzlehttp/guzzle Version
^6.2
Composer command for our command line client (download client )
This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.
Standard composer command
The package voximplant/kit-apiclient-php contains the following files Loading the files please wait ....