# 전화번호 유효성 검사 전화번호의 형식 유효성을 검사하고, 통신사·회선유형까지 함께 조회합니다. 인증: Authorization: Bearer $APICK_API_KEY 본문 있는 REST 요청: multipart/form-data. GET 본문 및 MCP JSON-RPC 규격은 해당 명세를 따릅니다. 인증키는 서버에 보관하세요. 모든 예제는 정적 자료입니다. ## POST /rest/check_phone_valid 응답 필드 - `data` (object): 요청 처리 결과 묶음입니다. 조회한 값·작업 상태·오류 설명이 이 안에 들어 있으며, 실제 하위 필드 구성은 서비스마다 다릅니다. 값이 없으면 null·빈 배열·필드 생략 중 해당 서비스의 규칙을 따릅니다. - `data.국제번호` (string): 국가 코드를 포함한 국제 표기 전화번호입니다. 예: +82 10-1234-5678. 통신망 조회·발신에 사용할 수 있습니다. null 허용. - `data.지역번호` (string): 번호가 속한 지역의 지역번호입니다. 예: 02(서울), 031(경기). 휴대전화는 지역번호 대신 식별 번호가 올 수 있습니다. null 허용. - `data.유효성` (boolean): 국가별 번호 체계상 형식이 유효한지 여부입니다. true여도 실제 개통·사용 중인지는 회선 상태(data.hlr)로 확인해야 합니다. true = 국가별 번호·주소 형식 검사를 통과한 경우, false = 형식이 맞지 않아 실제 존재 여부를 확인할 수 없는 경우입니다. 형식이 유효해도 실제 사용 중인지는 별도 조회가 필요합니다. - `data.국가` (string): 번호가 등록된 국가의 이름입니다. 예: 대한민국. 국가코드와 함께 표시하면 지역을 정확히 알 수 있습니다. - `data.지역` (string): 번호가 등록된 지역 이름입니다. 예: 서울, 경기. 휴대전화는 번호 이동으로 실제 사용 지역과 다를 수 있습니다. - `data.국가코드` (string): 국가를 구분하는 두 자리 ISO 코드입니다. 예: KR, US. 국제번호·회선 상태 결과와 함께 사용하세요. - `data.모바일여부` (boolean): 해당 번호가 휴대전화(모바일) 번호인지 여부입니다. false면 유선·인터넷 전화일 수 있습니다. true = 휴대전화 번호인 경우, false = 유선·인터넷 전화 등 휴대전화가 아닌 경우입니다. - `data.회선유형` (string): 번호의 회선 종류입니다. 010으로 시작하면 mobile(휴대전화), 그 외는 fixed-line(유선)으로 구분합니다. - `data.hlr` (object): 번호 상태 조회 결과 묶음입니다. 휴대전화 여부·통신사·국가·지역 정보가 들어 있습니다. - `data.hlr.활성회선여부` (boolean): 현재 개통되어 통화·SMS 전달이 가능한 회선인지 여부입니다. 회선 상태를 제공하지 않는 국가는 null이며, 0과 구분해 표시하세요. true = 지금 개통되어 통화·SMS를 받을 수 있는 회선인 경우, false = 해지·정지 상태이거나 확인할 수 없는 경우입니다. null이면 해당 국가가 회선 상태를 제공하지 않는 것입니다. null 허용. - `data.hlr.개통상태` (string): 상태코드의 한글 이름입니다. 개통 / 부재 / 결번/미개통 / 유효하지 않은 번호 / 유선 / VOIP / 제공되지 않음 / 조회실패 중 하나입니다. - `data.hlr.상태코드` (string): 회선 상태 코드입니다.ok: 개통(사용 중)absent: 부재(개통됐지만 지금 연결되지 않음)unknown: 결번 또는 미개통invalid: 유효하지 않은 번호fixed-line: 유선 번호voip: 인터넷 전화 번호unavailable: 이 번호는 회선 상태를 제공하지 않음failed: 회선 상태를 받지 못함 - `data.hlr.HLR유효` (boolean): 회선 상태 확인이 성공했는지 여부입니다. false면 번호가 없거나 통신망이 응답하지 않은 상태입니다. true = 회선 상태를 확인한 경우, false = 번호가 없거나 통신망이 응답하지 않아 확인하지 못한 경우입니다. - `data.hlr.번호유효` (boolean): 통신망 기준으로 현재 사용 가능한 번호인지 여부입니다. 형식 유효성과 다르며, 해지·정지 번호는 false일 수 있습니다. true = 통신망 기준으로 현재 사용 가능한 번호인 경우, false = 해지·정지·미개통 번호인 경우입니다. 형식 유효성과 다르므로 두 값을 함께 보세요. - `data.hlr.모바일여부` (boolean): 입력한 번호가 휴대전화 번호인지 여부입니다. true/false로 옵니다. true = 휴대전화 번호인 경우, false = 유선·인터넷 전화 등 휴대전화가 아닌 경우입니다. null 허용. - `data.hlr.번호이동여부` (boolean): 번호이동 여부입니다. 제공되지 않으면 null입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 다른 통신사에서 번호이동한 회선인 경우, false = 이동 이력이 없거나 확인되지 않은 경우입니다. 상태를 제공하지 않는 국가는 null입니다. null 허용. - `data.hlr.로밍여부` (boolean): 현재 로밍 중인 회선인지 여부입니다. 확인할 수 없으면 null입니다. true/false로 오며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. true = 이 필드가 나타내는 조건이 성립한 경우, false = 성립하지 않은 경우입니다. 두 값 모두 정상 응답에 올 수 있으며, 값이 없으면 필드가 생략되거나 null일 수 있습니다. null 허용. - `data.hlr.현재통신사` (string): 번호를 현재 관리하는 통신사 이름입니다. 번호 이동을 했다면 원래 통신사와 다를 수 있습니다. null 허용. - `data.hlr.원통신사` (string): 번호를 처음 개통한 통신사입니다. 제공되지 않으면 null입니다. 문자열로 오며, 값이 없으면 빈 문자열이거나 필드가 생략됩니다. 같은 응답의 다른 필드와 함께 해석하세요. null 허용. - `data.hlr.이동통신사` (string): 현재 가입한 이동통신사 이름입니다. 번호이동 이력이 있으면 현재 통신사 기준입니다. 확인할 수 없으면 null입니다. null 허용. - `data.hlr.회선유형` (string): 회선 조회 기준 유형입니다. mobile / fixed-line / voip / null null 허용. - `data.hlr.위치` (string): 회선이 등록된 위치·지역 정보입니다. 통신사가 제공하지 않으면 빈 문자열이거나 생략됩니다. null 허용. - `data.hlr.국가` (string): 회선이 등록된 국가의 이름입니다. 국제번호의 국가 코드와 함께 확인하세요. null 허용. - `data.hlr.국가코드` (string): 회선이 등록된 국가의 두 자리 ISO 코드입니다. 예: KR. 국제번호의 국가 코드와 대조할 수 있습니다. null 허용. - `data.hlr.국제번호` (string): 국가 코드를 포함한 국제 표기 번호입니다. E.164 형식이며, 국가별 번호 체계에 맞춰 정규화되어 있습니다. null 허용. - `data.hlr.지역번호` (string): 유선 번호의 지역번호입니다. 휴대전화 번호에서는 비어 있을 수 있습니다. null 허용. - `data.hlr.도달가능성` (string): 회선 도달 상태 원값입니다. active / reachable / unreachable / inactive / null. 판단은 상태코드로 하는 것이 간단합니다. null 허용. - `data.hlr.MCC` (string): 이동통신 국가코드(MCC)입니다. 모바일 번호에만 제공되며, 국가·통신망을 식별하는 3자리 코드입니다. null 허용. - `data.hlr.MNC` (string): 이동통신 네트워크코드(MNC)입니다. 모바일 번호에만 제공되며, 같은 국가 안에서 통신사를 구분하는 코드입니다. null 허용. - `data.success` (integer): 업무 처리 결과 코드입니다. 1은 정상 결과, 0은 실패 또는 무료 응답입니다. 서비스에 따라 2·3처럼 추가 코드를 쓰므로 같은 응답의 status·msg·error 필드도 함께 확인하세요. - `data.error` (string): 오류 원인을 설명하는 문구입니다. 성공 응답에는 없거나 빈 문자열입니다. - `api` (object): API 호출 메타데이터입니다. 이번 요청의 서버 처리 성공 여부(api.success), 실제 차감 포인트(api.cost), 결제 기록 ID(api.pl_id)를 담습니다. 처리 시간(api.ms)은 응답에 포함된 경우에만 제공됩니다. 업무 결과는 data에서 확인합니다. - `api.success` (boolean): API 서버가 이번 요청을 정상 처리했는지 여부입니다. true여도 업무 결과가 실패일 수 있으므로 data.success·data.status와 함께 판단합니다. 인증 실패·잘못된 입력·서버 오류 응답에서는 false입니다. - `api.cost` (integer): 이번 호출에서 실제로 차감된 포인트입니다. 유료 성공 응답에서만 단가만큼 차감되며, 실패·무료 조회·같은 요청의 멱등 재전송은 0입니다. 화면의 표시 단가와 실제 차감액이 다를 수 있으므로 정산은 이 값을 기준으로 합니다. - `api.ms` (integer): 서버가 요청을 받아 응답 본문을 만들기까지 걸린 처리 시간(밀리초)입니다. 네트워크 왕복 시간과 클라이언트 대기 시간은 포함되지 않습니다. - `api.pl_id` (integer): 포인트 차감 기록 ID입니다. 차감이 발생한 호출에만 값이 있으며, 과금 내역을 문의할 때 이 번호를 사용합니다. 무과금 응답은 -1·null이거나 필드가 생략됩니다. ## API 요청: POST /rest/check_phone_valid ### 입력 - `number` (string, 필수): 검증할 전화번호입니다. 국내는 하이픈 없이 숫자만(예: 01012341234), 해외는 +국가코드로 시작하는 형식을 사용합니다. ### 응답 명세 ```json { "type": "object", "properties": { "data": { "type": "object", "properties": { "국제번호": { "type": "string", "description": "국제 표기 번호입니다. 예: +821012345678. 번호로 인식하지 못하면 null입니다.", "nullable": true }, "지역번호": { "type": "string", "description": "그 나라의 국내 표기 번호입니다. 예: 010-1234-5678. 화면 표시용으로 쓰기 좋습니다.", "nullable": true }, "유효성": { "type": "boolean", "description": "국가별 번호 체계상 형식이 맞는지 여부입니다. 형식만 보는 값이므로, 지금 개통된 번호인지는 hlr.활성회선여부로 확인하세요." }, "국가": { "type": "string", "description": "번호가 속한 국가 이름(영문)입니다. 예: South Korea" }, "지역": { "type": "string", "description": "번호가 속한 지역 이름입니다. 현재는 국가 이름과 같은 값입니다." }, "국가코드": { "type": "string", "description": "국가를 구분하는 영문 2자리 코드입니다. 예: KR, US" }, "모바일여부": { "type": "boolean", "description": "번호 형식상 휴대전화 번호인지 여부입니다." }, "회선유형": { "type": "string", "description": "번호 형식상 회선 유형입니다. mobile(휴대전화) 또는 fixed-line(그 외)입니다." }, "hlr": { "type": "object", "properties": { "활성회선여부": { "type": "boolean", "description": "지금 개통돼 통화·문자를 받을 수 있는 회선이면 true, 아니면 false입니다. 상태를 확인할 수 없는 경우(상태코드가 unavailable·failed)는 null입니다.", "nullable": true }, "개통상태": { "type": "string", "description": "상태코드의 한글 이름입니다. 개통 / 부재 / 결번/미개통 / 유효하지 않은 번호 / 유선 / VOIP / 제공되지 않음 / 조회실패 중 하나입니다." }, "상태코드": { "type": "string", "description": "회선 상태 코드입니다.ok: 개통(사용 중)absent: 부재(개통됐지만 지금 연결되지 않음)unknown: 결번 또는 미개통invalid: 유효하지 않은 번호fixed-line: 유선 번호voip: 인터넷 전화 번호unavailable: 이 번호는 회선 상태를 제공하지 않음failed: 회선 상태를 받지 못함" }, "HLR유효": { "type": "boolean", "description": "회선 상태를 확인했는지 여부입니다. 상태코드가 unavailable·failed이면 false입니다." }, "번호유효": { "type": "boolean", "description": "회선 조회 기준으로 유효한 번호인지 여부입니다." }, "모바일여부": { "type": "boolean", "description": "회선 조회 기준 휴대전화 여부입니다. 회선 유형을 모르면 null입니다.", "nullable": true }, "번호이동여부": { "nullable": true, "type": "boolean", "description": "번호이동 여부입니다. 제공되지 않으면 null입니다." }, "로밍여부": { "nullable": true, "type": "boolean", "description": "로밍 중인지 여부입니다. 제공되지 않으면 null입니다." }, "현재통신사": { "type": "string", "description": "지금 이 번호를 쓰고 있는 통신사 이름입니다. 번호이동을 했다면 옮긴 뒤의 통신사입니다. 예: KT. 확인하지 못하면 null입니다.", "nullable": true }, "원통신사": { "nullable": true, "type": "string", "description": "번호를 처음 개통한 통신사입니다. 제공되지 않으면 null입니다." }, "이동통신사": { "nullable": true, "type": "string", "description": "이동통신사 이름입니다. 제공되지 않으면 null이며, 통신사는 현재통신사를 쓰세요." }, "회선유형": { "type": "string", "description": "회선 조회 기준 유형입니다. mobile / fixed-line / voip / null", "nullable": true }, "위치": { "type": "string", "description": "회선이 속한 국가 이름(영문)입니다.", "nullable": true }, "국가": { "type": "string", "description": "회선이 속한 국가 이름(영문)입니다.", "nullable": true }, "국가코드": { "type": "string", "description": "회선이 속한 국가의 영문 2자리 코드입니다.", "nullable": true }, "국제번호": { "type": "string", "description": "회선 조회 기준 국제 표기 번호입니다.", "nullable": true }, "지역번호": { "type": "string", "description": "회선 조회 기준 국내 표기 번호입니다.", "nullable": true }, "도달가능성": { "type": "string", "description": "회선 도달 상태 원값입니다. active / reachable / unreachable / inactive / null. 판단은 상태코드로 하는 것이 간단합니다.", "nullable": true }, "MCC": { "type": "string", "description": "이동통신 국가 코드입니다. 휴대전화 번호에만 있습니다. 예: 450(대한민국)", "nullable": true }, "MNC": { "type": "string", "description": "이동통신 사업자 코드입니다. 휴대전화 번호에만 있습니다.", "nullable": true } }, "description": "회선 조회 결과입니다. 번호가 지금 개통돼 있는지와 현재 통신사를 담습니다." }, "success": { "type": "integer", "description": "처리 상태입니다. 1이면 검사가 끝난 정상 응답(요금 차감), 0이면 실패 응답(차감 없음)입니다." }, "error": { "type": "string", "description": "실패 사유 문구입니다. 정상 응답에는 없으며, 값이 있으면 아래 오류 응답 표에서 원인과 조치를 확인하세요." } }, "description": "검사 결과 묶음입니다. 실패하면 아래 필드 대신 error 문구가 들어 있습니다." }, "api": { "type": "object", "properties": { "success": { "type": "boolean", "description": "요청을 정상적으로 받아 처리했는지 여부입니다. 번호 상태는 data.유효성과 data.hlr로 확인하세요." }, "cost": { "type": "integer", "description": "이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다." }, "ms": { "type": "integer", "description": "요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. 네트워크 왕복 시간은 포함되지 않습니다." }, "pl_id": { "type": "integer", "description": "포인트 차감 기록 번호입니다. 차감이 있었던 호출에만 값이 있으며 과금 문의 때 사용합니다." } }, "description": "호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다." } } } ``` ### 정적 응답 예시 ```json { "data": { "국제번호": "+821012345678", "지역번호": "010-1234-5678", "유효성": true, "국가": "South Korea", "지역": "South Korea", "국가코드": "KR", "모바일여부": true, "회선유형": "mobile", "hlr": { "활성회선여부": true, "개통상태": "개통", "상태코드": "ok", "HLR유효": true, "번호유효": true, "모바일여부": true, "번호이동여부": null, "로밍여부": null, "현재통신사": "KT", "원통신사": null, "이동통신사": null, "회선유형": "mobile", "위치": "South Korea", "국가": "South Korea", "국가코드": "KR", "국제번호": "+821012345678", "지역번호": "010-1234-5678", "도달가능성": "active", "MCC": "450", "MNC": "08" }, "success": 1 }, "api": { "success": true, "cost": 40, "ms": 950, "pl_id": 409 } } ``` ### curl ```curl curl --fail-with-body --request POST 'https://apick.app/rest/check_phone_valid' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'number=01012345678' ``` ### Node.js (서버 ESM) ```javascript const form = new FormData(); form.append("number", "01012345678"); const response = await fetch("https://apick.app/rest/check_phone_valid", { method: "POST", headers: { Authorization: "Bearer " + process.env.APICK_API_KEY }, body: form, signal: AbortSignal.timeout(120_000), }); if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`); const result = await response.json(); console.log(result); ``` ### python ```python import os import requests parts = [ ("number", (None, "01012345678")), ] response = requests.request("POST", "https://apick.app/rest/check_phone_valid", headers={"Authorization": "Bearer " + os.environ["APICK_API_KEY"]}, files=parts, timeout=(10, 120)) response.raise_for_status() result = response.json() print(result) ``` ### php ```php '01012345678', ]; $curl = curl_init('https://apick.app/rest/check_phone_valid'); curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => $headers, CURLOPT_POSTFIELDS => $form, CURLOPT_RETURNTRANSFER => true, CURLOPT_CONNECTTIMEOUT => 10, CURLOPT_TIMEOUT => 120, ]); $body = curl_exec($curl); if ($body === false) { throw new RuntimeException(curl_error($curl)); } $status = curl_getinfo($curl, CURLINFO_HTTP_CODE); curl_close($curl); if ($status >= 400) { throw new RuntimeException($body); } $result = json_decode($body, true, 512, JSON_THROW_ON_ERROR); print_r($result); ``` ## 사용 예시 1. 국내 휴대전화 번호 검사 문자 발송 전에 번호가 개통돼 있는지 확인합니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/check_phone_valid' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'number=01012345678' ``` - `data.hlr.상태코드`가 `ok`이면 개통된 번호, `unknown`이면 결번·미개통이므로 발송 대상에서 뺍니다. - `data.hlr.현재통신사`로 현재 통신사를 확인합니다. ## 사용 예시 2. 해외 번호 검사 해외 번호는 +국가번호로 시작하게 보냅니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/check_phone_valid' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'number=+14155550123' ``` - `data.국가코드`로 국가를, `data.유효성`으로 번호 형식을 확인합니다. - `data.hlr.활성회선여부`가 null이면 그 번호의 회선 상태를 알 수 없는 것이므로 결번으로 단정하지 않습니다. ## 사용 예시 3. 입력 형식 오류 거르기 자릿수가 모자란 번호처럼 형식이 틀린 번호를 걸러 냅니다. ```bash curl --fail-with-body --request POST 'https://apick.app/rest/check_phone_valid' \ --header "Authorization: Bearer $APICK_API_KEY" \ --form-string 'number=0101234' ``` - `data.유효성`이 false이면 번호를 다시 입력받습니다. - `data.error`가 "HLR 조회에 실패했습니다."(HTTP 424)이면 잠시 후 다시 요청합니다. ## 코드·오류 ### 업무 실패 응답 입력 오류·대상 없음·일시 실패는 data.error(사유)와 data.success=0으로 오며 api.cost는 0(과금 없음)입니다. HTTP 상태는 400·404·408·424 중 하나입니다. 입력 오류는 값을 고쳐 다시 요청하고, 408·424는 잠시 후 한 번 다시 시도하세요. ```json { "data": { "error": "입력값을 확인해 주세요.", "success": 0 }, "api": { "success": true, "cost": 0, "ms": 5 } } ``` ## 상세 기능·요금 제공 정보 전화번호 하나를 보내면 두 가지를 함께 돌려줍니다. ① 번호 형식 검사: 국가별 번호 체계에 맞는지, 국제·국내 표기, 국가, 휴대전화 여부 ② 회선 조회(hlr): 현재 개통 상태, 현재 통신사, 회선 유형. 회원 가입·주문 화면에서 잘못 입력한 번호를 걸러 내거나, 문자 발송 전에 결번·미개통 번호를 미리 빼서 발송 실패를 줄일 때 사용합니다. 국가에 따라 회선 상태를 제공하지 않을 수 있으며, 이때 hlr.활성회선여부는 null입니다. Method URL POST https://apick.app/rest/check_phone_valid ## 상세 요청 Header 이름 필수 설명 Authorization 필수 Bearer 인증키. 예: Authorization: Bearer 발급받은_API_키 ## 상세 응답 Body 필드 타입 설명 data Object 검사 결과 묶음입니다. 실패하면 아래 필드 대신 error 문구가 들어 있습니다. 국제번호 String | null 국제 표기 번호입니다. 예: +821012345678. 번호로 인식하지 못하면 null입니다. 지역번호 String | null 그 나라의 국내 표기 번호입니다. 예: 010-1234-5678. 화면 표시용으로 쓰기 좋습니다. 유효성 Boolean 국가별 번호 체계상 형식이 맞는지 여부입니다. 형식만 보는 값이므로, 지금 개통된 번호인지는 hlr.활성회선여부로 확인하세요. 국가 String 번호가 속한 국가 이름(영문)입니다. 예: South Korea 지역 String 번호가 속한 지역 이름입니다. 현재는 국가 이름과 같은 값입니다. 국가코드 String 국가를 구분하는 영문 2자리 코드입니다. 예: KR, US 모바일여부 Boolean 번호 형식상 휴대전화 번호인지 여부입니다. 회선유형 String 번호 형식상 회선 유형입니다. mobile(휴대전화) 또는 fixed-line(그 외)입니다. hlr Object 회선 조회 결과입니다. 번호가 지금 개통돼 있는지와 현재 통신사를 담습니다. 활성회선여부 Boolean | null 지금 개통돼 통화·문자를 받을 수 있는 회선이면 true, 아니면 false입니다. 상태를 확인할 수 없는 경우(상태코드가 unavailable·failed)는 null입니다. 개통상태 String 상태코드의 한글 이름입니다. 개통 / 부재 / 결번/미개통 / 유효하지 않은 번호 / 유선 / VOIP / 제공되지 않음 / 조회실패 중 하나입니다. 상태코드 String 회선 상태 코드입니다.ok: 개통(사용 중)absent: 부재(개통됐지만 지금 연결되지 않음)unknown: 결번 또는 미개통invalid: 유효하지 않은 번호fixed-line: 유선 번호voip: 인터넷 전화 번호unavailable: 이 번호는 회선 상태를 제공하지 않음failed: 회선 상태를 받지 못함 HLR유효 Boolean 회선 상태를 확인했는지 여부입니다. 상태코드가 unavailable·failed이면 false입니다. 번호유효 Boolean 회선 조회 기준으로 유효한 번호인지 여부입니다. 모바일여부 Boolean | null 회선 조회 기준 휴대전화 여부입니다. 회선 유형을 모르면 null입니다. 현재통신사 String | null 지금 이 번호를 쓰고 있는 통신사 이름입니다. 번호이동을 했다면 옮긴 뒤의 통신사입니다. 예: KT. 확인하지 못하면 null입니다. 회선유형 String | null 회선 조회 기준 유형입니다. mobile / fixed-line / voip / null 도달가능성 String | null 회선 도달 상태 원값입니다. active / reachable / unreachable / inactive / null. 판단은 상태코드로 하는 것이 간단합니다. 번호이동여부 Boolean | null 번호이동 여부입니다. 제공되지 않으면 null입니다. 로밍여부 Boolean | null 로밍 중인지 여부입니다. 제공되지 않으면 null입니다. 원통신사 String | null 번호를 처음 개통한 통신사입니다. 제공되지 않으면 null입니다. 이동통신사 String | null 이동통신사 이름입니다. 제공되지 않으면 null이며, 통신사는 현재통신사를 쓰세요. 위치 String | null 회선이 속한 국가 이름(영문)입니다. 국가 String | null 회선이 속한 국가 이름(영문)입니다. 국가코드 String | null 회선이 속한 국가의 영문 2자리 코드입니다. 국제번호 String | null 회선 조회 기준 국제 표기 번호입니다. 지역번호 String | null 회선 조회 기준 국내 표기 번호입니다. MCC String | null 이동통신 국가 코드입니다. 휴대전화 번호에만 있습니다. 예: 450(대한민국) MNC String | null 이동통신 사업자 코드입니다. 휴대전화 번호에만 있습니다. error String 실패 사유 문구입니다. 정상 응답에는 없으며, 값이 있으면 아래 오류 응답 표에서 원인과 조치를 확인하세요. success Integer 처리 상태입니다. 1이면 검사가 끝난 정상 응답(요금 차감), 0이면 실패 응답(차감 없음)입니다. api Object 호출 공통 정보입니다. 처리 여부·차감 포인트·처리 시간·차감 기록 번호가 들어 있습니다. success Boolean 요청을 정상적으로 받아 처리했는지 여부입니다. 번호 상태는 data.유효성과 data.hlr로 확인하세요. cost Integer 이번 호출에서 차감된 포인트입니다. data.error가 있는 실패 응답은 0입니다. ms Integer 요청을 받아 응답을 만들기까지 걸린 시간(밀리초)입니다. 네트워크 왕복 시간은 포함되지 않습니다. pl_id Integer 포인트 차감 기록 번호입니다. 차감이 있었던 호출에만 값이 있으며 과금 문의 때 사용합니다. 판정 예: 유효성이 false이면 번호를 다시 입력받습니다. hlr.상태코드가 unknown이면 결번·미개통이므로 문자 발송 대상에서 빼고, absent이면 개통된 번호이므로 나중에 다시 연락합니다. unavailable·failed면 회선 상태를 알 수 없는 것이므로 결번으로 단정하지 마세요. ## 상세 코드·정책 오류 응답 HTTP data.error 원인·조치 400 입력 항목이 잘못됐습니다. number가 없거나 빈 값입니다. 424 HLR 조회에 실패했습니다. 회선 조회를 끝내지 못했습니다. 잠시 후 다시 요청하세요. 424 HLR 서비스는 대량 이용 시 사전 문의가 필요합니다. 문의를 남겨주세요. 이용 한도를 넘었습니다. 대량으로 쓰려면 고객지원으로 먼저 문의하세요. 회선 상태 확인을 포함해 성공한 조회 한 건당 40포인트가 차감됩니다. 실제 차감액은 api.cost로 확인하세요. 오류 응답은 data.success 0, api.cost 0이며 요금이 차감되지 않습니다. ## 상세 예제 요청 예시 form-data 전체 예제 보기 응답 예시 { "data": { "국제번호": "+821012345678", "지역번호": "010-1234-5678", "유효성": true, "국가": "South Korea", "지역": "South Korea", "국가코드": "KR", "모바일여부": true, "회선유형": "mobile", "hlr": { "활성회선여부": true, "개통상태": "개통", "상태코드": "ok", "HLR유효": true, "번호유효": true, "모바일여부": true, "번호이동여부": null, "로밍여부": null, "현재통신사": "KT", "원통신사": null, "이동통신사": null, "회선유형": "mobile", "위치": "South Korea", "국가": "South Korea", "국가코드": "KR", "국제번호": "+821012345678", "지역번호": "010-1234-5678", "도달가능성": "active", "MCC": "450", "MNC": "08" }, "success": 1 }, "api": { "success": true, "cost": 40, "ms": 950, "pl_id": 409 } } 호출 예시 같은 요청을 JavaScript와 Python으로 옮긴 예시입니다. 키는 환경변수 APICK_API_KEY 에서 읽습니다. JavaScript 예시 form-data 전체 예제 보기 Python 예시 form-data 전체 예제 보기