Conversation Service

Our Conversation Service API comprehensively manages the entire lifecycle of conversations—enabling creation, updates (audio persistence, display name, language, sharing, skill, state, and metadata), retrieval, redaction or deletion of messages, tagging, event logging, batch operations, and final closure—providing robust end-to-end conversation management.

Languages
Servers
https://{api-domain}.cresta.com/

ConversationService

Operations

UpdateConversationDisplayName updates the display name for this conversation.

Request

If the Conversation does not exist, it returns a NOT_FOUND (404) error.

Path
conversationstringrequired

Resource name of the Conversation.

Format: customers/{customer_id}/profiles/{profile_id}/conversations/{conversation_id}

Bodyapplication/jsonrequired
displayNamestringrequired

The display name of the Conversation.

curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{conversation}:updateDisplayName' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "string"
  }'

Responses

A successful response.

Bodyapplication/json
object(conversationUpdateConversationDisplayNameResponse)

Response of [ConversationService.UpdateConversationDisplayName][].

Response
application/json
{}

UpdateConversationLanguage updates the language code for this Conversation.

Request

If the Conversation does not exist, it returns a NOT_FOUND (404) error.

Path
conversationstringrequired

Resource name of the Conversation.

Format: customers/{customer_id}/profiles/{profile_id}/conversations/{conversation_id}

Bodyapplication/jsonrequired
languageCodestringrequired

The language code for this Conversation.

It must be a valid IETF BCP-47 language codes, such as en-US or de-CH. It must be in the list of supported languages of the parent Profile. Cresta falls back to the Profile's default language if the conditions are not met.

curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{conversation}:updateLanguageCode' \
  -H 'Content-Type: application/json' \
  -d '{
    "languageCode": "string"
  }'

Responses

A successful response.

Bodyapplication/json
languageCodestring

The effective language code for the Conversation. It may be different from the language_code in the request if the requirements are not met.

Response
application/json
{ "languageCode": "string" }

UpdateConversationSharingState updates the sharing state of a Conversation.

Request

If the Conversation does not exist, it returns a NOT_FOUND (404) error. If the conversation exists, but the source does not support the operation, it will throw FAILED_PRECONDITION error (HTTP status code 400)

Path
conversationstringrequired

Resource name of the Conversation.

Format: customers/{customer_id}/profiles/{profile_id}/conversations/{conversation_id}

Bodyapplication/jsonrequired
sharingStatestring(ConversationSharingState)

Conversation Sharing State.

  • SHARING_STATE_UNSPECIFIED: Default value. All conversations will be created with this sharing state value.
  • SHARING_STATE_SHARED: This conversation is shared with all managers. Conversation of OPERA_SYNTHETIC source can be changed to shared state.
Default "SHARING_STATE_UNSPECIFIED"
Enum"SHARING_STATE_UNSPECIFIED""SHARING_STATE_SHARED"
curl -i -X POST \
  'https://{api-domain}.cresta.com/v1/{conversation}:updateSharingState' \
  -H 'Content-Type: application/json' \
  -d '{
    "sharingState": "SHARING_STATE_UNSPECIFIED"
  }'

Responses

A successful response.

Bodyapplication/json
object(conversationUpdateConversationSharingStateResponse)

Response of [ConversationService.UpdateConversationSharingState][].

Response
application/json
{}