2017 © Pedro Peláez
 

library php-client

Client para integração com API da Total Voice

image

total-voice/php-client

Client para integração com API da Total Voice

  • Thursday, July 26, 2018
  • by DiloWagner
  • Repository
  • 4 Watchers
  • 16 Stars
  • 3,753 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 3 Forks
  • 0 Open issues
  • 19 Versions
  • 93 % Grown

The README.md

totalvoice-php

Cliente em PHP para API da Totalvoice, (*1)

Build Status Packagist, (*2)

Funcionalidades

  • Gerenciamento das chamadas
  • Consulta e envio de SMS
  • Consulta e envio de TTS
  • Consulta e envio de Audio
  • Consulta e envio de Composto
  • Consulta e envio de Conferência
  • Gerenciamento da Conta
  • Gerenciamento da Central
  • Gerenciamento de DID

Requisitos

  • PHP 5.5+
  • Autoloader compatível com a PSR-4
  • PHP deve estar compilado com a lib-curl

Instalação

Para instalar a biblioteca basta adicioná-la via composer, (*3)

composer require total-voice/php-client 1.*

Ou no composer.json, (*4)

{
    "total-voice/php-client": "1.*"
}

Testes

Podemos usar o composer para rodar os testes:, (*5)

composer test

ou utilizando o .phar, (*6)

php composer.phar test

Utilização

Para utilizar esta biblioteca, primeiramente você deverá realizar um cadastro no site da Total Voice. Após a criação do cadastro será disponibilizado um AccessToken para acesso a API., (*7)

Com o AccessToken em mãos será possível realizar as consultas/cadastros conforme documentação da API, (*8)

Os métodos da API que poderão ser invocados: - audio - central - chamada - composto - conferencia - conta - perfil - sms - tts, (*9)

A seguir um pequeno exemplo de como pode ser utilizada esta biblioteca., (*10)

Realiza uma chamada telefônica entre dois números: A e 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();
Consulta de chamada pelo 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(); // {}
Encerra uma chamada ativa
<?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(); // {}
Envio de SMS
<?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(); // {}
Envio de TTS
<?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(); // {}
Envio de Audio
<?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(); // {}
Configurações de central telefonica
<?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(); // {}
Gerenciamento dos dados da Conta
<?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(); // {}
Consulta saldo da Minha Conta
<?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(); // {}
Todas as classes da API podem ser instânciadas separadamente também
<?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();
Caso você utilize um Client personalizado
<?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');
Caso você necessite utilizar seu próprio endereço configurado na 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');

Listando dids no estoque

<?php

use TotalVoice\Client as TotalVoiceClient;
use TotalVoice\Api\Chamada;

$client = new TotalVoiceClient('access-token');
$response = $client->did->listaEstoque();

Adquirindo um did

<?php

use TotalVoice\Client as TotalVoiceClient;
use TotalVoice\Api\Chamada;

$client = new TotalVoiceClient('access-token');
$idDid = "10";
$response = $client->did->adquirir($idDid);

Editando um 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);

Deletando um did

<?php

use TotalVoice\Client as TotalVoiceClient;
use TotalVoice\Api\Chamada;

$client = new TotalVoiceClient('access-token');
$didId = "11";
$response = $client->did->excluir($didId);

Listando seus dids

<?php

use TotalVoice\Client as TotalVoiceClient;
use TotalVoice\Api\Chamada;

$client = new TotalVoiceClient('access-token');
$response = $client->did->lista();

Mais informações sobre os métodos disponíveis podem ser encontrados na documentação da API, (*11)

Contribua!

Quer contribuir? clique aqui, (*12)

Licença

Esta biblioteca segue os termos de uso da MIT, (*13)

The Versions

26/07 2018

dev-master

9999999-dev

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

26/07 2018

dev-dev

dev-dev

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

26/07 2018

1.5.0

1.5.0.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

19/07 2018

1.4.0

1.4.0.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

18/05 2018

1.3.0

1.3.0.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

13/03 2018

1.2.0

1.2.0.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

07/03 2018

1.1.0

1.1.0.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

08/12 2017

1.0.9

1.0.9.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

06/12 2017

1.0.8

1.0.8.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

06/12 2017

1.0.7

1.0.7.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

06/12 2017

1.0.6

1.0.6.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

17/11 2017

1.0.5

1.0.5.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

15/11 2017

1.0.4

1.0.4.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

14/11 2017

1.0.3

1.0.3.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

10/11 2017

1.0.2

1.0.2.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

08/11 2017

1.0.1

1.0.1.0

Client para integração com API da Total Voice

  Sources   Download

MIT

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

07/11 2017

1.0.0

1.0.0.0

Client para integração com API da Total Voice

  Sources   Download

The Requires

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

06/11 2017

0.0.2-rc

0.0.2.0-RC

Client para integração com API da Total Voice

  Sources   Download

The Requires

  • php >=5.6

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto

02/11 2017

0.0.1-rc

0.0.1.0-RC

Client para integração com API da Total Voice

  Sources   Download

The Requires

  • php >=5.6

 

The Development Requires

by Diego Wagner
by Carlos Henrique dos Santos

api test sms audio integração tts central total voice chamadas minha conta gerente de contas conferência composto