Получение списка доступных тарифов
Для получения списка доступных тарифов используется метод /api/v1/tariffs.
Метод позволяет:
- получать актуальные тарифы без перехода в личный кабинет edna Pulse;
- получать идентификаторы тарифов для использования в других методах API;
- определять тариф, установленный по умолчанию для конкретного типа канала.
- Список тарифов по всем типам каналов
- Список тарифов по конкретному типу канала
Если вы хотите получить список всех доступных тарифов — отправьте GET-запрос на URL-адрес https://app.edna.ru/api/v1/tariffs.
Если вы хотите получить список доступных тарифов по конкретному типу канала, отправьте GET-запрос на URL-адрес https://app.edna.ru/api/v1/tariffs?channelType={TYPE}, указав channelType (тип канала) в query-параметре.
Например —
https://app.edna.ru/api/v1/tariffs?channelType=WHATSAPP
Типы канала, по которым можно запросить тарифы, соответствуют значению параметра channelType в ответе.
Формат запроса
В теле запроса передается пустой JSON.
Формат ответа
[
{
"id": number,
"name": "string",
"channelType": "string",
"licencePrice": number,
"connectionFee": number,
"mau": number,
"amau": number,
"currency": "string",
"isDefault": boolean
}
]
Примеры ответов
Ответ при запросе без query-параметра
[
{
"id": 1,
"name": "WhatsApp 3 000 MAU",
"channelType": "WHATSAPP",
"licencePrice": 20000,
"connectionFee": 15000,
"mau": 3000,
"amau": 10,
"currency": "RUB",
"isDefault": false
},
{
"id": 2,
"name": "Viber",
"channelType": "VIBER",
"licencePrice": 1,
"currency": "RUB",
"isDefault": false
},
{
"id": 3,
"name": "MAX Bot",
"channelType": "MAX_BOT",
"licencePrice": 6000,
"currency": "RUB",
"isDefault": false
},
{
"id": 4,
"name": "SMS",
"channelType": "SMS",
"licencePrice": 1500,
"currency": "RUB",
"isDefault": false
},
{
"id": 5,
"name": "MAX",
"channelType": "MAX",
"licencePrice": 6000,
"currency": "RUB",
"isDefault": false
}
]
Ответ при запросе с query-параметром
[
{
"id": 1,
"name": "WhatsApp 3 000 MAU",
"channelType": "WHATSAPP",
"licencePrice": 20000,
"connectionFee": 15000,
"mau": 3000,
"amau": 10,
"currency": "RUB",
"isDefault": false
}
]
Параметры ответа
| Параметр | Тип данных | Характер | Описание |
|---|---|---|---|
id | number | Обязательный | Идентификатор тарифа. |
name | string | Обязательный | Название тарифа. |
channelType | string | Обязатель ный | Тип канала.
Возможные значения: - WHATSAPP;
- SMS;
- MAX_BOT;
- MAX;
- VIBER. |
licencePrice | number | Необязательный | Стоимость лицензии в валюте, указанной в currency. Возвращается, если предусмотрена тарифом. |
connectionFee | number | Необязательный | Стоимость подключения в валюте, указанной в currency. Возвращается, если предусмотрена тарифом. |
mau | number | Необязательный | Количество ежемесячных активных пользователей (MAU), включённых в тариф. Возвращается, если предусмотрено тарифом. |
amau | number | Необязательный | Стоимость дополнительного ежемесячного активного пользователя (AMAU) сверх включённого количества MAU в валюте, указанной в currency. Возвращается, если предусмотрена тарифом. |
currency | string | Обязательный | Код валюты тарифа.
Возможное значение — российские рубли. |
isDefault | boolean | Обязательный | Признак показывает выбирается ли этот тариф по умолчанию для указанного типа канала.
Возможные значения: - true — тариф у становлен по умолчанию;
- false — тариф не установлен по умолчанию.
к сведению Для типа канала, у которого установлен тариф по умолчанию, тариф возвращается с isDefault = true, остальные - с isDefault = false. Если тариф по умолчанию не установлен, то у всех тарифов данного типа канала возвращается isDefault = false. |
* Деятельность компании Meta запрещена на территории Российской Федерации.