¶ Plusofon API — голосовая почта
версия от 2023-02-13
Группа методов позволяет настраивать голосовую почту.
Адрес: https://restapi.plusofon.ru
¶ Получение настроек
GET api/v1/voicemail
Метод позволяет получить текущие настройки голосовой почты.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/voicemail" \
-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/voicemail"
);
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->patch(
'https://restapi.plusofon.ru/api/v1/voicemail',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'send' => true,
'email' => 'rerum',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/voicemail'
payload = {
"send": true,
"email": "rerum"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
-
email
email-адрес для отправки записей -
sendboolean
признак включения отправки записей
{
"email": "test@mail.ru",
"send": true
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
¶ Обновление настроек
PATCH api/v1/voicemail
Метод позволяет установить настройки голосовой почты.
¶ Параметры и примеры запроса
Body
-
sendboolean
⁎ признак включения отправки записей -
emailstring
⁎ email-адрес для отправки записей
curl -X PATCH \
"https://restapi.plusofon.ru/api/v1/voicemail" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"send":true,"email":"rerum"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/voicemail"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"send": true,
"email": "rerum"
}
fetch(url, {
method: "PATCH",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->patch(
'https://restapi.plusofon.ru/api/v1/voicemail',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'send' => true,
'email' => 'rerum',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/voicemail'
payload = {
"send": true,
"email": "rerum"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Настройки успешно обновлены:
{
"success": true
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
