開発者

POST/tcr/v2/brand/nonBlocking

メッセージングブランドを登録する

アカウント所有の事業者アイデンティティを登録し、サンドボックスリクエストを明示し、検証と料金を突き合わせます。

このページの内容
  1. メッセージの背後にある事業者を登録する
  2. 明示的なサンドボックスリクエストから始める
  3. 事業者情報と連絡先のフィールド
  4. 安定したべき等性キーを維持する
  5. ブランドとそのステータスを読み取る
  6. 本番料金
  7. ブランドを重複させずにエラーを処理する

メッセージの背後にある事業者を登録する

メッセージングブランドは、米国向け10DLCメッセージを送信する事業者を識別します。キャンペーンのユースケースを選択する前にブランドを登録してください。事業者の正式な情報と、必要な検証を完了できる連絡先を使用してください。返されたブランドIDは、それだけではメッセージ送信の承認を意味しません。

有効なAPIアカウントと許可された送信元IPアドレスを使用して、HTTPS経由で現行のアカウント所有型ルートを使用してください。user_id、username、または他の顧客の所有者識別子を送信しないでください。MultiTELは認証済みアカウントから所有権を記録します。

明示的なサンドボックスリクエストから始める

ポータルのフォームでは、modeフィールドが既定でサンドボックスに設定されています。モックブランドを意図する場合は、直接のAPIリクエストにJSON真偽値mock: trueを明示的に含める必要があります。このフラグを省略してもサンドボックスは保証されず、課金対象の本番登録が作成される可能性があります。ポータルのmodeフィールドは、APIのmockフィールドの代わりにはなりません。

以下のフィールドを使用してローカルのbrand.jsonファイルを準備してください。プレースホルダーを適切なテスト内容と最新のカタログコードに置き換えてください。この例は私営営利事業者であり、他の事業体種別では要件が異なります。

{
  "entityType": "PRIVATE_PROFIT",
  "displayName": "Example business",
  "companyName": "Example legal business name",
  "ein": "YOUR_TAX_ID",
  "einIssuingCountry": "US",
  "phone": "+12025550123",
  "street": "123 Example Street",
  "city": "Example City",
  "state": "NY",
  "postalCode": "10001",
  "country": "US",
  "email": "contact@example.invalid",
  "brandRelationship": "BASIC_ACCOUNT",
  "vertical": "CURRENT_VERTICAL_CODE",
  "referenceId": "your-business-reference",
  "mock": true
}

上記の事業者名、住所、電話番号、識別子はプレースホルダーであり、登録可能な事業者アイデンティティではありません。entityType、vertical、country、state、brandRelationshipやその他の列挙値の最新値については、次のカタログを参照してください:メッセージングカタログ。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --header 'Content-Type: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --data-binary @brand.json \
  'https://api.multitel.net/tcr/v2/brand/nonBlocking'

事業者情報と連絡先のフィールド

ブランド登録フィールド
フィールド入力内容
entityType, displayName現行の事業体種別コードと認識可能なブランド名です。最大長はそれぞれ20文字と255文字です。
country, street, city, state, postalCode実際の事業者住所です。二文字の国コードと、該当する場合は現行の米国stateコードを使用してください。制限:streetは255文字、cityは100文字、stateは20文字、postalCodeは10文字です。
email, phone有効な連絡先メールアドレス(最大100文字)と、国際形式(+国コード付き)の電話番号(最大20文字)です。登録全体で事業者情報を一貫させてください。
companyName, ein, einIssuingCountry法人の場合は、正式な会社名と事業者納税識別番号を入力してください。識別番号の発行国は別の二文字フィールドです。制限:companyNameは255文字、einは21文字です。個人事業主は、法人の納税者情報の代わりに個人名フィールドを使用します。
brandRelationship, vertical現行のカタログコードを使用した、事業者との関係および業種です。法人ではこれらが必須ですが、個人事業主の規則は異なります。APIコードの代わりに翻訳された表示ラベルを使用しないでください。
firstName, lastName, mobilePhone個人事業主の場合は必須です。氏名フィールドはそれぞれ最大100文字です。必須のOTP検証のため、対象となる携帯番号を国際形式で入力してください。
stockSymbol, stockExchange, website, businessContactEmail上場会社では、株式銘柄・取引所、website、および追加の検証手続きのための対象となる事業者連絡先メールアドレスも必要です。制限:stockSymbolは10文字、websiteは255文字、businessContactEmailは255文字です。
altBusinessIdType, altBusinessId任意の代替事業者識別子です。種別と値をセットで入力してください。現行の種別カタログを使用し、値は最大50文字です。
referenceId事業者参照情報(最大50文字)です。現行の事業体種別ごとの要件に基づき、個人事業主の登録ではこれを含めてください。これは事業者メタデータであり、リクエストのべき等性キーではありません。
website, ipAddress, tag該当する場合は、追加のウェブサイト、発信元IPメタデータ、タグ値を入力します。これらはアカウントの所有権を証明するものではなく、本人確認の代わりにもなりません。
mockJSON真偽値です。意図したモックのワークフローにのみtrueを使用し、明示的に確認した本番登録にはfalseを使用してください。JSON真偽値の代わりに文字列「false」を送信しないでください。

