¶ Plusofon API — мониторинг (вебхуки)
версия от 2023-02-13
Группа методов позволяет настраивать отправку вебхуков для мониторинга звонков.
В рамках данной документации каждый настроенный триггер системы мониторинга так же называется «вебхук».
Адрес: https://restapi.plusofon.ru
¶ Получение списка
GET api/v1/webhooks
Метод позволяет получить список всех вебхуков системы мониторинга.
¶ Параметры и примеры запроса
Body
typestring
код типа вебхука (по умолчанию —lk)
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/webhooks" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"type":"et"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/webhooks"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"type": "et"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/webhooks',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'type' => 'et',
],
]
);
$body = $response->getBody();
print_r(json_decode(( * *string*{.caption}*) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/webhooks'
payload = {
"type": "et"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
id
ИД вебхука -
url
адрес, на который отправляется вебхук -
type_call
код отслеживаемого направления вызова
возможные варианты:
-
inbound— входящие вызовы -
outbound— исходящие вызовы
-
type
код типа вебхука -
event
код отслеживаемого события
возможные варианты:
-
create— создание вызова -
answer— принятие входящего вызова -
destroy— завершение вызова
{
"current_page": 1,
"data": [
{
"id": 5,
"url": "https:\/\/test.com\/hook-in",
"type_call": "inbound",
"type": "lk",
"event": "destroy"
},
{
"id": 6,
"url": "https:\/\/test.com\/hook-out",
"type_call": "outbound",
"type": "lk",
"event": "create"
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/webhooks?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/localhost\/api\/v1\/webhooks?page=1",
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/webhooks",
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2
}
¶ Получение данных
GET api/v1/webhooks/{webhook_id}
Метод позволяет получить данные конкретного вебхука системы мониторинга.
¶ Параметры и примеры запроса
Path
webhook_idstring
⁎ ИД вебхукаi
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/webhooks/42" \
-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/webhooks/42"
);
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/webhooks/42',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode(( * *string*{.caption}*) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/webhooks/42'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
-
id
ИД вебхука -
url
адрес, на который отправляется вебхук -
event
код отслеживаемого события
возможные варианты:
-
create— создание вызова -
answer— принятие входящего вызова -
destroy— завершение вызова
type_call
код отслеживаемого направления вызова
возможные варианты:
-
inbound— входящие вызовы -
outbound— исходящие вызовы
-
type
код типа вебхука -
type_style
код стиля именования направлений вызовов
возможные варианты:
-
long— длинный (inbound,outbound) -
short— короткий (in,out)
-
template
используемый шаблон -
fields
массив переименованных стандартных полей вебхука-
/
before
стандартное имя поля -
/
after
новое имя поля
-
-
headers
массив собственных HTTP-заголовков-
/
name
имя собственного HTTP-заголовка -
/
value
значение собственного HTTP-заголовка
-
-
params
массив произвольных параметров-
/
name
имя произвольного параметра -
/
value
значение произвольного параметра
-
{
"id": 5,
"params": [
{
"name": "my-param",
"value": "my-param value"
}
],
"url": "https:\/\/test.com\/hook",
"type_call": "inbound",
"type": "lk",
"event": "destroy",
"fields": [
{
"before": "call_id",
"after": "my_call_id"
},
{
"before": "direction",
"after": "my_direction"
}
],
"type_style": "short",
"template": null,
"headers": [
{
"name": "my-header",
"value": "my_header_value"
}
]
}
¶ Создание
POST api/v1/webhooks
Метод позволяет создать новый вебхук системы мониторинга.
¶ Параметры и примеры запроса
Body
-
urlstring
⁎ адрес, на который отправляется вебхук -
eventstring
⁎ код отслеживаемого события
возможные варианты:
-
create— создание вызова -
answer— принятие входящего вызова -
destroy— завершение вызова
type_callstring
⁎ код отслеживаемого направления вызова
возможные варианты:
-
inbound— входящие вызовы -
outbound— исходящие вызовы
type_stylestring
код стиля именования направлений вызовов
возможные варианты:
-
long— длинный (inbound,outbound) -
short— короткий (in,out)
-
fieldsarray
массив переименованных стандартных полей вебхука-
/
beforestring
⁎ стандартное имя поля -
/
afterstring
⁎ новое имя поля
-
-
headersarray
массив собственных HTTP-заголовков-
/
namestring
⁎ имя собственного HTTP-заголовка -
/
valuestring
⁎ значение собственного HTTP-заголовка
-
-
paramsarray
массив произвольных параметров-
/
namestring
⁎ имя произвольного параметра -
/
valuestring
⁎ значение произвольного параметра
-
-
templatestring
шаблон
curl -X POST \
"https://restapi.plusofon.ru/api/v1/webhooks" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"url":"http:\/\/my-url.com","event":"create","type_call":"all","type_style":"long","headers":[{"name":"Special-Header","value":"header_value"}],"params":[{"name":"special_parameter","value":"123"}],"fields":[{"before":"to","after":"dest_number"}],"template":"quos"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/webhooks"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"url": "http:\/\/my-url.com",
"event": "create",
"type_call": "all",
"type_style": "long",
"headers": [
{
"name": "Special-Header",
"value": "header_value"
}
],
"params": [
{
"name": "special_parameter",
"value": "123"
}
],
"fields": [
{
"before": "to",
"after": "dest_number"
}
],
"template": "quos"
}
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/webhooks',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'url' => 'http://my-url.com',
'event' => 'create',
'type_call' => 'all',
'type_style' => 'long',
'headers' => [
[
'name' => 'Special-Header',
'value' => 'header_value',
],
],
'params' => [
[
'name' => 'special_parameter',
'value' => '123',
],
],
'fields' => [
[
'before' => 'to',
'after' => 'dest_number',
],
],
'template' => 'quos',
],
]
);
$body = $response->getBody();
print_r(json_decode(( * *string*{.caption}*) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/webhooks'
payload = {
"url": "http:\/\/my-url.com",
"event": "create",
"type_call": "all",
"type_style": "long",
"headers": [
{
"name": "Special-Header",
"value": "header_value"
}
],
"params": [
{
"name": "special_parameter",
"value": "123"
}
],
"fields": [
{
"before": "to",
"after": "dest_number"
}
],
"template": "quos"
}
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/webhooks/{webhook_id}
Метод позволяет изменить конкретный вебхук системы мониторинга.
¶ Параметры и примеры запроса
Path
webhook_idstring
⁎ ИД вебхукаi
Body
-
urlstring
⁎ адрес, на который отправляется вебхук -
eventstring
⁎ код отслеживаемого события
возможные варианты:
-
create— создание вызова -
answer— принятие входящего вызова -
destroy— завершение вызова
type_callstring
⁎ код отслеживаемого направления вызова
возможные варианты:
-
inbound— входящие вызовы -
outbound— исходящие вызовы
type_stylestring
код стиля именования направлений вызовов
возможные варианты:
-
long— длинный (inbound,outbound) -
short— короткий (in,out)
-
fieldsarray
массив переименованных стандартных полей вебхука-
/
beforestring
⁎ стандартное имя поля -
/
afterstring
⁎ новое имя поля
-
-
headersarray
массив собственных HTTP-заголовков-
/
namestring
⁎ имя собственного HTTP-заголовка -
/
valuestring
⁎ значение собственного HTTP-заголовка
-
-
paramsarray
массив произвольных параметров-
/
namestring
⁎ имя произвольного параметра -
/
valuestring
⁎ значение произвольного параметра
-
-
templatestring
шаблон
curl -X PUT \
"https://restapi.plusofon.ru/api/v1/webhooks/42" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"url":"http:\/\/my-url.com","event":"create","type_call":"all","type_style":"long","headers":[{"name":"Special-Header","value":"header_value"}],"params":[{"name":"special_parameter","value":"123"}],"fields":[{"before":"to","after":"dest_number"}],"template":"expedita"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/webhooks/42"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"url": "http:\/\/my-url.com",
"event": "create",
"type_call": "all",
"type_style": "long",
"headers": [
{
"name": "Special-Header",
"value": "header_value"
}
],
"params": [
{
"name": "special_parameter",
"value": "123"
}
],
"fields": [
{
"before": "to",
"after": "dest_number"
}
],
"template": "expedita"
}
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/webhooks/42',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'url' => 'http://my-url.com',
'event' => 'create',
'type_call' => 'all',
'type_style' => 'long',
'headers' => [
[
'name' => 'Special-Header',
'value' => 'header_value',
],
],
'params' => [
[
'name' => 'special_parameter',
'value' => '123',
],
],
'fields' => [
[
'before' => 'to',
'after' => 'dest_number',
],
],
'template' => 'expedita',
],
]
);
$body = $response->getBody();
print_r(json_decode(( * *string*{.caption}*) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/webhooks/42'
payload = {
"url": "http:\/\/my-url.com",
"event": "create",
"type_call": "all",
"type_style": "long",
"headers": [
{
"name": "Special-Header",
"value": "header_value"
}
],
"params": [
{
"name": "special_parameter",
"value": "123"
}
],
"fields": [
{
"before": "to",
"after": "dest_number"
}
],
"template": "expedita"
}
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/webhooks/{webhook_id}
Метод позволяет удалить конкретный вебхук системы мониторинга.
¶ Параметры и примеры запроса
Path
webhook_idstring
⁎ ИД вебхукаi
curl -X DELETE \
"https://restapi.plusofon.ru/api/v1/webhooks/42" \
-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/webhooks/42"
);
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/webhooks/42',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode(( * *string*{.caption}*) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/webhooks/42'
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
}
