¶ Plusofon API — группы
версия от 2023-02-13
Группа методов позволяет создавать группы SIP-аккаунтов и управлять их параметрами.
Адрес: https://restapi.plusofon.ru
¶ Получение списка
GET api/v1/groups
Метод позволяет получить список всех созданных групп.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/groups" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/groups',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
idinteger
ИД группы -
namestring
название группы -
timeoutinteger
продолжительность вызова (в секундах) -
numberinteger
внутренний номер группы -
sequence_rulestring
код правила распределения вызовов
возможные варианты:
-
Order— в строгом порядке -
Random— в случайном порядке -
Simultaneous— одновременно
-
device_onlyboolean
признак разрешения вызова только на SIP-аккаунт (без дальнейшей переадресации) -
pickupobject
объект c параметрами перехвата звонков-
/
pickup_numberinteger
добавочный номер для перехвата -
/
approved_group_idinteger
ИД родительской группы, из которой можно перехватывать вызовы
-
{
"current_page": 2,
"data": [
{
"id": 512353,
"name": "группа21",
"timeout": 30,
"number": 300,
"sequence_rule": "Order",
"device_only": 1,
"pickup": null
},
{
"id": 512356,
"name": "группа24",
"timeout": 30,
"number": 301,
"sequence_rule": "Order",
"device_only": 0,
"pickup": {
"number": 250,
"approved_group_id": 512356
}
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/groups?page=1",
"from": 16,
"last_page": 2,
"last_page_url": "http:\/\/localhost\/api\/v1\/groups?page=2",
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/groups",
"per_page": 15,
"prev_page_url": "http:\/\/localhost\/api\/v1\/groups?page=1",
"to": 17,
"total": 17
}
¶ Родительские группы: получение списка
GET api/v1/groups/approved
Метод позволяет получить список всех возможных родительских групп.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/groups/approved" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups/approved"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/groups/approved',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups/approved'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
idinteger
ИД группы -
namestring
название группы -
timeoutinteger
продолжительность вызова (в секундах) -
numberinteger
внутренний номер группы -
sequence_rulestring
код правила распределения вызовов
возможные варианты:
-
Order— в строгом порядке -
Random— в случайном порядке -
Simultaneous— одновременно
-
device_onlyboolean
признак разрешения вызова только на SIP-аккаунт (без дальнейшей переадресации) -
pickupobject
объект с параметрами перехвата звонков-
/
pickup_numberinteger
добавочный номер для перехвата -
/
approved_group_idinteger
ИД родительской группы, из которой можно перехватывать вызовы
-
{
"current_page": 1,
"data": [
{
"id": 512356,
"name": "группа24",
"timeout": 30,
"number": 15026,
"sequence_rule": "Order",
"device_only": 0,
"pickup": {
"number": 654,
"approved_group_id": 512356
}
},
{
"id": 512357,
"name": "группа26",
"timeout": 30,
"number": 15028,
"sequence_rule": "Order",
"device_only": 0,
"pickup": {
"number": 655,
"approved_group_id": 512356
}
},
{
"id": 512358,
"name": "группа27",
"timeout": 30,
"number": 15029,
"sequence_rule": "Order",
"device_only": 0,
"pickup": {
"number": 656,
"approved_group_id": 512357
}
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/approved-groups?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/localhost\/api\/v1\/approved-groups?page=1",
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/approved-groups",
"per_page": 15,
"prev_page_url": null,
"to": 3,
"total": 3
}
¶ Получение данных
GET api/v1/groups/{group_id}
Метод позволяет получить данные конкретной группы.
¶ Параметры и примеры запроса
Path
group_idstring
⁎ ИД группыi
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/groups/minus" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups/minus"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/groups/minus',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups/minus'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
-
idinteger
ИД группы -
namestring
название группы -
timeoutinteger
продолжительность вызова (в секундах) -
numberinteger
внутренний номер группы -
sequence_rulestring
код правила распределения вызовов
возможные варианты:
-
Order— в строгом порядке -
Random— в случайном порядке -
Simultaneous— одновременно
-
device_onlyboolean
признак разрешения вызова только на SIP-аккаунт (без дальнейшей переадресации) -
pickupobject
объект с параметрами перехвата звонков-
/
pickup_numberinteger
добавочный номер для перехвата -
/
approved_group_idinteger
ИД родительской группы, из которой можно перехватывать вызовы
-
-
sipsarray
массив SIP-аккаунтов, состоящих в группе-
/
idinteger
ИД SIP-аккаунта, состоящего в группе -
/
namestring
название SIP-аккаунта, состоящего в группе
-
{
"id": 512360,
"name": "группа31",
"timeout": 30,
"number": 600,
"sequence_rule": "Order",
"device_only": 0,
"pickup": {
"number": 731,
"approved_group_id": 512360
},
"sips": [
{
"id": 57,
"name": "test@plusofontest.ru"
},
{
"id": 58,
"name": "test_sip_1"
}
],
"child_groups": [
{
"id": 512322,
"name": "группа9",
"timeout": 30,
"number": 500,
"sequence_rule": "Order",
"device_only": 0
}
]
}
¶ Создание
POST api/v1/groups
Метод позволяет создать новую группу.
¶ Параметры и примеры запроса
Body
-
numberinteger / {200 ... 99999}
⁎ внутренний номер группы -
namestring
⁎ имя группы -
sequence_rulestring
⁎ код правила распределения звонков
возможные варианты:
-
Order— в строгом порядке -
Random— в случайном порядке -
Simultaneous— одновременно
можно получить методом "GET api/v1/groups/rules"
-
timeoutinteger / {1 ... 999}
⁎ продолжительность звонка -
sipsarray
массив ИД SIP-аккаунтовi, входящих в группу -
groupsarray
массив ИД других группi, входящих в группу -
device_onlyboolean
признак разрешения вызова только на SIP-аккаунт (без дальнейшей переадресации) -
pickupboolean
признак активности перехвата звонков внутри группы -
pickup_numberinteger / {200 ... 99999}
внутренний номер для перехвата -
approved_group_idinteger / {200 ... 99999}
внутренний номер родительской группы
curl -X POST \
"https://restapi.plusofon.ru/api/v1/groups" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"number":6,"name":"atque","sequence_rule":"Order","timeout":13,"sips":[],"groups":[],"device_only":false,"pickup":true,"pickup_number":1,"approved_group_id":7}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"number": 6,
"name": "atque",
"sequence_rule": "Order",
"timeout": 13,
"sips": [],
"groups": [],
"device_only": false,
"pickup": true,
"pickup_number": 1,
"approved_group_id": 7
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://restapi.plusofon.ru/api/v1/groups',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'number' => 6,
'name' => 'atque',
'sequence_rule' => 'Order',
'timeout' => 13,
'sips' => [],
'groups' => [],
'device_only' => false,
'pickup' => true,
'pickup_number' => 1,
'approved_group_id' => 7,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups'
payload = {
"number": 6,
"name": "atque",
"sequence_rule": "Order",
"timeout": 13,
"sips": [],
"groups": [],
"device_only": false,
"pickup": true,
"pickup_number": 1,
"approved_group_id": 7
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе могут возвращаться следующие поля:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Группа успешно создана:
{
"success": true
}
¶ Обновление
PUT api/v1/groups/{group_id}
Метод позволяет редактировать конкретную группу.
¶ Параметры и примеры запроса
Path
group_idstring
⁎ ИД группыi
Body
-
numberinteger / {200 ... 99999}
⁎ внутренний номер группы -
namestring
⁎ имя группы -
sequence_rulestring
⁎ код правила распределения звонков
возможные варианты:
-
Order— в строгом порядке -
Random— в случайном порядке -
Simultaneous— одновременно
-
timeoutinteger / {1 ... 999}
⁎ продолжительность звонка -
sipsarray
массив ИД SIP-аккаунтовi, входящих в группу -
groupsarray
массив ИД других группi, входящих в группу -
device_onlyboolean
признак разрешения вызова только на SIP-аккаунт (без дальнейшей переадресации) -
pickupboolean
признак активности перехвата звонков внутри группы -
pickup_numberinteger / {200 ... 99999}
внутренний номер для перехвата -
approved_group_idinteger / {200 ... 99999}
внутренний номер родительской группы
curl -X PUT \
"https://restapi.plusofon.ru/api/v1/groups/512356" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"number":14,"name":"id","sequence_rule":"Order","timeout":19,"sips":[],"groups":[],"device_only":false,"pickup":true,"pickup_number":8,"approved_group_id":18}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups/512356"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"number": 14,
"name": "id",
"sequence_rule": "Order",
"timeout": 19,
"sips": [],
"groups": [],
"device_only": false,
"pickup": true,
"pickup_number": 8,
"approved_group_id": 18
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->put(
'https://restapi.plusofon.ru/api/v1/groups/512356',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'number' => 14,
'name' => 'id',
'sequence_rule' => 'Order',
'timeout' => 19,
'sips' => [],
'groups' => [],
'device_only' => false,
'pickup' => true,
'pickup_number' => 8,
'approved_group_id' => 18,
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups/512356'
payload = {
"number": 14,
"name": "id",
"sequence_rule": "Order",
"timeout": 19,
"sips": [],
"groups": [],
"device_only": false,
"pickup": true,
"pickup_number": 8,
"approved_group_id": 18
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе могут возвращаться следующие поля:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Группа успешно обновлена:
{
"success": true
}
¶ Удаление
DELETE api/v1/groups/{group_id}
Метод позволяет удалить конкретную группу.
¶ Параметры и примеры запроса
Path
group_idstring
⁎ ИД группыi
curl -X DELETE \
"https://restapi.plusofon.ru/api/v1/groups/est" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups/est"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://restapi.plusofon.ru/api/v1/groups/est',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups/est'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('DELETE', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе могут возвращаться следующие поля:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Группа успешно удалена:
{
"success": true
}
¶ Доступные правила: получение списка
GET api/v1/groups/rules
Метод позволяет получить список всех правил распределения звонков, доступных для назначения.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/groups/rules" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/groups/rules"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/groups/rules',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/groups/rules'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив sequence_rules:
-
rule
код правила распределения звонков -
title
название правила распределения звонков
Получены все доступные правила:
{
"sequence_rules": [
{
"rule": "Order",
"title": "По порядку"
},
{
"rule": "Random",
"title": "Случайно"
},
{
"rule": "Simultaneous",
"title": "Одновременно"
}
]
}
