Перейти к основному содержанию

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

В этой статье будет представлена инструкция по интеграции API проверки статуса номера телефона, который можно использовать для проверки статуса номера телефона, вы можете ввести номер телефона для запроса.

​
Процесс подачи заявки

Чтобы использовать API, сначала необходимо перейти на соответствующую страницу API проверки статуса номера телефона и подать заявку на соответствующую услугу, после перехода на страницу нажмите кнопку «Acquire», как показано на изображении: Если вы еще не вошли в систему или не зарегистрированы, вас автоматически перенаправит на страницу входа, пригласив зарегистрироваться и войти в систему, после входа и регистрации вы автоматически вернетесь на текущую страницу. При первой подаче заявки будет предоставлен бесплатный лимит, который можно использовать для бесплатного использования этого API.

​
Основное использование

Сначала ознакомьтесь с основным способом использования, то есть введите номер телефона, чтобы получить обработанный результат, сначала необходимо просто передать поле mobile. Далее мы можем заполнить соответствующее содержимое на интерфейсе, как показано на изображении:

Как видно, мы настроили заголовки запроса, включая:
  • accept: в каком формате вы хотите получить ответ, здесь указано application/json, то есть в формате JSON.
  • authorization: ключ для вызова API, после подачи заявки его можно выбрать из выпадающего списка.
Также настроено тело запроса, включая:
  • mobile: номер телефона, который необходимо обработать, является обязательным параметром.
  • encryption: необязательный параметр для шифрования чувствительных данных (если необходимо отправить зашифрованные данные).
После выбора можно заметить, что справа также сгенерирован соответствующий код, как показано на изображении:

Нажмите кнопку «Try», чтобы провести тестирование, как показано на изображении, здесь мы получили следующий результат: 
{
  "result": "0",
  "description": "Успешно",
  "status_code": 0
}
Возвращаемый результат содержит несколько полей, описание которых приведено ниже:
  • result, код результата проверки, условия оплаты следующие.
    • Код результата с оплатой:
      • 0: Успешно
    • Код результата без оплаты:
      • -1: Результат не найден
      • -2: Неправильный формат номера телефона
      • -3: Служба проверки занята
  • description, описание результата бизнеса.
  • status_code, код состояния:
    • 0: Нормально
    • 1: Отключен
    • 2: Номер аннулирован
    • 3: Пустой номер
    • 4: Не в сети
    • 99: Неизвестный статус
Можно увидеть, что статус этого номера телефона уже был проверен. Кроме того, если вы хотите сгенерировать соответствующий код интеграции, вы можете просто скопировать его, например, код CURL выглядит следующим образом: 
curl -X POST 'https://api.xhuoapi.ai/v1/identity/phone/check-1e' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "mobile": "***"
}'
Код интеграции на Python выглядит следующим образом: 
import requests

url = "https://api.xhuoapi.ai/v1/identity/phone/check-1e"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "mobile": "***"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

​
Обработка ошибок

При вызове API, если возникнет ошибка, API вернет соответствующий код ошибки и информацию. Например:
  • 400 token_mismatched: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
  • 400 api_not_implemented: Неверный запрос, возможно, из-за отсутствующих или недействительных параметров.
  • 401 invalid_token: Неавторизовано, недействительный или отсутствующий токен авторизации.
  • 429 too_many_requests: Слишком много запросов, вы превысили лимит частоты.
  • 500 api_error: Внутренняя ошибка сервера, что-то пошло не так на сервере.

​
Пример ответа об ошибке

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не удалось получить данные"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
Заключение

С помощью этого документа вы узнали, как использовать API проверки статуса номера телефона для проверки статуса номера телефона, вы можете ввести номер телефона для запроса. Надеемся, что этот документ поможет вам лучше интегрировать и использовать этот API. Если у вас есть какие-либо вопросы, пожалуйста, не стесняйтесь обращаться в нашу техническую поддержку.