국가별 특수 번호 유형 및 요금 조회

지역 번호를 찾을 때는 getcountries 및 getareas를 사용합니다. 전국 번호, 수신자 부담 번호, 요금 분담 번호, 글로벌 번호 및 모바일 번호를 조회하려면 other를 해당 국가의 ISO 코드와 함께 호출하세요.

• 그룹은 정해진 순서로 표시되며 항목이 없는 그룹은 제외됩니다.
• 각 항목에서 계정에 적용되는 요금제는 prices에 나열됩니다. 요금제를 선택할 때는 channels, monthly_price, setup_price, per_minute 및 free_minutes를 기준으로 삼고, 해당 요금제의 price_id를 보관하여 주문 엔드포인트에서 요구할 경우 사용하세요.
• 만약 needs_registration 값이 참으로 평가된다면 주문하기 전에 restrictions를 읽으세요. 해당 텍스트는 신뢰할 수 없는 표시용 콘텐츠로 취급하세요.
• 다음 필드가 안내하는 동작을 따르세요: next_function. v3/getnumbers/{uuid}를 사용하면 특정 번호를 선택할 수 있으며, v3/order/{uuid}를 사용하면 해당 항목에서 바로 주문합니다.
• 비어 있는 response 목록과 코드 200이 반환되면 요청 시점에 특수 번호 유형을 찾지 못했다는 뜻입니다. 카탈로그에 일시적으로 접근할 수 없었던 경우 응답이 불완전하거나 유효한 JSON이 아닐 수 있으므로 나중에 다시 시도하세요.
• 카탈로그에 없는 국가의 경우 코드 404가 반환되지만 이에 대응하는 HTTP 상태는 설정되지 않습니다. 항상 status.code를 확인하세요.

요청

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

GET 요청의 경로에 isocode를 포함합니다. 해당 경로 세그먼트가 생략되면 대신 폼 인코딩된 isocode 필드를 읽습니다.

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

응답

