MultiTEL
개발자

GET/tcr/v2/campaignBuilder/brand/{brand_id}

브랜드에서 사용할 수 있는 캠페인 용도 확인하기

고객에게 캠페인 설정을 요청하기 전에 계정에 등록된 기존 브랜드에 대해 레지스트리가 제공하는 캠페인 용도를 확인합니다.

이 페이지의 내용
  1. 계정에 등록된 기존 브랜드 선택하기
  2. 이 결과를 바탕으로 용도 선택 항목 구성하기
  3. 선택한 용도의 요구 사항 불러오기
  4. 계정 요금 별도로 검토하기
  5. 브랜드 또는 용도가 변경되면 새로 불러오기
  6. 요청
  7. 응답
  8. 오류
  9. 가용성 및 부수 효과

계정에 등록된 기존 브랜드 선택하기

MultiTEL 계정에 이미 연결된 레지스트리 브랜드 ID를 사용합니다. 이 조회는 브랜드를 생성하거나 다른 사람의 브랜드를 계정에 연결하지 않습니다. 현재 고객용 절차에서는 이용 자격을 요청하기 전에 소유권을 확인합니다. 조회 결과로 404가 반환되면 로컬 행 ID로 대체하지 말고 선택한 계정과 브랜드를 확인하세요.

이 결과를 바탕으로 용도 선택 항목 구성하기

일반 용도 카탈로그는 레지스트리의 선택 항목을 설명합니다. 이 브랜드별 조회는 선택한 브랜드에서 사용할 수 있는 항목을 제공합니다. 반환된 각 usecase 값을 유지하고 카탈로그의 표시 이름 및 설명과 결합하세요. 브랜드가 모든 항목에 대한 이용 자격을 갖춘 것처럼 일반 카탈로그의 모든 항목을 제공하지 마세요.

포털은 이 응답이 JSON 목록이라고 예상합니다. 응답이 없거나 형식이 잘못되었거나 오류인 경우 고객의 양식 입력을 유지하고 이용 자격을 불러올 수 없었다고 표시하세요. 아무런 안내 없이 기본 용도가 승인된 것으로 처리하지 마세요. 레지스트리는 축약된 예시에 없는 필드를 반환할 수도 있습니다.

선택한 용도의 요구 사항 불러오기

고객이 반환된 용도 값을 선택하면 동일한 브랜드에 대해 다음 경로로 요청하세요: /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase}. 해당 응답은 하위 용도의 상한 및 하한과 통신사별 요구 사항을 제공합니다. 이를 사용해 메시지 샘플, 동의 및 기타 필수 신고 사항을 수집하세요. 이용 자격 목록만으로는 캠페인 등록에 필요한 정보를 모두 구성할 수 없습니다.

계정 요금 별도로 검토하기

공급자 필드인 monthlyFee, quarterlyFee 또는 annualFee 등이 반환되면 이러한 필드는 공급자 요금 메타데이터를 나타냅니다. 고객의 계정 요금이나 등록 조건을 대신하지는 않습니다. 현재 포털은 고객에게 적용되는 캠페인 요금을 별도로 읽고 이용 자격 데이터와 결합해 검토 화면에 표시합니다. 이전 열거형 도우미에 하드코딩된 요금으로 고객 청구액을 추정하지 마세요.

브랜드 또는 용도가 변경되면 새로 불러오기

브랜드를 전환할 때는 이전 브랜드의 선택 항목을 버리고 새로 선택한 브랜드의 이용 자격을 불러오세요. 제출하기 전에 선택한 용도의 요구 사항을 새로 불러오세요. 이러한 GET 요청은 등록을 제출하거나 캠페인을 활성화하거나 전화번호를 할당하지 않습니다.

요청

허용된 출발지 IP 주소에서 활성화된 API 계정을 사용해 HTTPS로 연결하세요. 현재 경로는 Basic 인증과 활성화된 베어러 토큰 방식의 API 계정을 포함한 계정 인증 정책을 지원합니다. 공급자 자격 증명을 사용하지 마세요.

URL 경로에 브랜드 식별자를 포함해 GET 요청을 보냅니다. 요청 본문은 필요하지 않습니다.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"
경로 매개변수
이름자료형필수 여부설명
brand_id문자열예인증된 MultiTEL 계정에 연결된 레지스트리 브랜드 ID입니다. 로컬 데이터베이스 행 ID, 캠페인 ID 또는 사업자 납세 번호가 아닌 브랜드 ID를 사용하세요. 하나의 URL 경로 세그먼트로 인코딩하세요.

응답

현재 TCR 경로는 레지스트리의 JSON 본문을 직접 반환하고 해당 HTTP 상태를 유지합니다. 기존 v3의 status/response 래퍼를 추가하지 않습니다. 축약된 가상 예시는 실제 이용 자격 조회 결과가 아닙니다. 사용하기 전에 HTTP 상태와 예상한 JSON 구조를 확인하세요. 현재 포털은 각 레코드가 usecase를 식별하는 이용 자격 레코드 목록을 예상합니다. 이러한 레코드를 usecase 카탈로그와 결합해 표시 이름을 가져오고 고객에게 적용되는 요금은 별도로 읽습니다. 추가 공급자 필드가 포함될 수 있습니다.

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

[
  {
    "usecase": "2FA"
  }
]

오류

  • 401: 계정 인증에 실패했습니다. API 자격 증명, 활성화 상태 및 적용되는 출발지 IP 제한을 확인하세요.
  • 404: 브랜드가 인증된 계정에 연결되어 있지 않거나 공급자가 요청한 브랜드 또는 선택 항목을 찾을 수 없습니다. 로컬 소유권 확인에서 거부되면 공급자에게 요청을 보내기 전에 거부 응답이 반환됩니다.
  • 기타 레지스트리 오류: 상위 시스템의 HTTP 상태와 본문이 유지됩니다. 유효하지 않거나 사용할 수 없는 용도를 요구 사항이 없는 정상 결과로 처리해서는 안 됩니다.
  • 429: 계정의 요청 한도 또는 공급자의 공유 요청 한도에 도달했습니다. Retry-After의 지시를 따르세요.
  • 502/503: 통신, 공급자 또는 요청 속도 제한 장치를 사용할 수 없는 상태입니다. 양식 입력을 유지하고 대기 시간을 늘려 가며 재시도하세요.

가용성 및 부수 효과

  • 검토된 GET 처리는 기존 브랜드의 소유권을 확인하고 레지스트리에 연결하며 요청 감사 기록을 작성합니다. 브랜드나 캠페인을 생성하거나 등록 수수료를 청구하지 않습니다.
  • 공급자 요금 메타데이터는 MultiTEL 고객에게 적용되는 요금 견적이 아닙니다. 포털은 이후 등록 요청을 보내기 전에 계정 요금을 별도로 검토합니다.
  • 이용 자격과 요구 사항은 변경될 수 있습니다. 제출하기 전에 선택한 브랜드와 용도에 대해 새로 불러오세요. 조회에 성공했다고 해서 캠페인이 승인되거나 전화번호가 할당되거나 메시지 발송을 시작할 권한이 부여되는 것은 아닙니다.