¶ Plusofon API — списки контактов
версия от 2023-02-13
Группа методов позволяет управлять контактами для объединения в белые и чёрные списки.
Адрес: https://restapi.plusofon.ru
¶ Получение списка
GET api/v1/contact-lists
Метод позволяет получить перечень всех созданных списков контактов.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/contact-lists" \
-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/contact-lists"
);
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/contact-lists',
[
'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/contact-lists'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
id
ИД списка -
name
название списка -
type
тип списка
возможные варианты:
-
black
«чёрный» список -
white
«белый» список (пока не используется)
{
"current_page": 1,
"data": [
{
"id": 11,
"name": "Черный список 1",
"type": "black"
},
{
"id": 17,
"name": "Белый список 1",
"type": "white"
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/contact-lists?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/localhost\/api\/v1\/contact-lists?page=1",
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/contact-lists",
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2,
"success": true
}
¶ Получение контактов
GET api/v1/contact-lists/{contact_list_id}
Метод позволяет получить данные контактов из конкретного списка.
¶ Параметры и примеры запроса
Path
contact_list_idstring
⁎ ИД списка контактовi
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/contact-lists/15" \
-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/contact-lists/15"
);
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/contact-lists/15',
[
'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/contact-lists/15'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив contacts:
-
name
имя контакта -
phones
массив телефонных номеров контакта
{
"id": 19,
"name": "Черный Список 1",
"type": "black",
"contacts": [
{
"name": "Иван Иванов",
"phones": [
"79998887700",
"79992223300"
]
},
{
"name": "Петр Петров",
"phones": [
"79997776600",
"79993334400"
]
}
],
"success": true
}
¶ Создание
POST api/v1/contact-lists
Метод позволяет создать новый список контактов.
URL для получения созданного списка контактов находится в заголовке "Location".
¶ Параметры и примеры запроса
Body
-
namestring
⁎ название списка -
typestring
⁎ тип списка контактов (цвет)i -
contactsarray
массив контактов-
/
namestring
⁎ имя контакта -
/
phonesarray
⁎ массив телефонных номеров контакта
-
curl -X POST \
"https://restapi.plusofon.ru/api/v1/contact-lists" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Black List 1","type":"black","contacts":[{"name":"Ivan Ivanov","phones":["79998887766"]}]}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/contact-lists"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Black List 1",
"type": "black",
"contacts": [
{
"name": "Ivan Ivanov",
"phones": [
"79998887766"
]
}
]
}
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/contact-lists',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'name' => 'Black List 1',
'type' => 'black',
'contacts' => [
[
'name' => 'Ivan Ivanov',
'phones' => [
'79998887766',
],
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/contact-lists'
payload = {
"name": "Black List 1",
"type": "black",
"contacts": [
{
"name": "Ivan Ivanov",
"phones": [
"79998887766"
]
}
]
}
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/contact-lists/{contact_list_id}
Метод позволяет обновить состав конкретного списка контактов.
¶ Параметры и примеры запроса
Path
contact_list_idstring
⁎ ИД списка контактовi
Body
-
namestring
⁎ название списка -
typestring
⁎ тип списка контактов (цвет)i -
contactsarray
массив контактов-
/
namestring
⁎ имя контакта -
/
phonesarray
⁎ массив телефонных номеров контакта
-
curl -X PUT \
"https://restapi.plusofon.ru/api/v1/contact-lists/15" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Black List 1","type":"black","contacts":[{"name":"Ivan Ivanov","phones":["79998887766"]}]}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/contact-lists/15"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Black List 1",
"type": "black",
"contacts": [
{
"name": "Ivan Ivanov",
"phones": [
"79998887766"
]
}
]
}
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/contact-lists/15',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'name' => 'Black List 1',
'type' => 'black',
'contacts' => [
[
'name' => 'Ivan Ivanov',
'phones' => [
'79998887766',
],
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/contact-lists/15'
payload = {
"name": "Black List 1",
"type": "black",
"contacts": [
{
"name": "Ivan Ivanov",
"phones": [
"79998887766"
]
}
]
}
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/contact-lists/{contact_list_id}
Метод позволяет удалить конкретный список контактов.
¶ Параметры и примеры запроса
Path
contact_list_idpath
⁎ ИД списка контактов
curl -X DELETE \
"https://restapi.plusofon.ru/api/v1/contact-lists/15" \
-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/contact-lists/15"
);
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/contact-lists/15',
[
'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/contact-lists/15'
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/contact-lists/types
Метод позволяет получить перечень типов списков контактов, доступных для создания.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/contact-lists/types" \
-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/contact-lists/types"
);
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/contact-lists/types',
[
'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/contact-lists/types'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив types:
-
type
код типа -
title
название типа
{
"types": [
{
"type": "black",
"title": "Черный"
},
{
"type": "white",
"title": "Белый"
}
],
"success": true
}
