메인 콘텐츠로 건너뛰기

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를 사용하려면 먼저 휴대폰 번호 상태 조회 API 해당 페이지에서 서비스를 신청해야 합니다. 페이지에 들어가면 “Acquire” 버튼을 클릭합니다. 아래 그림과 같이: 로그인 또는 등록이 되어 있지 않으면 자동으로 로그인 페이지로 리디렉션되어 등록 및 로그인을 요청합니다. 로그인 및 등록 후에는 자동으로 현재 페이지로 돌아옵니다. 첫 신청 시 무료 사용량이 제공되어 해당 API를 무료로 사용할 수 있습니다.

​
기본 사용

먼저 기본 사용 방식을 이해해야 합니다. 즉, 휴대폰 번호를 입력하면 처리된 결과를 얻을 수 있습니다. 먼저 간단하게 mobile 필드를 전달해야 합니다. 이후 화면에 해당 내용을 입력할 수 있습니다. 아래 그림과 같이:

여기서 Request Headers를 설정한 것을 볼 수 있습니다. 포함된 내용은 다음과 같습니다:
  • accept: 어떤 형식의 응답 결과를 받고 싶은지, 여기서는 application/json으로 입력하여 JSON 형식으로 설정합니다.
  • authorization: API 호출을 위한 키로, 신청 후 드롭다운에서 선택할 수 있습니다.
또한 Request Body를 설정했습니다. 포함된 내용은 다음과 같습니다:
  • 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": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

​
결론

본 문서를 통해 휴대폰 번호 상태 조회 API를 사용하여 휴대폰 번호의 상태를 검증하는 방법을 이해하셨습니다. 휴대폰 번호를 입력하여 조회할 수 있습니다. 본 문서가 API를 더 잘 연동하고 사용하는 데 도움이 되기를 바랍니다. 질문이 있으시면 언제든지 기술 지원 팀에 문의해 주시기 바랍니다.