Skip to main content

Список сим-карт

Для получения списка сим-карт используется метод sim/list:list:

POST https://api.novaconnect.kz/api/sim/list

{
{
  "page": <int>,
  "size": <int>,
  "filter": {
    "profile": <string>,
    "msu_block": <bool>,
    "blocked": <bool>,
    "company"query": <array of string>
  },
  "sort": <object>
}
Параметры
Параметр
Тип
Описание
Обязательность
page
int
Номер сСтраницыаумерачалоция с 0)
Нет
size
int
Размер страницы (по-умолчанию 25)
Нет
filter
object
Объект для фильтра (см. ниже)
Нет
sort
object
Объект для сортировки (см. ниже)
Нет

Фильтр
"filter"

Задает фильтрацию списка сим. Объект имеет следующие значения:

Параметр
я
Параметр
Тип Описание
Допустимые значения
Обязательность
profile
string
ФильтрКод по столбцу "Профиль"
"tc", "td"
сим-карты
Нет
msu_block
boolБлокировка по MSUНет
bool
blocked
ОboolБлокировкаНет
querystringПоисковый запросНет
  • Фильтр profile принимает на вход код профиля: TD для сим профиля TD, TC для сим профиля TC;
  • Фильтр blocked работает по следующей логике: -- при передаче значения false будут получены все записи, у котобрых значение block = n, то есть разблокированные; -- при передаче значения true будуть получены все записи, у которых значение block = u, p, m, g, f, тол естько заблокированные по MSU

    Нет
    blocked
    bool
    Фильтрюбой причине;
Со блокртировке

true - отобразить только заблокированные

false - отобразить только разблокированные

Нет
company
array
Массив компаний
"my", "all", идентификаторы компаний
Нет

Параметр "sort"

В объект сортировки передается ключод стполбцая, по которому нужно провестидет сортировкау, в качестве ключа. В качестве значение - направление:

  • (ASC - по возрастанию
  • ,
  • DESC - по убыванию
  • ).

{
    
Р"id": "DESC" //Сортировка по убыванию идезнтификаторов сим }

Ограничения и доступы

Метод доступен польтзоват

Положителю с любой ролью

Успешный ответ

{
  "code": 200,
  "message": <string>,
  "count": <int>,
  "all_count": <int>,
  "items": [
        //Объекты типа Сим-карезультат
  выглядит]
следующим}
об
{
"code":200, //
"count":<//
"items":[
Паразом:

етр
Тип Описание
code int Код ответа, для успешха - 200
messagestringСообщенойие оптвертации
count int>, Количество элементов в результмате
  "all_count": <int>, //Общессиве кitems
all_countintКоличество элементов в БД
items array Массив
 //элементыов типа сСим-карта
],
  "allow_operations": { //Доступные операции
    "block": <bool>, //Блокировка
    "unblock": <bool>, //Разблокировка
    "disconnect": <bool>, //Сброс регистрации в сети (Cancel Location)
    "reconnect": <bool>, //Мягкая перезагрузка (POD)
    "ping": <bool>, //Пинг через СМС
    "sms": <bool>, //Отправка СМС
    "balance": <bool>, //Изменение баланса
    "edit": <bool>, //Редактирование название
    "limit": <bool>, //Установка лимита
    "tariff": <bool>, //Изменение тарифного плана
    "repackage": <bool>, //Переподключение пакета
 "dealer": <bool>, //Возможность передачи сим другой компании
    "group": <bool> //Изменение групп
  },
  "message": <string> //Сообщение о результате
}
Дополнительная информация
  • "Мягкая" перезагрузка на данный момент отключена, поэтому в параметре reconnect будет всегда значение false