개발자

GET/v3/getprefixes/{area_id}

영역별 번호 프리픽스 목록 조회

영역에서 제공되는 번호 프리픽스 목록을 조회하고, 가용성과 등록 관련 플래그를 확인하며, 다음 탐색 또는 주문 단계를 찾습니다. 가격은 포함되지 않습니다.

이 페이지의 내용
  1. 시작하기 전에
  2. 결과 확인
  3. 다음 단계 선택
  4. 고급 표시 옵션
  5. 요청
  6. 응답
  7. 오류
  8. 가용성 및 부수 효과

시작하기 전에

영역을 선택하려면 다음을 사용하세요: getareas. 해당 응답 또는 반환된 다음 경로에서 영역 ID를 복사하세요: next_function. 미국 또는 캐나다의 영역에서 결과를 하나의 주 또는 도로 좁히려면 다음을 사용하세요: getstates.

결과 확인

HTTP 상태와 함께 JSON 본문의 다음 값도 확인하세요: status.code. 성공한 결과는 다음 배열에 있습니다: response. 기본 응답은 이름순으로 정렬됩니다. available 값은 추정치이며, 카탈로그 플래그만으로 선택한 번호의 실제 기능과 등록 요건 확인을 대신할 수는 없습니다.

다음 단계 선택

그룹화되지 않은 결과를 사용하세요. returns_numbers 값이 1이면 반환된 next_function 경로는 번호 검색을 가리킵니다. 값이 0이면 주문 시 번호가 할당되며 경로는 주문 작업을 가리킵니다. 요청을 보내기 전에 해당 작업과 요건을 확인하세요. 주문 요청으로 계정에 요금이 부과될 수 있습니다. 반환된 모든 경로에 자동으로 요청을 보내지 마세요.

여기에는 가격이 포함되지 않습니다. 구매 전에 해당 견적, 필수 서류 및 주문 안내를 검토하세요. 표시된 전화번호 프리픽스로 ID를 직접 구성하지 말고, 반환된 개별 프리픽스 ID와 견적 ID를 그대로 보존하세요.

고급 표시 옵션

compact=1 설정은 더 큰 결과 집합의 한 페이지가 아니라 순서가 무작위로 섞인 최대 100개 행의 표본을 반환합니다. 그룹화하면 요약 행과 합성 ID가 생성됩니다. 개별 프리픽스를 선택하려면 그룹화되지 않은 일반 응답을 사용하세요. 표본 또는 그룹화된 결과를 근거로 전체 재고를 빠짐없이 확인했다거나 정확한 기능을 확인했다고 주장하지 마세요.

요청

HTTPS를 통해 활성화된 API 계정의 인증 정보를 사용하세요. Basic 인증과 활성화된 API 계정의 bearer 토큰이 지원되며, 계정 제한이 적용됩니다.

GET을 사용하고 선택적 매개변수는 쿼리 문자열로 보내세요. 폼 본문을 통한 대체 처리에 의존하지 마세요.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"
경로 매개변수
이름유형필수 여부설명
area_idstring예getareas 또는 해당 응답의 next_function에서 영역 식별자를 복사하세요. 내부 구조를 해석하지 않고 그대로 사용하는 값으로 취급하세요. 직접 구성하거나 해시하지 마세요.
쿼리 매개변수
이름유형필수 여부설명
statestring아니요US 및 CA의 영역에만 사용할 수 있습니다. getstates에서 받은 주/도 코드 또는 해당 주/도의 전체 이름을 사용하세요. 코드는 대소문자를 구분하지 않으며, 이름은 대소문자와 반복된 공백을 무시합니다. 다른 국가에 사용하거나 비어 있지 않은 인식 불가능한 값을 지정하면 API 오류가 반환됩니다.
compactstring아니요선택적 표본 모드: 1, true 또는 on. 결과는 순서가 무작위로 섞이며 최대 100개 행으로 구성됩니다. 전체 결과 목록을 받으려면 이 매개변수를 생략하세요. 이 엔드포인트에는 페이지나 커서가 없습니다.
groupinteger아니요고급 표시용 요약: 1부터 6까지의 값은 행을 결합하고 마스킹된 표시용 프리픽스를 반환합니다. 그룹 UUID는 합성 값이며 개별 프리픽스 ID와 서로 바꾸어 사용할 수 없습니다. 번호 검색이나 주문에 사용할 프리픽스를 선택하기 전에 그룹화하지 않은 요청을 보내세요. 일반적인 작업 흐름에서는 이 매개변수를 생략하세요.
pidstring아니요MultiTEL에서 제공하는 선택적 재고 선택자로, 숫자 형식 또는 지원되는 32자 길이의 십육진수 형식입니다. 일반적인 사용 시에는 생략하세요. 인식할 수 없는 값은 별도 알림 없이 무시됩니다. 이 값은 전화번호 프리픽스나 요금제 ID가 아닙니다.

