README

您可以在 phonet 网站上获取原始文档

安装

composer require wearesho-team/phonet

配置

存在两种配置实现

• Config - 自定义配置
• EnvironmentConfig - 基于 Horatius\Environment\Config

可用的环境变量

使用 ConfigInterface 创建您的自定义配置

用法

提供者

要使用 Phonet API，您必须授权服务。为此存在 Authorization\ProviderInterface

<?php

use Wearesho\Phonet;

$client = new \GuzzleHttp\Client();
$provider = new Phonet\Authorization\Provider($client);

如果您想缓存您的认证数据，请使用 CacheProvider;

发送者

所有 API 方法都使用 Sender

<?php

use Wearesho\Phonet;

/** @var Phonet\Authorization\ProviderInterface $provider */

$client = new \GuzzleHttp\Client();
$config = new Phonet\EnvironmentConfig();

$sender = new Phonet\Sender(
    $client,
    $config,
    $provider
);

服务

makeCall(string $operatorInternalNumber, string $targetNumber): string

开始新的呼叫并返回其唯一的 uuid。

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$service = new Phonet\Service($sender);

$uuid = $service->makeCall(
    $operatorInternalNumber = '001', // Internal number of operator
    $callTakerNumber = '380000000002' // Phone number of target
);

hangupCall(string $uuid): void

通过唯一 uuid 结束呼叫/对话

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$service = new Phonet\Service($sender);

$service->hangupCall(
    $uuid = 'uuid'
);

仓库

仓库包含在 Phonet 服务中搜索数据的方法。

activeCalls()

返回当前正在进行的呼叫集合。

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$repository = new Phonet\Repository($sender);

$activeCalls = $repository->activeCalls();

missedCalls(...)

返回需要回拨的呼叫集合。

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$repository = new Phonet\Repository($sender);

$missedCalls = $repository->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(...)

返回公司发起的呼叫集合。

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$repository = new Phonet\Repository($sender);

$companyCalls = $repository->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()

返回员工发起的呼叫集合。

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$repository = new Phonet\Repository($sender);

$usersCalls = $repository->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()

返回公司的员工集合。

<?php

use Wearesho\Phonet;

/** @var Phonet\Sender $sender */

$repository = new Phonet\Repository($sender);

$users = $repository->users();

作者

• Roman Varkuta

许可

MIT