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 となります。

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` 必須。エージェントの一意の識別子。

agentId

string

必須。エージェントの一意の識別子。

リクエスト本文

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

レスポンスの本文

成功すると、レスポンスの本文は空になります。

認可スコープ

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

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

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