アカウントが所有するメッセージング用ブランドを使用する
許可された送信元IPから、有効なAPIアカウントを使用してHTTPSで接続してください。Basic認証とBearer認証に対応しています。ブランドIDは、そのアカウントに属している必要があります。事業者のトークン、ブランドの識別情報、返されたレポートは非公開で管理してください。
新たな外部審査を申し込む
審査事業者にこのブランドの新たな審査を依頼する場合は、POSTを使用してください。事業者による結果をすでに取得している場合は、インポートを代わりに使用してください。この操作は、ブランドの識別情報の再確認とは別です。
まず現在のブランド情報を取得し、その識別情報を確認してください。次の最新のカタログから、対応している事業者と審査クラスを選び、その事業者の要件を確認してください。すべての事業者がすべてのクラスに対応しているわけではありません。政治関連の審査に必要な追加情報には、サンプルデータではなく、実際の組織またはキャンペーンについて記載する必要があります。
事業者へのリクエストを準備する
| 項目 | 値 |
|---|---|
| evpId | 最新の外部審査事業者カタログに記載された事業者ID。必須で、長さは1–10文字です。 |
| vettingClass | 購入する予定の、対応している審査クラス。明示的に選択し、その料金を確認してください。 |
| additionalRequestPayload | 事業者固有の詳細情報を含む、JSONでエンコードされた文字列です。政治関連の審査では必須です。外側のJSONオブジェクト内に格納する文字列であり、ネストしたオブジェクトではありません。必要な詳細情報をすべて、選択した事業者に確認してください。 |
成功時と失敗時の料金を確認する
十月24日（2026年）に確認した、米ドル建ての現行小売料金です。実際に申し込む前に、最新の金額を確認してください。前払い残高は成功時の料金を基準に確認されます。購入が有効になっている必要があります。
| 審査クラス | 有効という結果 | 失敗という結果 |
|---|---|---|
| STANDARD | $46.12 | $5.56 |
| ENHANCED | $112.78 | $6.67 |
| POLITICAL | $73.34 | $24.45 |
| POLITICAL（Expressリクエスト付き） | $106.67 | $24.45 |
| AUTHPLUS | $13.89 | $13.89 |
| RCS | $83.34 | $83.34 |
保留中の申込では、成功時と失敗時の料金が保持され、ACTIVEまたはFAILEDの結果が同期された時点で精算されます。表の最後の二つのクラスでは、どちらの最終結果でも同じ設定料金が適用されます。最終結果が即座に返される場合は、申込への応答時に課金されることがあります。後で行われるステータス同期によって、保留中の料金が精算されることもあります。
mock:trueを、外部審査が無料になる保証として扱わないでください。 現在の外部審査の精算処理では、その申込が記録され、課金される可能性があります。この手順では、テストのために実際の購入を行う必要はありません。有料審査を承認する意思がある場合を除き、オフラインのテスト用データを使用してください。
内容を確認した申込を一件送信する
事業者ID、審査クラス、必要な追加情報を含むvetting-order.jsonを用意してください。このファイルには、実際に送信する予定のリクエストを記載します。非公開で管理してください。
curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
--request POST \
--header 'Content-Type: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--data-binary @vetting-order.json \
"https://api.multitel.net/tcr/v2/brand/$BRAND_ID/externalVetting"実際の結果を追跡する
成功したHTTP応答に、保留中の審査レコードが含まれることがあります。そのvettingIdを保存し、vettingStatus、理由、スコア、有効開始日と有効期限を、取得できる範囲で確認してください。PENDINGとUNSCOREでは、引き続き状況の確認が必要です。ACTIVE、FAILED、EXPIREDは、それぞれ異なる結果を示します。HTTPでリクエストが受け付けられただけでは、良好なスコアやキャンペーンの利用資格が証明されたことにはなりません。
レコードを追跡するには、外部審査のステータスを使用してください。最終結果を取得またはインポートすると、以前の有料申込が精算されることがあります。既存の未払い料金が請求されないとは限りません。
同じ内容のリクエストを再試行する
実行する各操作に対して一つのIdempotency-Keyを使用し、メソッド、パス、クエリ、本文のバイト列を完全に同じ状態で保持してください。キーには、空白を含まない印字可能なASCII文字を1–128文字使用できます。処理中のリクエストと重複する場合は、Retry-After付きの409が返されることがあります。完了したリクエストでは、エラーも含めて、保存済みの応答が再送されます。レート制限を守ってください。
通信障害の後に、キャッシュされた502が返されることがあります。requestIdを伴うキャッシュされた500は、レジストリが操作を受け付けたものの、ローカルでの永続保存または課金に失敗したことを意味する場合があります。新しいキーを使用する前に、リクエストIDを保存し、現在のレコードを確認して、サポートと照合・調整してください。エラーが返されたからといって、申込が存在しないと判断しないでください。