MultiTEL
개발자

GET/v3/get_supporting_document_templates/{iso}

증빙 서류 템플릿 목록 조회

증빙 서류를 준비하기 전에 템플릿 ID, 이름 및 국가 참고 정보를 확인하세요.

이 페이지의 내용
  1. 템플릿 카탈로그 살펴보기
  2. 요건에 따라 템플릿 선택하기
  3. 반환된 템플릿이 없는 경우
  4. 다운로드한 사본을 사용하기 전에 검토하기
  5. 요청
  6. 응답
  7. 오류
  8. 이용 가능 여부 및 부수 효과

템플릿 카탈로그 살펴보기

서비스에서 반환하는 템플릿 목록을 조회하려면 선택 사항인 ISO 경로 구간을 생략하세요. 목록을 필터링하려면 국가 ISO 코드를 지정하세요. 필터는 템플릿의 국가 참고 정보와 일치하는 항목을 찾습니다. 이 정보는 이름에서 추정된 것일 수 있으며 비어 있을 수도 있습니다.

요건에 따라 템플릿 선택하기

템플릿이 목록에 있다고 해서 해당 국가의 모든 번호에 그 템플릿이 필요하거나 인정된다는 뜻은 아닙니다. 템플릿 ID를 해당 증빙 서류 요건과 대조하세요. 이 목록은 작성된 서류를 생성하거나 서명하거나 업로드하거나 승인하지 않습니다.

반환된 템플릿이 없는 경우

필터링된 목록이 비어 있으면 일치하는 국가 참고 정보를 찾지 못했다는 뜻일 수 있습니다. 필터링하지 않은 목록이 비어 있는 경우에도 상위 시스템의 데이터를 이용할 수 없는 상황이 반영된 것일 수 있습니다. 어느 결과도 증빙 서류가 필요하지 않다는 근거로 해석하지 마세요.

다운로드한 사본을 사용하기 전에 검토하기

카탈로그의 다운로드 링크는 서식이나 브랜드 표시가 변경된 사본을 반환할 수 있습니다. 이 사본이 변경되지 않은 원본 계약서라거나 다운로드만으로 등록 요건이 충족된다고 가정하지 마세요. 어떤 서류든 작성하거나 서명하기 전에 내용을 검토하세요.

해당 포털 문서 마법사에서 계약서 작성 기능을 제공하는 경우, 미리보기와 명시적인 제출 절차를 이용하세요. 그 밖의 필수 양식은 작성하기 전에 MultiTEL에 최신 양식을 확인하세요. 다운로드한 템플릿은 서명된 첨부 파일이나 업로드된 증빙 자료가 아니며, 번호에 대한 승인을 의미하지도 않습니다.

요청

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

문서에 명시된 매개변수를 URL 경로에 넣어 GET 요청을 보내세요.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_supporting_document_templates/$COUNTRY_ISO"
경로 매개변수
이름유형필수 여부설명
isostring아니요선택 사항인 국가 ISO 필터입니다. 필터링하지 않은 목록을 조회하려면 이 경로 구간 전체를 생략하세요. 비교 시 대소문자를 구분하지 않습니다. 알 수 없거나 일치하지 않는 값을 지정하면 국가가 유효하지 않다는 명시적인 오류 대신 빈 목록을 반환합니다.

응답

HTTP 상태뿐 아니라 JSON 본문의 status.code도 확인하세요. response는 id, name, permanent, iso, url 필드를 가진 객체의 배열입니다. permanent는 boolean 유형이며, iso는 비어 있거나 템플릿 이름에서 추정된 값일 수 있습니다. 국가 정보는 자격 요건 충족 여부에 대한 판단이 아닌 참고 정보로 취급하세요. 빈 카탈로그는 성공한 200 응답이며, 상위 시스템 조회에서 데이터가 반환되지 않을 때도 발생할 수 있습니다. URL은 서비스에서 생성하며, 호스트 이름은 설명용 예시와 다를 수 있습니다.

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "TEMPLATE_ID_FROM_RESPONSE",
      "name": "Example supporting-document template",
      "permanent": false,
      "iso": "US",
      "url": "https://api.multitel.net/v3/supporting_document/TEMPLATE_ID_FROM_RESPONSE"
    }
  ]
}

오류

  • 인증 오류나 서비스 오류가 있는지 status.code와 status.msg를 확인하세요. 빈 카탈로그가 성공적으로 반환되었다고 해서 서류가 승인되거나 등록이 면제되는 것은 아닙니다.

이용 가능 여부 및 부수 효과

  • 이 카탈로그/요건 조회는 신원 정보를 생성하거나 증빙 자료를 업로드하거나 번호를 등록하거나 주문하지 않습니다.
  • 카탈로그 응답이 성공했다고 해서 제출 서류가 승인되었거나 선택한 번호를 활성화할 수 있음이 확인된 것은 아닙니다.