Version 1 Актуализирано 2026-03-17

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

Нашето API е бързо и лесно за интеграция — можете да започнете за по-малко от 15 минути. Освен това получавате 50 безплатни заявки всеки ден, за да започнете.

Основи

Всички API заявки трябва да се изпращат чрез метода POST. Базовият endpoint за всички заявки е:

https://numvalid.com/api/v1/[api_key]

Заменете [api_key] с вашия личен API ключ. Всички параметри на заявките трябва да се изпращат в body на заявката като JSON. Можете да получите вашия API ключ от вашия dashboard след регистрация.

Тест

Метод: test

Този метод се използва за тестване на връзката с API. Той проверява дали вашият API ключ е валиден и дали услугата е достъпна. Ако всичко е конфигурирано правилно, API ще върне успешен отговор.

Пример за заявка

{
    "method": "test"
}

Успешен отговор

{
  "error": 0,
  "message": "Yippee-ki-yay"
}

Полета в отговора
error — код на грешка (0 означава успешна заявка)
message — съобщение от API

Информация

Метод: info

Методът info връща информация за вашия акаунт и текущия абонамент, включително броя използвани API заявки.

Пример за заявка

{
    "method": "info"
}

Успешен отговор

{
    "error": 0,
    "name": "John",
    "surname": "Smith",
    "email": "[email protected]",
    "subscription": "Growth",
    "count_request": 2349
}

Полета в отговора
error — код на грешка (0 означава успешна заявка)
name — първо име на собственика на акаунта
surname — фамилия на собственика на акаунта
email — имейл адрес на акаунта
subscription — текущ план на абонамента
count_request — брой използвани API заявки в текущия абонаментен период

Проверка

Метод: verify

Методът verify проверява телефонен номер и връща подробна информация за валидиране.

Телефонните номера могат да бъдат подадени във всякакъв формат. API автоматично обработва символи като (, ), -, + и интервали.

Пример за заявка

{
  "phone": "491609502065",
  "method": "verify"
}

Успешен отговор

{
  "error": 0,
  "request_phone": "491609502065",
  "valid_phone": true,
  "type": "mobile",
  "format": {
    "local": "01609502065",
    "international": "+491609502065"
  },
  "country": {
    "code": "DE",
    "name": "Germany (Federal Republic of)",
    "prefix": "+49"
  },
  "requests": {
    "subscription": "Growth",
    "count": 2,
    "start": "2026-04-06 10:29:40",
    "finish": "2026-10-06 10:29:40",
    "limit": 9000
  }
}

Полета в отговора
error — код на грешка (0 означава успешна заявка)
request_phone — телефонен номер, изпратен в заявката
valid_phone — резултат от валидацията (true ако номерът е валиден)
type — тип телефонен номер (напр. мобилен, стационарен и др.)

Обект Format
local — телефонен номер в локален формат
international — телефонен номер в международен формат

Обект Country
code — ISO код на държавата
name — име на държавата
prefix — международен телефонен код

Обект Requests
Информация за текущото използване на абонамента ви.
subscription — активен абонаментен план
count — брой вече използвани заявки
start — начална дата на абонаментния период
finish — крайна дата на абонаментния период
limit — максимален брой заявки, позволени в абонаментния период

Въпроси относно документацията?

Имате въпроси относно нашата API документация? Свържете се с нас: