Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1410161228.2 KB

Fetch a conversation from your account's default service

get/v1/Conversations/{Sid}

Path parameters

Sidstring required

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

Response

OK

account_sidstring nullable

The unique ID of the Account responsible for this conversation.

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.

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

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

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.

friendly_namestring nullable

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

linksobject nullable

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

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.

state'inactive' | 'active' | 'closed'
{"stackTrail":"components:schemas:conversations.v1.conversation:properties:timers","oasType":"schema","type":"unknown","description":"Timer date values representing state update for this conversation.","nullable":true}
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.

urlstring uri nullable

An absolute API resource URL for this conversation.