totalvoice php
Versão 1.17.0
PHP client for Totalvoice API
Functionality
Requirements
Installation
To install the library just add it via composer
composer require total-voice/php-client 1.*
Or no composer.json
{
"total-voice/php-client" : " 1.* "
}Testing
We can use the composer to run the tests:
composer test
or using the.
php composer.phar test
Use
To use this library, you must first register on the Total Voice website. After the creation of the registration will be made available an AccessoStoken for access to the API.
With AccessSstoken in hand it will be possible to make the consultations/registrations according to API documentation
API methods that can be invoked:
Then a small example of how this library can be used.
Makes a telephone call between two numbers: a and b
<?php
// Consideramos que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> chamada -> ligar ( ' NUMERO-A ' , ' NUMERO-B ' );
echo $ response -> getContent ();CALL CONSULTATION BY ID
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> chamada -> buscaChamada ( ' ID_CHAMADA ' );
echo $ response -> getContent (); // {} Closes an active call
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> chamada -> encerrar ( ' ID_CHAMADA ' );
echo $ response -> getContent (); // {} SMS Shipping
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> sms -> enviar ( ' NUMERO-DESTINO ' , ' SUA MENSAGEM ' );
echo $ response -> getContent (); // {}
TTS SHIPPING
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> tts -> enviar ( ' NUMERO-DESTINO ' , ' SUA MENSAGEM ' );
echo $ response -> getContent (); // {}
Audio submission
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> audio -> enviar ( ' NUMERO-DESTINO ' , ' SUA MENSAGEM ' );
echo $ response -> getContent (); // {} Central Telephone Settings
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> central -> buscaRamal ( ' ID-RAMAL ' );
echo $ response -> getContent (); // {}
Account Data Management
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> conta -> buscaConta ( ' ID_CONTA ' );
echo $ response -> getContent (); // {} BALANCE BALANCE MY ACCOUNT
<?php
// Considero que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> perfil -> consultaSaldo ();
echo $ response -> getContent (); // {} All API classes can be instanced separately too
<?php
// Consideramos que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ service = new Chamada ( $ client );
$ response = $ service -> ligar ( ' NUMERO-A ' , ' NUMERO-B ' );
echo $ response -> getContent ();If you use a custom client
<?php
// Consideramos que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Api Chamada ;
class MeuClient implements ClientInterface
{
}
$ meuclient = new MeuClient ( ' access-token ' );
$ service = new Chamada ( $ meuclient );
$ response = $ service -> ligar ( ' NUMERO-A ' , ' NUMERO-B ' );If you need to use your own address configured in Total Voice
<?php
// Consideramos que já existe um autoloader compatível com a PSR-4 registrado
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' , ' https://meuhost.com.br ' );
$ service = new Chamada ( $ client );
$ response = $ service -> ligar ( ' NUMERO-A ' , ' NUMERO-B ' );Listing DIDs in stock
<?php
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> did -> listaEstoque ();Acquiring a Did
<?php
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ idDid = " 10 " ;
$ response = $ client -> did -> adquirir ( $ idDid );Editing a Did
<?php
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ didId = " 11 " ;
$ uraId = null ;
$ response = $ client -> did -> atualizar ( $ idDid , $ ramalId , $ uraId );Deleting a Did
<?php
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ didId = " 11 " ;
$ response = $ client -> did -> excluir ( $ didId );Listing your dides
<?php
use TotalVoice Client as TotalVoiceClient ;
use TotalVoice Api Chamada ;
$ client = new TotalVoiceClient ( ' access-token ' );
$ response = $ client -> did -> lista ();More information about available methods can be found in the API documentation
Contribute!
Want to contribute? Click here
License
This library follows MIT's terms of use