個人事業主は米国またはカナダの登録でサポートされ、キャンペーン対象となる前にOTP検証が必要です。上場会社では事業者連絡先の検証手順が必要になる場合があります。GOVERNMENTは米国所在の政府機関向けです。その他の法人については正しい事業体区分を確認してください。事業体種別ごとの要件と、返された検証エラーの両方に従ってください。

安定したべき等性キーを維持する

この登録意図に対してIdempotency-Keyを一つ生成してください。キーはスペースを含まない1–128文字の印字可能なASCII文字で構成する必要があります。同じキーは、同じHTTPメソッド、パス、クエリ文字列、および正確に同一のリクエストボディバイトとの組み合わせでのみ再利用してください。意味を変更しないJSONの再整形であっても、リクエストのフィンガープリントは変わります。

完了済みのキー付きリクエストは、登録を再送信することなく保存された応答を再生できます。処理中の重複リクエストはHTTP 409を返し、Retry-Afterを含む場合があります。同じキーでリクエスト内容を変更すると競合します。リクエストがタイムアウトした、またはエラーを返したという理由だけで新しいキーを生成しないでください。事業者が既に登録されている可能性があります。

そのリクエストを解決する間はbrand.jsonを変更しないでください。キャッシュされた500または502は、登録を再試行するのではなく元のエラーを再生する場合があります。返されたbrandId、requestId、相関ヘッダーを保持し、別のリクエストを開始する前に既存のブランドの実際の状態を確認し、不整合があれば解消してください。

ブランドとそのステータスを読み取る

このAPIは、v3のstatus/responseエンベロープではなく、HTTPステータスコードと直接のJSONボディを使用します。登録に成功するとbrandIdを含むブランドオブジェクトが返されます。その識別子を保存し、返された検証ステータスまたはアイデンティティステータスを確認してください。追加フィールドは事業体と登録状態によって異なります。

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/brand/$BRAND_ID"

ご自身のアカウントに属するブランドのみを読み取ってください。404は、そのブランドがこのアカウントでは利用できないことを意味する場合があります。必要な検証を完了してから、ブランド認定を使って、利用可能なキャンペーンのユースケースを確認してください。モックリソースが本番送信に利用可能であると想定しないでください。

本番料金

現行の設定済みブランド登録料金
登録料金
標準法人$5.00
個人事業主$4.45
モックブランドモックのワークフローではブランド登録の課金なし

これらの小売金額は十月24日(2026年)時点の現行ポータル設定と照合されています。本番登録の前にポータルで現行料金を確認してください。キャンペーン料金、追加審査、メッセージ利用料は別途です。本番登録では送信前に購入権限と利用可能な資金を確認します。レジストリ内でのブランド作成の成功とローカル課金は別々の処理手順であるため、エラーや課金問題が発生した場合はリソースIDを保持し、取引を突き合わせてください。

モックブランドから本番への変更は別途確認が必要なワークフローであり、新しい本番アイデンティティと課金が発生する場合があります。後のリクエストでmockをfalseに編集すれば既存のブランドが変換されると想定しないでください。

ブランドを重複させずにエラーを処理する

登録エラー
HTTP結果確認事項
400フィールドエラーを確認してください。レジストリの検証エラーはcode/descriptionオブジェクトの配列の場合があります。ローカルのべき等性キー検証でも400が返される場合があります。
401、403または404API認証情報、APIアカウントの許可された送信元IP、顧客権限、所有権を確認してください。レジストリの応答が独自の認可エラーを含む場合もあります。
402資金と購入権限を確認してください。資金不足の本番リクエストをサンドボックステストとして扱わないでください。
409処理中のリクエストを待つ間は、同じキーと変更されていないリクエストを維持してください。本文・キーを変更した競合や、回復不能な以前の応答がある場合は、先に実際のリクエスト状態を確認し、不整合があれば解消する必要があります。
429またはリミッター利用不可の応答Retry-Afterが存在する場合はそれを尊重してください。制限が解除されたら、同じ意図のリクエストとキーで再試行してください。
500または502リモート操作は受け付けられている可能性があります。ローカル処理エラーにはrequestIdが含まれる場合があります。それを保存して既存のリソースを確認し、代替の登録が必要であると想定しないでください。