Method: projects.conversations.complete

Completes the specified conversation. Finished conversations are purged from the database after 30 days.

HTTP request

POST https://{endpoint}/v2/{name=projects/*/conversations/*}:complete

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource identifier of the conversation to close. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>.

Authorization requires the following IAM permission on the specified resource name:

  • dialogflow.conversations.complete

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Conversation.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.