브랜드의 캠페인 요구 사항 읽기

브랜드와 사용 사례를 함께 유지

계정에 있는 브랜드 ID와 같은 브랜드의 자격 목록에서 반환된 사용 사례 값을 사용하십시오. 고객 워크플로는 제공업체 요청 전에 소유권을 확인합니다. 반환된 객체의 usecase 값이 선택한 값과 일치하는지 확인하십시오. 한 브랜드 또는 사용 사례에 대한 조회는 다른 브랜드 또는 사용 사례의 요구 사항을 확정하지 않습니다.

현재 요구 사항 읽기

현재 캠페인 양식에서 사용하는 요구 사항
필드	포털의 사용 방식
minSubUsecases / maxSubUsecases	이 선택에 대한 하위 사용 사례의 최소 및 최대 개수입니다. 자유 텍스트가 아니라 유효한 하위 사용 사례 카탈로그에서 값을 선택하십시오.
mnoMetadata	이동통신사 ID를 키로 하는 이동통신사별 요구 사항입니다. 이동통신사 선택에는 현재 응답에 있는 ID를 사용하십시오.
mnoSupport / qualify	이동통신사 지원 및 자격입니다. 포털은 두 필드 중 하나라도 명시적으로 false로 표시된 이동통신사를 제외하며, 적격한 선택 이동통신사가 적어도 하나 있어야 합니다.
minMsgSamples	이동통신사에 필요한 샘플 수입니다. 포털은 비어 있지 않은 샘플을 적어도 하나 요구하며, 적격한 선택 이동통신사 중 가장 높은 최소값을 충족합니다.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	필수 가입자 선언입니다. 필수인 경우 해당 선언은 true여야 합니다. 활성화된 선언에는 키워드 및 응답 메시지 필드도 필요합니다.
noEmbeddedLink / noEmbeddedPhone	포함된 링크 또는 전화번호에 대한 제한입니다. 적격한 선택 이동통신사가 금지하는 경우 포털은 선언된 기능을 거부합니다.

선택한 이동통신사의 요구 사항을 함께 적용

이동통신사 요구 사항은 서로 다를 수 있습니다. 명시적인 이동통신사 목록이 제공되지 않으면 포털은 응답에 있는 모든 이동통신사 메타데이터를 고려하며, 비어 있지 않은 목록은 검사를 선택된 해당 ID로 제한합니다. 첫 번째 이동통신사의 샘플 수나 선언만 사용하지 마십시오. 응답에서 이동통신사를 선택하고, 지원 및 자격을 확인하고, 적용 가능한 가장 높은 샘플 최소값을 충족하고, 해당 선택 전체에 걸쳐 필수 옵트인, 옵트아웃 및 도움말 선언을 충족하십시오. 포털은 현재 응답에 없는 선택된 이동통신사 ID를 거부하며, 적격한 이동통신사가 없는 선택을 거부합니다.

요구 사항은 제공해야 하는 내용을 설명할 뿐, 고객의 동의 절차나 캠페인 콘텐츠가 그 요구 사항을 충족한다는 것을 증명하지는 않습니다. 진실하고 대표성 있는 샘플과 선언을 수집하십시오. 양식을 통과시키기 위해 선언을 자동으로 켜지 마십시오.

샘플 및 가입자 응답 준비

현재 캠페인 양식은 메시지 샘플에 sample1부터 sample5까지를 사용합니다. 사용 가능한 양식 내에서 요구 사항을 충족할 수 없으면 중단하고 지원팀과 함께 선택을 해결하십시오. 활성화된 가입자 선언에 대해서는 해당 키워드와 응답 텍스트를 제공하십시오: optinKeywords/optinMessage, optoutKeywords/optoutMessage 및 helpKeywords/helpMessage. 샘플은 선택한 사용 사례 및 실제 고객 메시징과 일관되게 유지하십시오.

등록 요청 전에 검토

브랜드, 사용 사례 또는 이동통신사 선택이 변경되면 요구 사항을 새로 고치십시오. 포털은 생성 전에 선택한 사용 사례, 하위 사용 사례 수, 이동통신사 적격성, 샘플 및 선언을 다시 검증합니다. 계정 요금 및 등록 약관은 별도로 검토하십시오. 이 GET 요청은 캠페인을 등록하거나 승인하지 않으며, 메시징 이동통신사와 공유하거나 전화번호를 할당하지도 않습니다. 생성과 프로비저닝은 별도의 작업입니다.

