v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-0510371832.3 KB

ConversationsV1Conversation

Fetch a conversation from your service

get/v1/Services/{ChatServiceSid}/Conversations/{Sid}

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service the Conversation resource is associated with.

Sidstring required

A 34 character string that uniquely identifies this resource. Can also be the unique_name of the Conversation.

Response

account_sidstring nullable

The unique ID of the Account responsible for this conversation.

chat_service_sidstring nullable

The unique ID of the Conversation Service this conversation belongs to.

messaging_service_sidstring nullable

The unique ID of the Messaging Service this conversation belongs to.

sidstring nullable

A 34 character string that uniquely identifies this resource.

friendly_namestring nullable

The human-readable name of this conversation, limited to 256 characters. Optional.

unique_namestring nullable

An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid in the URL.

attributesstring nullable

An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

state'inactive' | 'active' | 'closed' | 'initializing'

Current state of this conversation. Can be either initializing, active, inactive or closed and defaults to active

date_createdstring date-time nullable

The date that this resource was created.

date_updatedstring date-time nullable

The date that this resource was last updated.

{"stackTrail":"components:schemas:conversations.v1.service.service_conversation:properties:timers","oasType":"schema","type":"unknown","description":"Timer date values representing state update for this conversation.","nullable":true}

urlstring uri nullable

An absolute API resource URL for this conversation.

linksobject nullable

Contains absolute URLs to access the participants, messages and webhooks of this conversation.

{"stackTrail":"components:schemas:conversations.v1.service.service_conversation:properties:bindings","oasType":"schema","type":"unknown","nullable":true}