https://github.com/wearesho-team/phonet
Phonet Api Integration
https://github.com/wearesho-team/phonet
https phonet phonet-api
Last synced: about 1 year ago
JSON representation
Phonet Api Integration
- Host: GitHub
- URL: https://github.com/wearesho-team/phonet
- Owner: wearesho-team
- License: mit
- Created: 2019-01-17T12:44:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-01T18:19:32.000Z (about 7 years ago)
- Last Synced: 2025-02-15T00:48:35.102Z (over 1 year ago)
- Topics: https, phonet, phonet-api
- Language: PHP
- Size: 76.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Phonet Api integration
You can receive original docs on [phonet](https://phonet.com.ua/) site
## Installation
```bash
composer require wearesho-team/phonet
```
## Configuration
Exist two implementation of configurations:
- [Config](./src/Config.php) - custom config
- [EnvironmentConfig](./src/EnvironmentConfig.php) - based on
[Horatius\Environment\Config](https://github.com/Horat1us/environment-config)
Available environment variables:
|variable|required|description|
|--------|--------|-----------|
|PHONET_DOMAIN|Yes|Domain name of your cms\system|
|PHONET_API_KEY|Yes|Special api key that ypu can receive in your Phonet account|
Use [ConfigInterface](./src/ConfigInterface.php) to create your custom config
## Usage
### Provider
To use **Phonet** api you must authorize to service. For this exist [Authorization\ProviderInterface](./src/Authorization/ProviderInterface.php)
```php
makeCall(
$operatorInternalNumber = '001', // Internal number of operator
$callTakerNumber = '380000000002' // Phone number of target
);
```
#### hangupCall(string $uuid): void
End a call / conversation by unique uuid
```php
hangupCall(
$uuid = 'uuid'
);
```
### Repository
Repository contains methods for searching data in Phonet Service.
#### activeCalls()
|param |value |
|-----------|-----------------|
|Return type| [Call\Active\Collection](src/Call/Active/Collection.php)|
|Arguments| - |
Returns collection of calls that currently taking place.
```php
activeCalls();
```
#### missedCalls(...)
|param |value |
|-----------|-----------------|
|Return type| [Call\Complete\Collection](src/Call/Complete/Collection.php)|
|Arguments|$from, $to, $directions, $limit, $offset|
Returns a collection of calls to call back.
```php
missedCalls(
$from = new DateTime(),
$to = new DateTime(),
$directions = new Phonet\Call\Direction\Collection([/** @see Phonet\Call\Direction */]),
$limit = 10, // count of needs calls
$offset = 5 // shift in sample
);
```
#### companyCalls(...)
|param |value |
|-----------|-----------------|
|Return type| [Call\Complete\Collection](src/Call/Complete/Collection.php)|
|Arguments|$from, $to, $directions, $limit, $offset|
Returns a collection of calls made by the company.
```php
companyCalls(
$from = new DateTime(),
$to = new DateTime(),
$directions = new Phonet\Call\Direction\Collection([/** @see Phonet\Call\Direction */]),
$limit = 10, // count of needs calls
$offset = 5 // shift in sample
);
```
#### usersCalls()
|param |value |
|-----------|-----------------|
|Return type| [Call\Complete\Collection](src/Call/Complete/Collection.php)|
|Arguments|$from, $to, $directions, $limit, $offset|
Returns a collection of calls made by employees.
```php
usersCalls(
$from = new DateTime(),
$to = new DateTime(),
$directions = new Phonet\Call\Direction\Collection([/** @see Phonet\Call\Direction */]),
$limit = 10, // count of needs calls
$offset = 5 // shift in sample
);
```
#### users()
|param |value |
|-----------|-----------------|
|Return type| [Employee\Collection](src/Employee/Collection.php)|
|Arguments| - |
Returns a collection of employees of company.
```php
users();
```
## Authors
- [Roman Varkuta](mailto:roman.varkuta@gmail.com)
## License
[MIT](./LICENSE)