Method: phones.agentMessages.delete

送信済みでまだ配信されていないエージェント メッセージを取り消します。

RCS for Business プラットフォームがメッセージの取り消しに成功すると、メッセージはユーザーのメッセージ キューから削除され、配信されることはありません（200 OK）。

404 Not Found レスポンスは、メッセージが配信されたため、取り消し試行が失敗したことを意味します。

RCS for Business プラットフォームがメッセージを配信している間に、エージェントが取り消しを開始する可能性はわずかですがあります。このようなまれなケースでは、エージェントは取り消しリクエストの開始直後に、メッセージの DELIVERED ユーザー イベントを受け取ります。

HTTP リクエスト

DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

「phones/{E.164}/agentMessages/{messageId}」。{E.164} は E.164 形式のユーザーの電話番号、{messageId} は取り消すエージェント メッセージのエージェント割り当て ID です。たとえば、米国の電話番号 +1-222-333-4444 と ID「12345xyz」のエージェント メッセージの場合、結果のエンドポイントは https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz になります。

クエリ パラメータ

パラメータ
agentId

string

必須。エージェントの固有識別子。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文は空の JSON オブジェクトになります。

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/rcsbusinessmessaging

詳細については、OAuth 2.0 Overview をご覧ください。