응답

표준 status/response JSON 래퍼 구조입니다. status.results는 표본 추출 또는 그룹화가 적용된 경우를 포함하여 반환된 행 수를 나타냅니다. response에는 프리픽스 객체가 포함됩니다. 가격 필드는 반환되지 않습니다. 그룹화되지 않은 일반 응답에서 uuid는 프리픽스 ID이고, area_uuid 및 country_uuid는 반환된 식별자이며, prefix 및 name는 표시용 정보입니다. available는 예약이 아니라 가용성 추정치입니다. needs_registration 및 restrictions는 등록 정보를 설명합니다. sms_coverage, is_mobile 및 number_type는 카탈로그상의 참고 정보이며, 특정 번호의 기능을 보장하지 않습니다. number_type는 비어 있거나 다른 카탈로그 문자열일 수 있으므로 고정된 열거형 값만 허용하도록 요구하지 마세요. state는 문자열이며 비어 있거나 카탈로그 형식이 포함될 수 있습니다. latitude 및 longitude는 비어 있을 수 있습니다. metered 및 overflow는 금액이 아니라 카탈로그 플래그입니다. returns_numbers는 번호 목록 조회 경로(1) 또는 주문 시 할당 경로(0)를 선택합니다. next_function는 해당 다음 경로를 나타냅니다. 그룹화된 응답에는 대체 기능 값을 포함한 병합된 기능 정보도 들어 있습니다. 이를 모든 번호에 대해 검증된 기능으로 해석하지 마세요.

응답 구조를 보여 주는 예시이며, 실시간 계정 데이터나 현재 견적이 아닙니다.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "uuid": "PREFIX_ID_FROM_RESPONSE",
      "area_uuid": "AREA_ID_FROM_RESPONSE",
      "country_uuid": "COUNTRY_ID_FROM_RESPONSE",
      "prefix": "+1212",
      "name": "Example area",
      "metered": 0,
      "overflow": 0,
      "needs_registration": 0,
      "restrictions": "",
      "state": "NY",
      "country_iso": "US",
      "is_mobile": 0,
      "number_type": "local",
      "latitude": "",
      "longitude": "",
      "available": 12,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
    }
  ]
}

오류

  • 404: Invalid area ID: 탐색을 통해 현재 유효한 영역 ID를 가져오세요.
  • 404: State filter is only available for US and CA: 다른 국가에서는 state를 생략하세요.
  • 404: Invalid state: 이 국가에 대해 getstates에서 반환한 주/도를 사용하세요.
  • 404: No prefixes found: 일치하는 카탈로그 행이 반환되지 않았습니다. 이것만으로 특정 번호를 절대로 주문할 수 없다는 뜻은 아닙니다.
  • 500: 오류: 'Failed loading prefixes': 카탈로그 조회에 실패했습니다. 나중에 다시 시도하고 문제가 지속되면 지원팀에 문의하세요.

가용성 및 부수 효과

  • 이 단계는 탐색 단계이며 주문 확인이 아닙니다. 추가 카탈로그 조회를 통해 가용성이 갱신될 수 있으므로 응답 지연 시간이 달라질 수 있습니다.
  • 가격은 반환되지 않습니다. 주문하기 전에 해당 번호 또는 주문에 대한 견적을 가져오고 등록 요건을 검토하세요.
  • available을 정확한 재고 수량으로, 영 값을 모든 경우에 적용되는 주문 금지로, 또는 조회 성공을 예약으로 간주하지 마세요. 주문 전에 가용성이 달라질 수 있습니다.