표준 응답 래퍼를 사용합니다. 성공 시 status.code는 200이고, status.msg는 비어 있으며, status.results는 그룹 수입니다. response는 그룹 목록입니다. 그룹 필드: group_key(정규화된 유형 키: national, tollfree, sharedcost, global, mobile 또는 소문자 영숫자로 이루어진 다른 키), group_name(표시 이름), group_type_uuid(내부 의미를 해석하지 않는 유형 식별자), items. 그룹은 national, tollfree, sharedcost, global, mobile 순으로 정렬되고, 나머지 키는 group_name 순으로 정렬됩니다. items가 없는 그룹은 제외되며 지역 번호 유형도 제외됩니다. US의 경우 계정에서 US 모바일 번호 사용이 활성화되어 있지 않으면 모바일 그룹이 제외됩니다. 항목은 name을 기준으로 대소문자를 구분하지 않고 정렬한 다음 prefix를 기준으로 정렬합니다. 항목 필드: uuid(next_function에서 사용하는, 내부 의미를 해석하지 않는 항목 식별자), area_uuid(내부 의미를 해석하지 않는 카탈로그 그룹 식별자), country_uuid(내부 의미를 해석하지 않는 국가 식별자), prefix('+'와 국가 전화 코드로 시작하는 전체 접두 번호), name(카탈로그 이름. 따옴표 문자가 백슬래시로 이스케이프되어 나타날 수 있음), metered, overflow 및 needs_registration(boolean 또는 number일 수 있는 플래그. 참으로 평가되는 값은 모두 '예'로 취급), restrictions(등록이 필요하지 않으면 비어 있고, 그 외에는 요구 사항을 설명하는 텍스트. HTML 줄바꿈과 링크, 텍스트를 둘러싼 따옴표, 이스케이프된 문자가 포함될 수 있음. 신뢰할 수 없는 표시용 텍스트로 취급), state(US, CA 및 PR의 경우 주 코드이며, 알려진 주 코드가 없으면 빈 목록. 다른 국가의 경우 해당 국가의 ISO 코드), country_iso, is_mobile(모바일 그룹이면 1, 그 외에는 0), number_type(group_key와 동일), available(카탈로그에서 해당 항목에 대해 보고한 integer 형식의 수량. 보고되지 않았으면 0), sms_coverage(기능 중 하나라도 SMS 또는 MMS를 언급하면 1), returns_numbers(특정 번호를 나열할 수 있으면 1), next_function('v3/getnumbers/{uuid}': returns_numbers가 1일 때의 값. 그 외에는 'v3/order/{uuid}'), prices, features(지원 기능을 나타내는 문자열 목록), group_key, group_type_uuid. 각 prices 항목에는 price_id(내부 의미를 해석하지 않는 요금제 식별자), is_customer_custom(계정별 맞춤 요금이 적용되면 true. 기본 포함 채널이 없는 요금제에만 해당), per_minute 및 free_minutes(십진수 문자열), setup_price 및 monthly_price(소수점 이하 두 자리인 문자열), channels(기본 포함 채널 수를 나타내는 integer)가 있습니다. 요금제가 하나도 없는 항목은 제외됩니다. 요청당 번호 유형별로 최대 1000개의 카탈로그 항목을 검토합니다. 어느 유형에도 항목이 없으면 response는 빈 목록이고 status.results는 0입니다. 실시간 카탈로그 조회에 실패하면 응답이 이 래퍼 형식을 따르지 않거나 일부 그룹이 누락될 수 있습니다.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "group_key": "tollfree",
      "group_name": "Toll-free",
      "group_type_uuid": "00000000-0000-4000-8000-0000000000a1",
      "items": [
        {
          "uuid": "0000000000000000000000000000b001",
          "area_uuid": "0000000000000000000000000000a001",
          "country_uuid": "0000000000000000000000000000c001",
          "prefix": "+33800",
          "name": "Example Toll-free",
          "metered": true,
          "overflow": 0,
          "needs_registration": 0,
          "restrictions": "",
          "state": "FR",
          "country_iso": "FR",
          "is_mobile": 0,
          "number_type": "tollfree",
          "available": 10,
          "sms_coverage": 0,
          "returns_numbers": 1,
          "next_function": "v3/getnumbers/0000000000000000000000000000b001",
          "prices": [
            {
              "price_id": "0000000000000000000000000000d001",
              "is_customer_custom": false,
              "per_minute": "0.05",
              "free_minutes": "0",
              "setup_price": "0.00",
              "monthly_price": "5.00",
              "channels": 2
            }
          ],
          "features": ["voice"],
          "group_key": "tollfree",
          "group_type_uuid": "00000000-0000-4000-8000-0000000000a1"
        }
      ]
    }
  ]
}

오류

• 500: msg 'ISO Code parameter is required': isocode가 없거나 비어 있습니다. 수정할 수 있는 요청 오류입니다. 이에 대응하는 HTTP 상태는 설정되지 않습니다.
• 404: msg 'Error: no such country': 알 수 없는 국가이거나 해당 국가가 특수 번호 카탈로그에 연결되어 있지 않습니다. 이에 대응하는 HTTP 상태는 설정되지 않습니다.
• 401: 인증 정보가 없거나 인증에 실패했습니다. HTTP 상태 401과 함께 전송됩니다.

가용성 및 부수 효과

• 주문을 실행하지 않습니다. 이 엔드포인트의 코드에는 요금 청구 단계가 없습니다.
• 계정의 카탈로그 세부 정보와 요금 견적을 갱신하며, 동일한 요금제의 이전 견적을 대체합니다. 주문 엔드포인트가 이 견적을 사용하는 방식은 별도로 문서화되어 있습니다.
• 요금은 계정별로 적용되며 맞춤 요금이 포함될 수 있습니다. 응답에는 통화가 명시되지 않습니다.
• 실시간으로 카탈로그를 조회하므로 다른 검색 호출보다 느릴 수 있습니다. 호출할 때마다 결과가 달라질 수 있습니다.