Flash Calls - аторизация звонком

Авторизация входящим звонком. Кодом подтверждения являются последние 4 цифры номера с которого происходит звонок.

Запросы выполняются методом POST или GET на URL:

https://api.telefon-ip.ru/api/v1/authcalls/{token}/{action}/{params} где:

token - ключ доступа к API, который можете получить в личном кабинете или по запросу на [e-mail]. Первые 50 запросов для тестирования бесплатно.

action - вызываемые функции API описанные ниже в документации

params - передаваемые параметры в зависимости от метода вызова, обычно для GET запроса

get_code - получение кода авторизации

GET https://api.telefon-ip.ru/api/v1/authcalls/<token>/get_code/<phone>/

Example

https://api.telefon-ip.ru/api/v1/authcalls/4ea13fbf-f5a3-4084-8b01-9733cd6fd0b1/get_code/89243555100

Запрос с отправкой SMS в случае если звонок не был доставлен

https://api.telefon-ip.ru/api/v1/authcalls/4ea13fbf-f5a3-4084-8b01-9733cd6fd0b1/get_code/89243555100?sms=true

Path Parameters

Name	Type	Description
token*	String	Ключ доступа
phone*	Integer	Номер телефона вызываемого абонента. Ограничение на 5 отправок в сутки.

Query Parameters

Name	Type	Description
sms	Boolean	Если установлен в true - отправляется смс на оператора МТС в случае если не прошел звонок. По умолчанию false

200 Код авторизации

{
    "success": true,
    "error": "",
    "data": {
        "phone": "79244501003",
        "code": "1003",
        "id": 168
    }
}

400: Bad Request Ошибка в запросе

{
    "success": false,
    "error": "does not match the format 89XXXXXXXXX or phone field is missing",
    "data": {}
}

401: Unauthorized Ошибка авторизации

{
    "success": false,
    "error": "Unauthorized token",
    "data": {}
}

get_status - получение информации об авторизации

GET https://api.telefon-ip.ru/api/v1/authcalls/<token>/get_status/<id>/

Path Parameters

Name	Type	Description
token*	String	Ключ доступа
id*	Integer	Индификатор запроса (берется из get_code)

200: OK Информация об авторизации

{
    "success": true,
    "error": "",
    "data": {
        "id": 454733,
        "created_at": "2023-04-02T12:54:31",
        "phone": "89243555100",
        "status": 1,
        "status_info": "Ok: SIP 200 OK",
        "price": 0.2
    }
}

400: Bad Request Ошибка в запросе

{
    "success": false,
    "error": "id record not found",
    "data": {}
}

401: Unauthorized Ошибка авторизации

{
    "success": false,
    "error": "Unauthorized token",
    "data": {}
}

get_balance - получение остатка средств на счете

GET https://api.telefon-ip.ru/api/v1/authcalls/<token>/get_balance/

Example

https://api.telefon-ip.ru/api/v1/authcalls/4ea13fbf-f5a3-4084-8b01-9733cd6fd0b1/get_balance/

Path Parameters

Name	Type	Description
token	String	Ключ доступа

200: OK Текущий баланс

{
    "success": true,
    "error": "",
    "data": {
        "balance": 5.0,
        "price": 0.2,
        "balance_limit": 0.0
    }
}

401: Unauthorized Ошибка авторизации

{
    "success": false,
    "error": "Unauthorized token",
    "data": {}
}

get_billing_record - получение N последних записей транзакций

GET https://api.telefon-ip.ru/api/v1/authcalls/<token>/get_billing_record/<coun-record>/

Example

https://api.telefon-ip.ru/api/v1/authcalls/4ea13fbf-f5a3-4084-8b01-9733cd6fd0b1/get_billing_record/50/

Path Parameters

Name	Type	Description
token*	String	Ключ авторизации
count-record	Integr	Количество последних записей (не больше 100)

200: OK Список записей

