¶ FlashCall API (архивный)
- ⚠️ Эта документация описывает устаревшую версию FlashCall API для личных кабинетов portal.plusofon.ru и new-portal.plusofon.ru .
Если адрес Вашего кабинета lk.plusofon.ru , то, пожалуйста, используйте документацию по актуальной версии FlashCall API.
- ⚠️ По техническим причинам возможны проблемы с прохождением FlashCall-вызовов на МТС.
Мы работаем над устранением этих проблем, но сроки решения пока не известны.
В данный момент мы рекомендуем обрабатывать верификацию пользователей оператора МТС другими способами. Специально для этого в актуальной версии FlashCall API Вы можете получать оператора номера при запросе FlashCall-вызова и настроить ограничение звонка на номера МТС или использовать для них CallToAuth.
¶ Введение
Услуга Flash Call предназначена для авторизации действий абонента по телефонному звонку, по аналогии с кодом подтверждения в SMS-сообщении.
Знаком 
отмечены обязательные параметры.
¶ Как это работает?
Абоненту поступает звонок на его номер телефона. В качестве кода подтверждения используются последние 4 цифры номера, которые нужно ввести для авторизации действия на сайте или в приложении.
¶ Как начать работу?
- Для использования услуги необходимо получить API-токен, который затем отправляется в заголовке
Authorization(типBearer). Токен можно получить одним из двух вариантов:
-
в личном кабинете Плюсофон, в разделе API
-
методом
login(описание на странице «Plusofon API»)
-
Создайте аккаунт для услуги с помощью метода flash-call/add-account
-
Получите список доступных пакетов с помощью метода flash-call/proposals. Также пакеты можно посмотреть на сайте Плюсофон.
-
Выберите нужный Вам пакет и подключите его с помощью flash-call/add-proposal
-
Используйте методы flash-call/send и flash-call/check для применения услуги в бизнес-логике
В дальнейшем планируется реализовать возможность выполнять пункты 2 — 4 из ЛК Плюсофон.
¶ 
Postman
Вы можете проверить работу методов на готовой коллекции Postman:
-
в приложении Postman откройте меню File → Import → Link
-
вставьте ссылку:
https://docs.plusofon.ru/api/plusofon_flash_call.postman_collection.json -
нажмите Continue → Import
Для аутентификации укажите Ваш API-токен в настройках коллекции на вкладке Auth в поле Token.
Скачать сам клиент Postman можно на официальном сайте.
¶ Управление аккаунтами
¶ Добавление аккаунта (включение услуги)
Метод позволяет добавить аккаунт для услуги Flash Call.
¶ Запрос
POST
flash-call/add-account
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
name |
string | произвольное имя |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer KCJ2F2jmO6d8yyhiu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/add-account",
"params": {
"name": "test_account_name"
},
"id": 1
}'
¶ Ответ
В случае успеха возвращается массив аккаунтов со следующими параметрами:
| Параметр | Описание |
|---|---|
id |
ИД аккаунта FlashCall |
access_token |
токен |
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": {
"id": 12345,
"access_token": "8J4ss7n2Lx_LVJbUiS5"
},
"error": null
}
¶ Получение списка аккаунтов
Метод позволяет получить весь список созданных аккаунтов Flash Call. Не требует дополнительных параметров.
¶ Запрос
POST
flash-call/get-accounts
https://new-api.plusofon.ru
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer KCJ2F2jmO6d8yyhiu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/get-accounts",
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается массив аккаунтов со следующими параметрами:
| Параметр | Описание |
|---|---|
id |
ИД аккаунта Flash Call |
access_token |
токен |
name |
имя аккаунта |
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": [
{
"id": 10020,
"access_token": "2ppheb_LVJbglA7Lx",
"name": "test_account_1"
},
{
"id": 10021,
"access_token": "3PK_WHL_JJl0B-WEL",
"name": "test_account_2"
}
],
"error": null
}
¶ Удаление аккаунта
Метод позволяет удалять аккаунты Flash Call.
¶ Запрос
POST
flash-call/delete-account
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
id |
integer | ИД аккаунта Flash Call |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer KCJ2F2jmO6d8yyhiu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/delete-account",
"params": {
"id": "12345"
},
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается true.
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": true,
"error": null
}
¶ Управление пакетами
¶ Получение списка доступных пакетов
Метод позволяет посмотреть все доступные пакеты для подключения Flash Call.
¶ Запрос
POST
flash-call/proposals
https://new-api.plusofon.ru
Не требует дополнительных параметров.
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer KCJ2F2jmO6d8yyhiu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/proposals",
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается массив данных:
| Параметр | Описание |
|---|---|
amount |
стоимость пакета (руб.) |
count_call |
количество звонков, включённых в пакет |
amount_in_packet |
стоимость вызова, включённого в пакет (руб.) |
amount_out_packet |
стоимость вызова сверх пакета (руб.) |
account_product_id |
внутренний ИД продукта |
name |
имя пакета |
id |
ИД пакета (нужен для подключения пакета) |
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": [
{
"amount": "1750.0000",
"count_call": "5000.0000",
"amount_in_packet": "0.3500",
"amount_out_packet": "0.3800",
"account_product_id": "743.0000",
"name": "пакет 5 000",
"id": "100b3613-653a-c128-75a6-62c295fb6ab8"
},
{
"amount": "3000.0000",
"count_call": "10000.0000",
"amount_in_packet": "0.3000",
"amount_out_packet": "0.3500",
"account_product_id": "744.0000",
"name": "пакет 10 000",
"id": "10821b3f-4d0a-1b73-92e8-62c29558c61b"
},
{
"amount": "0.0000",
"count_call": "100.0000",
"amount_in_packet": "0.0000",
"amount_out_packet": "0.4500",
"account_product_id": "741.0000",
"name": "Бесплатный",
"id": "23001dac-42b1-8978-2275-62c28f55bda1"
},
{
"amount": "19000.0000",
"count_call": "100000.0000",
"amount_in_packet": "0.1900",
"amount_out_packet": "0.2200",
"account_product_id": "746.0000",
"name": "пакет 100 000",
"id": "345d07cc-73f0-64b0-b398-62c296b22b6d"
},
{
"amount": "400.0000",
"count_call": "1000.0000",
"amount_in_packet": "0.4000",
"amount_out_packet": "0.4200",
"account_product_id": "742.0000",
"name": "пакет 1 000",
"id": "832d94d2-67a5-514e-f327-62c2947b8d7f"
},
],
"error": null
}
¶ Подключение пакета
Метод позволяет подключить пакет Flash Call.
¶ Запрос
POST
flash-call/add-proposal
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
account_id |
integer | ИД аккаунта Flash Call |
proposal_id |
string | ИД пакета Flash Call |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer KCJ2F2jmO6d8yyhiu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/add-proposal",
"params": {
"account_id": "12345",
"proposal_id": "100b3613-653a-c128-75a6-62c295fba6ab8"
},
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается true.
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": true,
"error": null
}
¶ Проверка пакета
Метод позволяет получить информацию о подключенных пакетах Flash Call.
¶ Запрос
POST
flash-call/account-proposals
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
account_id |
integer | ИД аккаунта Flash Call |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer N5iqM2CmAwoPBZWjEAe340wfWHWcCWWm' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/account-proposals",
"params": {
"account_id": "6"
},
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается массив данных:
| Параметр | Описание |
|---|---|
customer_id |
номер договора в Плюсофоне |
account_id |
ИД аккаунта Flash Call |
proposal_id |
ИД пакета Flash Call |
created_at |
дата создания |
calls_left |
остаток пакета |
end_packet_time |
дата завершения пакета |
time_left |
время до завершения пакета |
Пример:
{
"jsonrpc": "2.0",
"id": "1db511838f4a3062da60dfc6eeabfe50",
"result": [
{
"id": "6",
"customer_id": "100123",
"account_id": "12345",
"proposal_id": "832d94d2-67a5-514e-f327-62c2947b8d7f",
"created_at": "2022-08-23 17:13:34",
"calls_left": "1000",
"end_packet_time": "2022-08-31 23:59:59",
"time_left": "7 days, 15 hours, 56 minutes, 27 seconds"
}
],
"error": null
}
¶ Отключение пакета
Метод позволяет отключить пакет Flash Call.
¶ Запрос
POST
flash-call/remove-proposal
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
account_id |
integer | ИД аккаунта Flash Call |
proposal_id |
string | ИД пакета Flash Call |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer KCJ2F2jmO6d8yyhiu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/add-proposal",
"params": {
"account_id": "12345",
"proposal_id": "100b3613-653a-c128-75a6-62c295fba6ab8"
},
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается true.
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": true,
"error": null
}
¶ Запуск Flash Call
¶ Отправка вызова
Метод позволяет совершить звонок Flash Call.
¶ Запрос
POST
flash-call/send
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
phone |
integer | телефонный номер абонента |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer 15TuZnctDty8-QDjrTSu3FeFrHnL8gXu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/send",
"params": {
"phone": "79376198612"
},
"id": 1
}'
Токен необходимо подставлять из пакета по методу flash-call/get-accounts поле access_token
¶ Ответ
В случае успеха в поле result возвращается токен вызова.
Пример:
{
"jsonrpc": "2.0",
"id": 1,
"result": "gjyQvlg5nTAiSMlKKh61D9",
"error": null
}
¶ Проверка пин-кода
Метод позволяет проверить звонок Flash Call. Для проверки используется пин-код (последние 4 цифры звонившего номера) и токен вызова, полученный в ответе на запрос flash-call/send.
¶ Запрос
POST
flash-call/check
https://new-api.plusofon.ru
| Параметр | Тип | Описание |
|---|---|---|
pin |
integer | последние 4 цифры номера, с которого поступил звонок |
key |
string | токен вызова |
Пример:
curl --location --request POST 'https://new-api.plusofon.ru' \
--header 'Authorization: Bearer 15TuZnctDty8-QDjrTSu3FeFrHnL8gXu' \
--header 'Content-Type: application/json' \
--data-raw '{
"jsonrpc": "2.0",
"method": "flash-call/check",
"params": {
"pin": "1234",
"key": "gjyQvlg5nTAiSMlKKD9"
},
"id": 1
}'
¶ Ответ
В случае успеха в поле result возвращается true.
Пример:
{
"jsonrpc": "2.0",
"id": "1",
"result": true,
"error": null
}
¶ Недоступные направления
Вы можете отправить вызов на любой мобильный номер за исколючением нескольких направлений.
| Код направления | Страна |
|---|---|
52 |
Мексика |
676 |
Тонго |
678 |
Вануату |
685 |
Заподное Самоа |
675 |
Папуа Новая Гвинея |
674 |
Науру |
597 |
Суринам |
686 |
Кирибати |
509 |
Гаити |
683 |
Острава Ниуэ |
228 |
Того |
687 |
Новая Каледония |
682 |
Острова Кука |
690 |
Токелау |
220 |
Гамбия |