Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1380629577.7 KB
projects

Creates a conversation. Note that this method does not support audio transcription or redaction. Use conversations.upload instead.

post/v1/{+parent}/conversations

Path parameters

parentstring required

Required. The parent resource of the conversation.

Query parameters

conversationIdstring

A unique ID for the new conversation. This ID will become the final component of the conversation's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression ^[a-z0-9-]{4,64}$. Valid characters are a-z-

Request body

dialogflowIntentsobject

Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}

ttlstring google-duration

Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.

namestring

Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}

startTimestring google-datetime

The time at which the conversation started.

updateTimestring google-datetime

Output only. The most recent time at which the conversation was updated.

agentIdstring

An opaque, user-specified string representing the human agent who handled the conversation.

createTimestring google-datetime

Output only. The time at which the conversation was created.

turnCountinteger

Output only. The number of turns in the conversation.

metadataJsonstring

Optional. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telephony systems and must be in one of Insight's supported formats.

medium'MEDIUM_UNSPECIFIED' | 'PHONE_CALL' | 'CHAT'

Immutable. The conversation medium.

durationstring google-duration

Output only. The duration of the conversation.

expireTimestring google-datetime

The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.

labelsobject

A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.

languageCodestring

A user-specified language code for the conversation.

obfuscatedUserIdstring

Obfuscated user ID which the customer sent to us.

Response

Successful response