Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dilowagner/tvce-client
Projeto para consumo da API Total Voice
https://github.com/dilowagner/tvce-client
Last synced: about 2 months ago
JSON representation
Projeto para consumo da API Total Voice
- Host: GitHub
- URL: https://github.com/dilowagner/tvce-client
- Owner: dilowagner
- License: mit
- Created: 2017-04-14T14:07:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-20T00:47:52.000Z (over 6 years ago)
- Last Synced: 2024-04-10T04:53:19.180Z (9 months ago)
- Language: PHP
- Size: 22.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Projeto para consumo da API TotalVoice utilizando Sockets
Master:
[](http://travis-ci.org/#!/DiloWagner/tvce-client)
[](https://github.com/DiloWagner/tvce-client)
> ### Funcionalidades
- Gerenciamento das chamadas
- Consulta e envio de SMS
- Consulta e envio de TTS
- Consulta e envio de Audio
- Gerenciamento da Conta
- Gerenciamento da Central
> ### Requisitos
- PHP 5.5+
- Autoloader compatível com a PSR-4
> ### Instalação
Para instalar a biblioteca basta adicioná-la via [composer](https://getcomposer.org/download/)
```composer
composer require tvce/client 1.0.5
```
Ou no composer.json
```json
{
"tvce/client": "1.0.5"
}
```
> ### 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 API](http://www.totalvoice.com.br/api/).
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/#/)
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
call('NUMERO-A', 'NUMERO-B');
echo $response;
$client->close();
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Consulta de chamada pelo ID
```php
getCall('ID_CHAMADA');
echo $response; // {}
$client->close();
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Encerra uma chamada ativa
```php
finish('ID_CHAMADA');
echo $response; // {}
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Envio de SMS
```php
send('NUMERO-DESTINO', 'MENSAGEM');
echo $response; // {}
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Envio de TTS
```php
send('NUMERO-DESTINO', 'MENSAGEM');
echo $response; // {}
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Envio de Audio
```php
send('NUMERO-DESTINO', 'MENSAGEM');
echo $response; // {}
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Configurações de central telefonica
```php
create();
echo $response; // {}
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
> ##### Gerenciamento dos dados da Conta
```php
get('ID_CONTA');
echo $response; // {}
} catch(SocketClientException $ex) {
echo $ex->getMessage();
}
```
Mais informações sobre os métodos disponíveis podem ser encontrados na documentação da [API](https://api2.totalvoice.com.br/doc/#/)
> ### Licença
Esta biblioteca segue os termos de uso da [MIT](https://github.com/DiloWagner/tvce-client/blob/master/LICENSE)