从代理向用户发送事件。
代理事件可用于表明代理已读了用户发送的消息,或代理正在输入内容(这为 RCS Business Messaging 体验增添了人性化元素)。如果用户未启用 RCS,RCS 商务平台会返回 NOT_FOUND (HTTP 404) 错误。如果用户已启用 RCS,但目前无法联系到,平台会返回 200 OK 响应,并根据事件类型处理消息传送。代理事件会在存储转发队列中排队,最长可排队 30 天,并在用户重新上线后立即传送。只有 IS_TYPING 事件是临时性的,不会排队。
与代理消息不同,代理事件在发送后无法撤消。
HTTP 请求
POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentEvents
网址采用 gRPC 转码语法。
路径参数
| 参数 | |
|---|---|
parent |
“phones/{E.164}”,其中 {E.164} 是用户的电话号码,采用 E.164 格式。例如,对于电话号码为 +1-222-333-4444 的美国用户,该值为 phones/+12223334444,生成的端点为 https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentEvents。 |
查询参数
| 参数 | |
|---|---|
eventId |
由代理分配的事件 ID。此值必须是 UUID,如 https://tools.ietf.org/html/rfc4122 中所定义。RCS Business Messaging 平台会忽略任何具有以下 ID 的代理消息:该 ID 曾被同一代理发送的较早消息或事件使用过。 |
agentId |
必需。代理的唯一标识符。 |
请求正文
请求正文包含一个 AgentEvent 实例。
响应正文
如果成功,响应正文将包含一个新创建的 AgentEvent 实例。
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/rcsbusinessmessaging
如需了解详情,请参阅 OAuth 2.0 Overview。