Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/totalvoice/totalvoice-php
Client em PHP para API da Totalvoice
https://github.com/totalvoice/totalvoice-php
api audio chamadas conferencia ramais rest sms totalvoice tts ura
Last synced: about 2 months ago
JSON representation
Client em PHP para API da Totalvoice
- Host: GitHub
- URL: https://github.com/totalvoice/totalvoice-php
- Owner: totalvoice
- License: mit
- Created: 2017-10-30T23:03:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-30T19:33:22.000Z (over 3 years ago)
- Last Synced: 2024-09-22T08:16:01.365Z (3 months ago)
- Topics: api, audio, chamadas, conferencia, ramais, rest, sms, totalvoice, tts, ura
- Language: PHP
- Homepage:
- Size: 107 KB
- Stars: 29
- Watchers: 13
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# totalvoice-php
Cliente em PHP para API da Totalvoice
[](http://travis-ci.org/#!/totalvoice/totalvoice-php)
[](https://github.com/totalvoice/totalvoice-php)
> ### 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](https://getcomposer.org/download/)
```composer
composer require total-voice/php-client 1.*
```
Ou no composer.json
```json
{
"total-voice/php-client": "1.*"
}
```
> ### Testes
Podemos usar o composer para rodar os testes:
```composer
composer test
```
ou utilizando o .phar
```composer
php composer.phar test
```
> ### Utilização
Para utilizar esta biblioteca, primeiramente você deverá realizar um cadastro no site da [Total Voice](http://www.totalvoice.com.br).
Após a criação do cadastro será disponibilizado um AccessToken para acesso a API.
Com o AccessToken em mãos será possível realizar as consultas/cadastros conforme documentação da [API](https://api.totalvoice.com.br/doc/#/)
Os métodos da API que poderão ser invocados:
- audio
- central
- chamada
- composto
- conferencia
- conta
- perfil
- sms
- tts
A seguir um pequeno exemplo de como pode ser utilizada esta biblioteca.
> ##### Realiza uma chamada telefônica entre dois números: A e B
```php
chamada->ligar('NUMERO-A', 'NUMERO-B');
echo $response->getContent();
```
> ##### Consulta de chamada pelo ID
```php
chamada->buscaChamada('ID_CHAMADA');
echo $response->getContent(); // {}
```
> ##### Encerra uma chamada ativa
```php
chamada->encerrar('ID_CHAMADA');
echo $response->getContent(); // {}
```
> ##### Envio de SMS
```php
sms->enviar('NUMERO-DESTINO', 'SUA MENSAGEM');
echo $response->getContent(); // {}
```
> ##### Envio de TTS
```php
tts->enviar('NUMERO-DESTINO', 'SUA MENSAGEM');
echo $response->getContent(); // {}
```
> ##### Envio de Audio
```php
audio->enviar('NUMERO-DESTINO', 'SUA MENSAGEM');
echo $response->getContent(); // {}
```
> ##### Configurações de central telefonica
```php
central->buscaRamal('ID-RAMAL');
echo $response->getContent(); // {}
```
> ##### Gerenciamento dos dados da Conta
```php
conta->buscaConta('ID_CONTA');
echo $response->getContent(); // {}
```
> ##### Consulta saldo da Minha Conta
```php
perfil->consultaSaldo();
echo $response->getContent(); // {}
```
> ##### Todas as classes da API podem ser instânciadas separadamente também
```php
ligar('NUMERO-A', 'NUMERO-B');
echo $response->getContent();
```
> ##### Caso você utilize um Client personalizado
```php
ligar('NUMERO-A', 'NUMERO-B');
```
> ##### Caso você necessite utilizar seu próprio endereço configurado na Total Voice
```php
ligar('NUMERO-A', 'NUMERO-B');
```
> #### Listando dids no estoque
```php
did->listaEstoque();
```
> #### Adquirindo um did
```php
did->adquirir($idDid);
```
> #### Editando um did
```php
did->atualizar($idDid, $ramalId, $uraId);
```
> #### Deletando um did
```php
did->excluir($didId);
```
> #### Listando seus dids
```php
did->lista();
```
Mais informações sobre os métodos disponíveis podem ser encontrados na documentação da [API](https://api.totalvoice.com.br/doc/#/)
> ### Contribua!
Quer contribuir? [clique aqui](https://github.com/totalvoice/totalvoice-php/blob/master/CONTRIBUTING.md)
> ### Licença
Esta biblioteca segue os termos de uso da [MIT](https://github.com/totalvoice/totalvoice-php/blob/master/LICENSE)