Method: users.availability.markAsDoNotDisturb

Marca al usuario como DO_NOT_DISTURB en Google Chat.

Establece el estado de disponibilidad de un usuario en DO_NOT_DISTURB hasta una hora de vencimiento especificada. Cuando está en DO_NOT_DISTURB, los usuarios no suelen recibir notificaciones.

Este método solo actualiza la disponibilidad del usuario autenticado.

Requiere la autenticación del usuario con el permiso de autorización:

  • https://www.googleapis.com/auth/chat.users.availability

Solicitud HTTP

POST https://chat.googleapis.com/v1/{name=users/*/availability}:markAsDoNotDisturb

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. El nombre del recurso de la disponibilidad que se marcará como No molestar. Formato: users/{user}/availability

{user} es el ID de la persona en la API de People o la API de Directory del SDK de Admin. Por ejemplo, users/123456789.

La dirección de correo electrónico del usuario o me también se pueden usar como alias para hacer referencia a la persona que llama. Por ejemplo, users/user@example.com o users/me.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{

  "expireTime": string,
  "ttl": string
}
Campos
Campo de unión expiration. Obligatorio. El vencimiento del estado de disponibilidad de DND. El usuario se marcará como Ausente después del vencimiento. Esto puede ser como máximo 1 año a partir de la hora actual. expiration puede ser solo uno de los parámetros siguientes:
expireTime

string (Timestamp format)

La marca de tiempo absoluta cuando vence el estado de DND.
ttl

string (Duration format)

La duración desde la hora actual hasta que vence el estado de DND.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Availability.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/chat.users.availability

Para obtener más información, consulta la guía de autorización.