Merge branch 'release/0.1.2'

denostr · Jun 15, 2018 · f56d5c5 · f56d5c5
2 parents 83a48c4 + fe6603a
commit f56d5c5
Show file tree

Hide file tree

Showing 8 changed files with 726 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -38,9 +38,9 @@ try {
 }
 ```
 
-## Модели
+## Документация
 
-* `Stats` - модель для получения статистики по звонками;
-* `Customers` - модель для работы с клиентами;
-* `Calls` - модель для работы со звонками;
-* `Settings` - модель для получения настроек виртуальной АТС;
+* [`Stats`](docs/rest/stats.md) - модель для получения статистики по звонками;
+* [`Customers`](docs/rest/customers.md) - модель для работы с клиентами;
+* [`Calls`](docs/rest/calls.md) - модель для работы со звонками;
+* [`Settings`](docs/rest/settings.md) - модель для получения настроек виртуальной АТС;
diff --git a/docs/rest/calls.md b/docs/rest/calls.md
@@ -0,0 +1,172 @@
+# Calls
+Модель инициализации звонков.
+****
+
+## extToPhone()
+
+Инициирование двустороннего звонка с внутренней линией и внешним номером.
+
+### Обязательные параметры:
+
+#### `ext_number`
+Внутренний номер сотрудника (первый участник разговора).
+
+#### `phone_number`
+Телефонный номер куда нужно позвонить (второй участник разговора).
+
+
+
+### Дополнительные параметры:
+
+#### `callTimeToExt`
+Длительность дозвона на внутреннюю линию (по умолчанию 30 секунд).
+
+#### `limitCallTime`
+Ограничение длительности звонка в секундах.
+
+#### `playbackWaiting`
+Проигрывание, первому участнику разговора сообщения:
+"ожидайте пожалуйста на линии, происходит соединение со 2-м участником разговора". По умолчанию ***true***, принимает значения: ***true*** или ***false***.
+
+#### `trunkNumber`
+Номер через который будет совершаться звонок на телефонный номер.
+
+#### `callerIdForEmployee`
+Смена отображения информации о номере куда будем звонить на экране телефона у сотрудника, по умолчанию отображается телефонный номер куда нужно позвонить. В основном данный параметр используется для скрытия телефонного номера от сотрудника (примеры: Private или CRM client id 3320).
+
+
+#### `async`
+Не дожидаться результата звонка на внутреннюю линию. По умолчанию ***false***, принимает значения: ***true*** или ***false***.
+
+
+### Пример
+
+```
+$client->calls->extToPhone([
+	'ext_number' => '910',
+	'phone_number' => '0443334023',
+]);
+
+```
+
+## phoneToPhone()
+
+Инициирование двустороннего звонка c двумя внешними номерами.
+
+### Обязательные параметры:
+
+#### `phoneNumber1`
+Первый внешний номер.
+
+#### `phoneNumber2`
+Второй внешний номер.
+
+#### `trunkNumber`
+Номер через который будут совершаться оба звонка.
+
+
+### Дополнительные параметры:
+
+#### `limitCallTime`
+Ограничение длительности звонка в секундах.
+
+#### `playbackWaiting`
+Проигрывание, первому участнику разговора, фразы: "ожидайте пожалуйста на линии, происходит соединение со 2-м участником разговора". По умолчанию стоит ***true***, принимает значения: ***true*** или ***false***.
+
+
+### Пример
+
+```
+$client->calls->phoneToPhone([
+	'phoneNumber1' => '0970002233',
+	'phoneNumber2' => '0443334333',
+	'trunkNumber' => '0443334023',
+	'limitCallTime' => '120'
+]);
+```
+
+## attendedCallTransfer()
+
+Перевод звонка.
+
+### Обязательные параметры:
+
+#### `generalCallID`
+Идентификатор звонка.
+
+#### `phone_number`
+Номер на который переводится звонок.
+
+### Пример
+
+```
+$client->calls->attendedCallTransfer([
+	'generalCallID' => '22661563',
+	'phone_number' => '912'
+]);
+
+```
+
+## hangupCall()
+
+Завершение звонка.
+
+### Обязательные параметры:
+
+### `generalCallID`
+Идентификатор звонка.
+
+### Пример
+
+```
+$client->calls->hangupCall([
+	'generalCallID' => '22661891'
+]);
+
+```
+
+## callWithAnnouncement()
+
+Звонок с проигрыванием голосового файла.
+
+### Обязательные параметры:
+
+#### `phone_number`
+
+Телефонный номер кому будет проигрываться оповещение.
+
+#### `voiceFileID`
+
+Идентификатор голосового файла.
+
+### Пример
+
+```
+$client->calls->callWithAnnouncement([
+	'phone_number' => '0443334023',
+	'voiceFileID' => '4'
+]);
+
+```
+
+## callWithInteractiveVoiceResponse()
+
+Звонок с голосовым меню.
+
+### Обязательные параметры:
+
+#### `phone_number`
+Телефонный номер кому будет проигрываться оповещение.
+
+#### `ivrName`
+Имя голосового меню.
+
+### Пример
+
+```
+$client->calls->callWithInteractiveVoiceResponse([
+	'phone_number' => '0443334023',
+	'ivrName' => 'confirmation-call'
+]);
+
+```
diff --git a/docs/rest/customers.md b/docs/rest/customers.md
@@ -0,0 +1,193 @@
+# Customers
+Модель для работы с клиентами.
+****
+
+## getList()
+
+Получение информации о всех клиентах.
+
+### Пример
+
+```
+$client->customers->getList();
+
+```
+
+## takeById()
+
+Получение информации о клиенте по его идентификатору.
+
+### Обязательные параметры:
+
+#### `customerID`
+
+Идентификатор клиента или идентификаторы клиентов в массиве.
+
+### Пример
+
+```
+$client->customers->takeById([
+	'customerID' => '6611'
+]);
+```
+
+## takeByLabel()
+
+Получение информации о клиентах по метке.
+
+### Обязательные параметры:
+
+#### `labelID`
+
+Идентификатор метки.
+
+### Пример
+
+```
+$client->customers->takeByLabel([
+	'labelID' => '146'
+]);
+```
+
+## search()
+
+Поиск клиентов по имени или номеру телефона.
+
+### Обязательные параметры:
+
+#### `subject`
+
+Имя или номер телефона (можно не полностью)
+
+### Пример
+
+```
+$client->customers->search([
+	'subject' => 'Генадий'
+]);
+```
+
+## create()
+
+Создание нового клиента/
+
+### Обязательные параметры:
+
+#### `numbers`
+
+Номера телефонов в массиве, номера должны быть уникальными.
+
+### Дополнительные параметры:
+
+#### `description`
+
+Информация о клиенте.
+
+#### `email`
+
+Email клиента.
+
+#### `assignedToEmployeeNumber`
+
+Внутренний номер сотрудника.
+
+#### `labels`
+
+Идентификаторы меток в массиве.
+
+### Пример
+
+```
+$client->customers->create([
+	'name' => 'New client',
+	'numbers' => [
+		'0970003322', 
+		'0939990099'
+	],
+	'description' => 'Информаиця о клиенте!',
+	'email' => '[email protected]',
+	'assignedToEmployeeNumber' => '904'
+]);
+```
+
+## update()
+
+Редактирование клиента.
+
+**Важно: все переданные дополнительные параметры, будут перезаписаны.**
+
+### Обязательные параметры:
+
+#### `id`
+
+Идентификатор клиента.
+
+### Дополнительные параметры:
+
+#### `name`
+
+Имя клиента, имя должно быть уникальным.
+
+#### `numbers`
+
+Номера телефонов в массиве, номера должны быть уникальными.
+
+#### `description`
+
+Информация о клиенте.
+
+#### `email`
+
+Email клиента.
+
+#### `assignedToEmployeeNumber`
+
+Внутренний номер сотрудника.
+
+#### `labels`
+
+Массив клиента с идентификаторами меток.
+
+### Пример
+
+```
+$client->customers->update([
+	'id' => '6611',
+	'name' => 'Sales Binotel',
+	'numbers' => [
+		'0971553605', 
+		'0939990099'
+	],
+	'description' => '',
+	'assignedToEmployeeNumber' => '',
+	'labels' => []
+]);
+```
+
+## delete()
+
+Удаление клиента.
+
+### Обязательные параметры:
+
+#### `customerID`
+
+Идентификаторы клиентов в массиве.
+
+### Пример
+
+```
+$client->customers->delete([
+	'customerID' => ['270334']
+]);
+```
+
+## listOfLabels()
+
+Получение всех меток.
+
+### Пример
+
+```
+$client->customers->listOfLabels();
+```