MultiTEL
開発者

DELETE/tcr/v2/campaign/{campaignId}

メッセージングキャンペーンを無効化する

キャンペーンの利用を終了し、番号の割り当てを照合・整理して、本文が空の成功レスポンスの意味を理解します。

このページの内容
  1. 既存のメッセージングキャンペーンを無効化する
  2. 対象番号の割り当てを先に解除する
  3. 対象キャンペーンの無効化リクエストを送信する
  4. 登録状態と割り当ての両方を確認する
  5. 利用終了とアカウントの精算は別の処理

既存のメッセージングキャンペーンを無効化する

アカウントが所有するキャンペーンの利用を終了する場合は、このルートを使用します。照合と履歴管理のため、キャンペーンIDを保管してください。内容の修正や同意文の更新には、代わりに「メッセージングキャンペーンを更新する」を使用してください。

許可された送信元IPアドレスから、有効なAPIアカウントを使用してHTTPS経由で認証してください。まずキャンペーンを取得し、関連するブランドと送信番号を確認します。無効化によって登録内容は変更されますが、代わりのキャンペーンが作成されたり、番号が別のキャンペーンに移動されたりすることはありません。

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

対象番号の割り当てを先に解除する

公開されているキャンペーンのDELETEでは、メッセージング事業者側の電話番号の関連付けも、ローカルの割り当ても解除されません。アカウントが所有する各対象番号に対して「番号とキャンペーンの割り当てを解除するワークフロー」を実行し、その後で割り当て状態を確認してください。割り当てを解除しても、電話番号自体は解約されません。

ポータルの「ブランドを削除」ワークフローは、より広い範囲を対象とし、ブランドを削除する前に、そのキャンペーンと番号の関連付けを整理します。ブランドとそのほかのキャンペーンを残す場合は、この操作を使用しないでください。現在の通常のキャンペーン編集画面には、このAPIルートの直接呼び出しに相当する独立したキャンペーン削除ボタンはありません。

対象キャンペーンの無効化リクエストを送信する

キャンペーンIDと影響を受ける送信設定を確認したら、JSON本文を付けずにDELETEを送信します：

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

ドキュメントに記載されている成功レスポンスは、本文が空のHTTP 204です。JSONのstatus/responseエンベロープを期待するのではなく、HTTPステータスを確認してください。削除が受理されると、現在のサービスはローカルのキャンペーンリソースを削除済みかつ期限切れとしてマークし、従来のキャンペーンレコードも期限切れとしてマークします。ブランドが連鎖的に削除されることはありません。

この無効化リクエストには同じ冪等性キーを使用し、再送に備えてメソッド、パス、クエリ、本文のバイト列を正確に保持してください。処理中のリクエストと重複した場合は、Retry-Afterを伴う409が返ることがあります。完了したリクエストでは、保存済みの結果が再び返されることがあります。キャッシュされたエラーや接続の中断だけでは、レジストリがすでに処理を実行したかどうかは判断できません。キャンペーンIDと、存在する場合はrequestIdを保管してください。

登録状態と割り当ての両方を確認する

リクエスト後、ポータルでキャンペーンの現在の状態と対象番号を確認してください。APIは利用終了後もローカルの所有権メタデータを保持する場合があるため、所有する識別子を引き続き照会できることがあります。同じIDに対してローカルで必ず404が返るとは考えないでください。利用終了したレコードについて返されるステータスや、そのレコードを取得できるかどうかは、レジストリが決定します。

番号の割り当てが残っている場合は、その既存の割り当てを照合して整理してください。無効化を再試行するためだけに別のキャンペーンを作成したり、HTTP 204が事業者側の関連付けの解除を証明すると考えたりしないでください。レジストリがリクエストを受理した後にローカル同期が失敗すると、外部での無効化がすでに完了していても、APIは500を返すことがあります。

無効化の結果
結果次の対応
204レスポンス本文はありません。キャンペーンの状態と、それとは独立して管理される番号の割り当てを確認してください。
400返された検証エラーまたはレジストリの状態に関するエラーを確認してください。キャンペーンIDが正確であることと、現在の状態を確認します。
401, 403, 404APIの認証情報、許可された送信元IPアドレス、アカウントの所有権を確認してください。ほかの顧客のIDで代用しないでください。
409, 429処理中または競合している冪等リクエストと、レート制限を区別してください。Retry-Afterが返された場合は、その指定に従ってください。
500、502、またはタイムアウトリクエストの詳細を保管し、再送する前に既存のキャンペーンを取得して状態を照合・整理してください。

利用終了とアカウントの精算は別の処理

現在のDELETEサービスは、キャンペーン登録料の即時引き落とし処理を実行しません。これは返金を約束するものではなく、既存の契約上の義務を取り消したり、レンタル番号を解約したりするものでもありません。ポータルで、アカウントに適用されるキャンペーンの契約条件と未払いの請求書を確認してください。番号のレンタル料とメッセージ利用料は、キャンペーン登録料とは別です。

キャンペーンと割り当ての照合・整理が済んだ後に、事業者登録全体の利用を終了する場合は、「ブランドの利用終了」に進んでください。