Method: projects.locations.apps.assistantSessions.cancelAssistantTurn

Cancela el turno en curso de la sesión del asistente, si lo hay: la detención explícita del usuario para un turno que se ejecuta de forma independiente de cualquier transmisión. Una cancelación que llega a una tarea que no aloja el turno lo interrumpe a través de la época del turno de la sesión, lo que lo finaliza dentro de una renovación de la asignación.

Solicitud HTTP

POST https://ces.googleapis.com/v1beta/{name=projects/*/locations/*/apps/*/assistantSessions/*}:cancelAssistantTurn

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

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es la sesión del asistente cuyo turno en curso se cancelará.

Cuerpo de la solicitud

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

Representación JSON
{
  "turnId": string
}
Campos
turnId

string

Es opcional. Es el turno que se cancelará. Si se deja vacío, se cancelará el turno que se esté ejecutando. Una cancelación que nombra un turno que ya no es el que se está ejecutando no tiene efecto.

Cuerpo de la respuesta

Respuesta para assistantSessions.cancelAssistantTurn.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "cancelled": boolean
}
Campos
cancelled

boolean

Indica si se encontró un turno en curso y se solicitó que se detuviera (directamente en esta tarea o a través de una interrupción de época para un turno alojado en otro lugar).

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso name:

  • ces.assistantSessions.get

Para obtener más información, consulta la documentación de IAM.