アカウントに登録済みのブランドを選択する
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 の顧客向け料金の見積もりではありません。ポータルでは、後続の登録リクエストを行う前に、アカウントの料金を別途確認します。
- 利用資格と要件は変更される場合があります。送信前に、選択したブランドとユースケースについて再取得してください。照会が成功しても、キャンペーンの承認、電話番号の割り当て、メッセージ送信開始の許可を意味するものではありません。