실패한 요구 사항 조회 처리

요청이 실패하거나, 예상치 못한 JSON을 반환하거나, 선택한 사용 사례와 일치하지 않으면 양식을 미완료 상태로 유지하고 오류가 해결된 후 고객이 다시 시도하도록 하십시오. 사용할 수 없는 요구 사항을 빈 객체로 대체하거나, 데이터가 없다는 것이 요구 사항이 없다는 의미라고 가정하지 마십시오. Retry-After 헤더를 준수하고 속도 제한 및 가용성 장애에는 백오프를 사용하십시오.

요청

허용된 원본 IP 주소에서 HTTPS를 통해 활성화된 API 계정을 사용하십시오. 현재 경로는 Basic 인증과 활성화된 bearer API 계정을 포함한 계정 인증 정책을 지원합니다. 제공업체 자격 증명을 사용하지 마십시오.

URL 경로에 브랜드 ID와 선택한 사용 사례 값을 넣어 GET 요청을 보냅니다. 요청 본문은 필요하지 않습니다.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

경로 매개변수
이름	유형	필수	설명
`brand_id`	string	예	인증된 MultiTEL 계정에 연결된 레지스트리 브랜드 ID입니다. 로컬 데이터베이스 행 ID, 캠페인 ID 또는 사업자 세금 번호가 아니라 브랜드 ID를 사용하십시오. 하나의 URL 경로 세그먼트로 인코딩하십시오.
`usecase`	string	예	같은 브랜드의 자격 목록에서 선택한 기계 판독 가능 usecase 값입니다. 대소문자를 유지하고, 번역된 표시 레이블을 보내지 마십시오. 하나의 URL 경로 세그먼트로 인코딩하십시오.

응답

현재 TCR 경로는 레지스트리 JSON 본문을 직접 반환하고 해당 HTTP 상태를 유지합니다. 레거시 v3 status/response 엔벨로프를 추가하지 않습니다. 축약된 가상의 예시는 실제 자격 결과가 아닙니다. 사용하기 전에 HTTP 상태와 예상되는 JSON 형태를 확인하십시오. 포털은 usecase 값이 선택한 사용 사례와 일치하는 객체를 기대합니다. 이동통신사 요구 사항은 이동통신사 ID를 키로 하여 mnoMetadata 아래에 있습니다. 예시의 이동통신사 ID와 요구 사항은 가상입니다. 다른 제공업체 필드가 반환될 수 있습니다.

예시 응답 형태이며, 실제 계정 데이터나 현재 견적이 아닙니다.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

오류

401: 계정 인증에 실패했습니다. API 자격 증명, 활성화 상태 및 적용되는 원본 IP 제한을 확인하십시오.
404: 브랜드가 인증된 계정에 연결되어 있지 않거나, 제공업체가 요청된 브랜드 또는 선택 항목을 찾을 수 없습니다. 로컬 소유권 거부는 제공업체 요청 전에 반환됩니다.
기타 레지스트리 오류: 업스트림 HTTP 상태와 본문이 유지됩니다. 유효하지 않거나 사용할 수 없는 사용 사례는 성공적인 빈 요구 사항 집합이 아닙니다.
429: 계정 또는 공유 제공업체 요청 한도에 도달했습니다. Retry-After를 준수하십시오.
502/503: 전송, 제공업체 또는 속도 제한기 가용성 장애입니다. 양식을 보존하고 백오프로 다시 시도하십시오.

가용성 및 부작용

검토된 GET 요청은 기존 브랜드 소유권을 확인하고, 레지스트리에 연결하며, 요청 감사 기록을 기록합니다. 브랜드나 캠페인을 생성하거나 등록 수수료를 청구하지 않습니다.
제공업체 수수료 메타데이터는 MultiTEL 고객 소매 견적이 아닙니다. 포털은 이후 등록 요청 전에 계정 요금을 별도로 검토합니다.
자격 및 요구 사항은 변경될 수 있습니다. 제출 전에 선택한 브랜드 및 사용 사례에 대해 새로 고치십시오. 성공적인 조회는 캠페인 승인, 번호 할당 또는 메시징 시작 권한이 아닙니다.