ブランドのキャンペーン要件を読み取る

ブランドとユースケースを一体として扱う

アカウント上のブランド 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 認証および有効化されたベアラー API アカウントを含む、アカウント認証ポリシーをサポートします。プロバイダーの認証情報は使用しないでください。

GET で、ブランド ID と選択したユースケース値を URL パスに含めて送信します。リクエストボディは不要です。

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 が選択したユースケースと一致するオブジェクトを想定しています。キャリアの要件は mnoMetadata の下にあり、キャリア ID をキーとしています。例のキャリア 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 の顧客向け小売見積もりではありません。ポータルは、後続の登録リクエストの前にアカウントの料金設定を別途確認します。
資格と要件は変更される場合があります。送信前に、選択したブランドとユースケースについてそれらを再取得してください。検索の成功は、キャンペーンの承認、番号の割り当て、またはメッセージング開始の許可ではありません。