README

非官方 php-api-SDK！目前仅支持一种应用程序授权类型 - client_credentials

telphin 官方文档 - https://ringme-confluence.atlassian.net/wiki/spaces/Ringme/overview Api 交互式浏览器 - https://apiproxy.telphin.ru/api/ver1.0/client_api_explorer/

开发中！

composer require telphin/api-client:dev-master

连接

在开始使用之前，请连接到 autoloader 框架。主要类的工作方式如下

$client = new Telphin\Client(
  "{Your client_id}",
  "{Your client_secret}"
);

处理方法

获取用户类型为“客户”时的内部号码示例

$clientExtensions = $client->getClExtension();

默认参数为 $data = [] 和 $client_id = "@me"。$data 可以接受的所有数据均在 GET /api/ver1.0/client/{client_id}/extension/ 的交互式浏览器中列出

如果需要获取队列列表，可以使用以下方法

$clientQueue = $client->getClExtension(array(
  "type" => "queue"
));

大多数方法都标记为 {get/add/upd/del}{Cl/Ext}{NameAndDescription}。例如 getClRecordList, addClNewAgent, getExtAgent。

可用方法说明

获取客户限制： GET /client/{client_id}/limit/

$clientLimit = $client->getClLimit("@me");

获取内部号码组： GET /client/{client_id}/extension_group/

$client->getClExtensionGroup();

添加内部号码组： POST /client/{client_id}/extension_group/

$client->addClExtensionGroup(array(
  "name" => "Тестовая группа",
  "extra_params" => ""
));

更新内部号码组： PUT /client/{client_id}/extension_group/{ext_group_id}

$client->updClExtensionGroup(8447, array(
  "name" => "неТестовая группа",
));

删除内部号码组： DELETE /client/{client_id}/extension_group/{ext_group_id}

$client->delClExtensionGroup(8447);

获取客户内部号码列表： GET /client/{client_id}/extension/

/**
* @param array $data = [] массив с параметрами фильтра
* @param int $extension_id = 0 для поиска по определенному id
*/
$client->getClExtension(); // ЛИСТ
$client->getClExtension([], 1231); // Конкретный номер

添加内部号码： POST /client/{client_id}/extension/

/**
* @param array $data - массив с параметрами
*/
$client->addClExtension([], 1231);

更新内部号码： PUT /client/{client_id}/extension/{extension_id}

/**
* @param array $data - массив с параметрами
* @param int $extension_id
*/
$client->updClExtension(array(
  "caller_id_name" => "Тест",
  "label" => "Тест"
), 1231);

删除内部号码： DELETE /client/{client_id}/extension/{extension_id}

/**
* @param int $extension_id
*/
$client->delClExtension(1231);

获取代理列表： GET /client/{client_id}/agent/local/

/**
* @param array[int] $extension_id = [] для выборки добавочных
*/
$client->getClAgentsList();

获取队列代理的 http 事件： GET /client/{client_id}/agent/local/{agent_id}/event/

/**
* @param int $agent_id идентификтор агента очереди
* @param int $event_id = 0 Для получения конкретного события
*/
$client->getClAgentEvents(1231);

添加队列代理的 http 事件： POST /client/{client_id}/agent/local/{agent_id}/event/

/**
* @param int $agent_id идентификтор агента очереди
* @param array $data параметры
*/
$client->addClAgentEvent(3443, array(
  "event_type" => "agent-login",
  "method" => "POST",
  "url" => "{Your handler url}"
));

删除队列代理的 http 事件： DELETE /client/{client_id}/agent/local/{agent_id}/event/{event_id}

/**
* @param int $agent_id идентификтор агента очереди
* @param int $event_id идентификатор события
*/
$client->delClAgentEvent(3443, 2341);