번호 재고가 있는 미국 주 또는 캐나다 주 목록 조회

미국 또는 캐나다에서 번호를 검색할 때 이 선택 단계를 사용하면 주별로 검색 범위를 좁힐 수 있습니다. US와 CA만 허용됩니다.

• 각 항목은 요청 시점에 해당 주에서 재고가 있는 프리픽스를 나타냅니다.
• 다음 링크를 따라가세요: next_function. 해당 주의 지역 목록을 조회할 수 있습니다. 이 링크에는 이미 state 필터가 포함되어 있지만 pid는 포함되어 있지 않습니다.
• 지역 조회에서는 주 정보를 일치시키는 방식이 약간 다릅니다. 해당 주의 next_function 반환값이 No areas found이면 대신 getareas를 주 지정 없이 호출하세요.
• 먼저 status.code를 확인한 다음 response를 읽으세요. 지원되지 않는 국가이거나 조건에 맞는 재고가 없는 국가인 경우 코드 404가 반환되지만 이에 대응하는 HTTP 상태는 설정되지 않습니다.
• 코드 200과 함께 빈 목록이 반환되면 재고는 있지만 주 정보가 없다는 뜻입니다. getareas를 주 지정 없이 호출하세요.

요청

필수: HTTP Basic 인증 또는 Bearer 토큰(인증 및 API 응답 참조). 인증에 실패하면 조회를 실행하기 전에 HTTP 401을 반환합니다.

GET 요청을 사용하며 경로에 isocode를 지정합니다. 해당 경로 세그먼트를 생략하면 대신 폼 인코딩된 isocode 필드를 읽습니다. 선택 항목인 pid는 쿼리 문자열로 전송합니다.

curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getstates/US'

응답

표준 공통 응답 형식입니다. 성공 시 status.code는 200이고, status.msg는 비어 있으며, status.results는 항목 수입니다. response는 name(대소문자 구분 없음), 그다음 state 코드 순으로 정렬된 목록입니다. 필드: state(프리픽스의 주 데이터에서 가져온 주 코드로, 보통 영문 두 글자이며 일반적이지 않은 값도 변경 없이 전달됨), name(카탈로그 이름이며, 카탈로그에 이름이 없으면 코드), country_iso, available(집계 대상 프리픽스 전체의 총 재고 수로 항상 0보다 큼), prefix_count(집계한 재고 프리픽스 수), is_mobile(집계 대상 중 이동통신을 지원하는 프리픽스가 있으면 1이며, US의 경우 계정에 미국 이동통신 번호 사용이 활성화되어 있지 않으면 항상 0), sms_coverage(집계 대상 중 SMS를 지원하는 프리픽스가 있으면 1), returns_numbers(집계 대상 중 번호 반환 플래그가 설정되어 있거나 해당 플래그 값이 없는 프리픽스가 있으면 1), next_function('v3/getareas/{isocode}?state={state}'). 재고 프리픽스는 있지만 어느 프리픽스에도 주 정보가 없으면 status.code는 200, 목록은 비어 있고 status.results는 0입니다.

응답 형식을 보여 주는 예시이며, 실제 계정 데이터나 현재 견적이 아닙니다.

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 2
  },
  "response": [
    {
      "state": "NY",
      "name": "New York",
      "country_iso": "US",
      "available": 120,
      "prefix_count": 8,
      "is_mobile": 0,
      "sms_coverage": 1,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=NY"
    },
    {
      "state": "TX",
      "name": "Texas",
      "country_iso": "US",
      "available": 45,
      "prefix_count": 3,
      "is_mobile": 0,
      "sms_coverage": 0,
      "returns_numbers": 1,
      "next_function": "v3/getareas/US?state=TX"
    }
  ]
}

오류

• 500: msg 'ISO Code parameter is required': isocode가 누락되었거나 비어 있습니다. 수정할 수 있는 요청 오류입니다. 이에 대응하는 HTTP 상태는 설정되지 않으므로 status.code를 읽으세요.
• 404: msg 'getstates is only available for US and CA': 허용된 국가 이외의 국가 코드가 지정되었습니다. 이에 대응하는 HTTP 상태는 설정되지 않습니다.
• 404: msg 'No states found': 국가 및 공급원 필터와 일치하는 재고 프리픽스가 없습니다. 이에 대응하는 HTTP 상태는 설정되지 않습니다.
• 401: 인증 정보가 없거나 인증에 실패했습니다. HTTP 상태 401과 함께 전송됩니다.

재고 현황 및 부수 효과

• 조회만 수행합니다. 예약, 주문 또는 어떠한 변경도 하지 않습니다. available은 정보 제공용이며 번호를 확보하지 않습니다.