Документация API

https://api.nomiq.ru

Авторизация

Ключ из кабинета передаётся в заголовке каждого запроса.

Заголовок

X-API-Key: sk_live_…
GET/v1/lookup

Один номер

Текущий оператор и перенос

Authorization: Bearer или X-API-Key

ПараметрГде
phoneобяз.

Номер

query
field

Одно поле text/plain: operator, code, num, full_num, old_operator

query

Запрос

curl -X GET "https://api.nomiq.ru/v1/lookup?phone=89042823000" \
  -H "Authorization: Bearer $NOMIQ_KEY"

Ответ

{
  "code": "904",
  "num": "2823000",
  "full_num": "9042823000",
  "operator": "МТС",
  "old_operator": "Теле2"
}
  • Без переноса поле old_operator отсутствует
  • −1 из пакета номеров
GET/get/

Совместимость

То же, что /v1/lookup, параметр num

Authorization: Bearer или X-API-Key

ПараметрГде
numобяз.

Номер

query
field

Одно поле text/plain

query

Запрос

curl -X GET "https://api.nomiq.ru/get/?num=89042823000&field=operator" \
  -H "Authorization: Bearer $NOMIQ_KEY"

Ответ

МТС
POST/v1/lookup/batch

Список номеров

До 1 000 номеров. Каждый считается отдельно

Authorization: Bearer или X-API-Key

Тело

{ "phones": ["89042823000", "89001234567"] }

Запрос

curl -X POST "https://api.nomiq.ru/v1/lookup/batch" \
  -H "Authorization: Bearer $NOMIQ_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phones":["89042823000","89001234567"]}'

Ответ

{
  "total": 2,
  "success": 2,
  "failed": 0,
  "items": [
    {
      "phone": "89042823000",
      "ok": true,
      "result": {
        "code": "904",
        "num": "2823000",
        "full_num": "9042823000",
        "operator": "МТС",
        "old_operator": "Теле2"
      }
    }
  ]
}
  • На тесте — до 50 номеров за запрос
GET/v1/y-spam-check

Репутация

Жалобы или полезный звонок. Отдельный пакет

Authorization: Bearer или X-API-Key

ПараметрГде
phoneобяз.

Номер

query

Запрос

curl -X GET "https://api.nomiq.ru/v1/y-spam-check?phone=89042823000" \
  -H "Authorization: Bearer $NOMIQ_KEY"

Ответ

{
  "phone": "79042823000",
  "status": "Нежелательный звонок",
  "full_status": "Нежелательный звонок. Есть жалобы.",
  "polarity": "negative",
  "verdict": "polarity.negative",
  "verdict_in_offline_db": "Yes",
  "descriptions_match": "Yes",
  "reqid": "…"
}
  • polarity: negative — жалобы, positive — полезный звонок
  • −1 из пакета репутации
POST/v1/demo/lookup

Демо

Без ключа, с лимитом частоты

Без ключа

Тело

{ "phone": "+7 904 282-30-00" }

Запрос

curl -X POST "https://api.nomiq.ru/v1/demo/lookup" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+7 904 282-30-00"}'

Ответ

{
  "code": "904",
  "num": "2823000",
  "full_num": "9042823000",
  "operator": "МТС",
  "old_operator": "Теле2"
}

На главную · OpenAPI