Справочник API для разработчиков

Программная генерация тестовых номеров через простые HTTP GET-запросы.

Эндпоинт

Отправляйте HTTP GET-запросы на следующий URL:

GEThttps://phone-number.loveyouall.qzz.io/api/generate

Онлайн-тест (Try It)

Заполните параметры ниже и вызовите реальный API, чтобы увидеть JSON-ответ.

Параметры запроса

ПараметрТипОбязательныйОписание
countrystringНетКод страны. Поддерживаются "US", "CN", "CA", "GB", "AU", "DE", "FR", "JP", "KR", "IN", "SG", "ES", "IT", "BR", "MX", "RU", "NL". По умолчанию "US".
regionstringНетНазвание региона/штата/оператора (например, "California", "Ontario", "China Mobile"). Регистр не важен.
citystringНетНазвание города или конкретный префикс/код (например, "Los Angeles", "138"). Регистр не важен. Требуется указание region.
quantityintegerНетКоличество генерируемых номеров. Диапазон: 1–1000 (значения выше 1000 усекаются). По умолчанию: 10.
customPrefixstringНетПользовательские цифры префикса (только цифры, 0-9). Опционально.
safetyModestringНетРежим безопасности. Поддерживаются "realistic" (реальные правила) и "safe" (официальные фиктивные тестовые номера, например 555-XXXX). По умолчанию "realistic".
uniqueOnlybooleanНетГенерировать только уникальные номера. Поддерживаются "true" или "false". По умолчанию "true".

Примеры интеграции

Выберите предпочитаемый язык или инструмент для интеграции API:

curl -X GET "https://phone-number.loveyouall.qzz.io/api/generate?country=US&quantity=5&safetyMode=safe&uniqueOnly=true"

Формат ответа

Возвращает массив JSON с записями номеров. Каждая запись содержит локализованные поля, отображаемый формат и стандартную строку E.164.

[
  {
    "id": "c852d129-4112-4981-8ddb",
    "country": "US",
    "region": "California",
    "regionCode": "CA",
    "city": "Los Angeles",
    "areaCode": "213",
    "display": "+1 (213) 932-8419",
    "e164": "+12139328419"
  }
]

Поля ответа

ПолеТипОписание
idstringУникальный UUID v4 записи.
countrystringДвухбуквенный код страны (например, US, CN).
regionstringНазвание штата/провинции/оператора, например California или China Mobile.
regionCodestringКороткий код региона, например CA для Калифорнии.
areaCodestringКод города или префикс номера, например 213 или 138.
citystringНазвание города или сегмент префикса, например Los Angeles или 138.
displaystringЧитаемый формат номера, например +1 (213) 555-1234.
e164stringСтандартный формат E.164, например +12135551234.

Коды ошибок

API использует стандартные HTTP-коды состояния и всегда возвращает JSON с полем "error" при сбое.

Код состоянияКогда происходитТело ответа
400Неподдерживаемый код страны{"error":"Unsupported country code: XX"}
400Неизвестный регион или город для выбранной страны{"error":"Unknown region ... for country US"}
400customPrefix содержит нецифровые символы{"error":"customPrefix must contain digits only"}
400city указан без region{"error":"city requires region"}
500Внутренняя ошибка во время генерации{"error":"Internal Server Error"}

Ограничения использования

  • Бесплатно и без аутентификации, API-ключ не требуется
  • Максимум 1 000 номеров за запрос (более высокие значения усекаются)
  • По умолчанию: country=US, quantity=10, safetyMode=realistic, uniqueOnly=true
  • safetyMode=safe использует официальные фиктивные тестовые номера (например, 555-XXXX), которые никогда не принадлежат реальным абонентам