Method: phones.agentMessages.delete

送信済みだが未配信のエージェント メッセージを取り消します。

RBM プラットフォームがメッセージを取り消した場合、メッセージはユーザーのメッセージ キューから削除され、配信されることはありません。

このメソッドは、メッセージが正常に取り消されたかどうかにかかわらず、すぐに 200 OK を返します。

RBM プラットフォームがメッセージを配信している間、エージェントが取り消しを開始する可能性がわずかにあります。このようなまれなケースでは、取り消しリクエストを開始した直後にエージェントがメッセージに対する 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 をご覧ください。