projects

POST /v1/projects/{projectsId}/locations/{locationsId}/conversations

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

Request

  • Base URL
    https://contactcenterinsights.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

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

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.

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}

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.

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

Immutable. The conversation medium.

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.

namestring

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

obfuscatedUserIdstring

Obfuscated user ID which the customer sent to us.

satisfiesPziboolean

Output only. Whether this resource is zone isolated.

satisfiesPzsboolean

Output only. Whether this resource is zone separated.

startTimestring google-datetime

The time at which the conversation started.

ttlstring google-duration

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

turnCountinteger

Output only. The number of turns in the conversation.

updateTimestring google-datetime

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

Response

Successful response

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.

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}

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.

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

Immutable. The conversation medium.

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.

namestring

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

obfuscatedUserIdstring

Obfuscated user ID which the customer sent to us.

satisfiesPziboolean

Output only. Whether this resource is zone isolated.

satisfiesPzsboolean

Output only. Whether this resource is zone separated.

startTimestring google-datetime

The time at which the conversation started.

ttlstring google-duration

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

turnCountinteger

Output only. The number of turns in the conversation.

updateTimestring google-datetime

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

Changes

No recorded changes to this operation across all 6 revisions of this API.