{
    "success": true,
    "error": "",
    "data": [
        {
            "created_at": "2021-12-29T14:06:51",
            "code_auth": "2371",
            "status": 1,
            "status_info": "ok",
            "phone": "89243555100",
            "price": 0.2
        }
}

400: Bad Request Ошибка в запросе

{
    "success": false,
    "error": "count_record field greater than 100",
    "data": {}
}

401: Unauthorized Ошибка авторизации

{
    "success": false,
    "error": "Unauthorized token",
    "data": {}
}

get_billing_csv - получение экспорта данных записей транзакций в csv формате

GET https://api.telefon-ip.ru/api/v1/authcalls/<token>/get_billing_csv/<start_date>/

Example

https://api.telefon-ip.ru/api/v1/authcalls/4ea13fbf-f5a3-4084-8b01-9733cd6fd0b1/get_billing_csv/2021-12-31/

Path Parameters

Name	Type	Description
token	String	Ключ авторизации
start_date	String	Дата начала выгрузки формата YYYY-MM-DD

200: OK csv файл

400: Bad Request Ошибка в запросе

{
    "success": false,
    "error": "Incorrect data format field date_start, should be YYYY-MM-DD",
    "data": {}
}

401: Unauthorized Ошибка авторизации

{
    "success": false,
    "error": "Unauthorized token",
    "data": {}
}

post_billing_data - получение записей транзакций

POST https://api.telefon-ip.ru/api/v1/authcalls/<token>/post_billing_data/

Path Parameters

Name	Type	Description
token	String	Ключ авторизации

Request Body

Name	Type	Description
start_date	String	Дата начала получения данных формата YYYY-MM-DD
end_date	String	Дата конца получения данных формата YYYY-MM-DD

200: OK

{
    "success": true,
    "error": "",
    "data": [
        {
            "created_at": "2021-12-29T14:06:51",
            "code_auth": "2371",
            "status": 1,
            "status_info": "ok",
            "phone": "89243555100",
            "price": 0.2
        }
}

400: Bad Request

{
    "success": false,
    "error": "Incorrect data format field date_start, should be YYYY-MM-DD",
    "data": {}
}

401: Unauthorized

    "success": false,
    "error": "Unauthorized token",
    "data": {}
}

Партнерский API

Внимание: Для работы с партнерским API необходимо получить статус партнера для ключа авторизации. Запросить token можно по электронной почте

[e-mail]

post_user_create - создание пользователя

POST https://api.telefon-ip.ru/api/v1/authcalls/<token>/post_user_create/

Path Parameters

Name	Type	Description
token*	String	Ключ партнера

Request Body

Name	Type	Description
user_name*	String	Имя пользователя
user_phone*	String	Номер телефона пользователя
user_token	String	Создание пользователя под токеном партнера (опционально - то есть партнер сам передает токен под которым будет работать клиент, если не указан токен генерируется)

200: OK

{
    // Response
}

400: Bad Request

{
    // Response
}

401: Unauthorized

{
    // Response
}

post_user_blocking - блокировка пользователя

POST https://api.telefon-ip.ru/api/v1/authcalls/<token>/post_user_blocking

Path Parameters

Name	Type	Description
token*	String	Ключ партнера

Request Body

Name	Type	Description
user_token*	String	Ключ клиента
user_status*	Boolean	Активен или не активен клиент

200: OK

{
    // Response
}

400: Bad Request

{
    // Response
}

401: Unauthorized

{
    // Response
}

post_billing_payment - пополнение баланса пользователя

POST https://api.telefon-ip.ru/api/v1/authcalls/<token>/post_billing_payment

Path Parameters

Name	Type	Description
token*	String	Ключ партнера

Request Body

Name	Type	Description
user_token*	String	Ключ клиента
user_payment*	String	Сумма платежа

200: OK

{
    // Response
}

400: Bad Request

{
    // Response
}

401: Unauthorized

{
    // Response
}

get_users - получение списка партнерских пользователей

GET https://api.telefon-ip.ru/api/v1/authcalls/<token>/get_users