TWtwilio
ConversationsV1ConversationWithParticipants

Create a new conversation with the list of participants in your account's default service

Changed on

Create a new conversation with the list of participants in your account's default service

post/v1/Services/{ChatServiceSid}/ConversationWithParticipants

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Services/{ChatServiceSid}/ConversationWithParticipants
  • Auth
    HTTP basic

Path parameters

ChatServiceSidstring required

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

Headers

X-Twilio-Webhook-Enabled'true' | 'false'

The X-Twilio-Webhook-Enabled HTTP request header

Request body application/x-www-form-urlencoded

FriendlyNamestring

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

UniqueNamestring

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.

DateCreatedstring date-time

The date that this resource was created.

DateUpdatedstring date-time

The date that this resource was last updated.

MessagingServiceSidstring

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

Attributesstring

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'initializing' | 'inactive' | 'active' | 'closed'

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

Timers.Inactivestring

ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.

Timers.Closedstring

ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.

Bindings.Email.Addressstring

The default email address that will be used when sending outbound emails in this conversation.

Bindings.Email.Namestring

The default name that will be used when sending outbound emails in this conversation.

Participantstring[]

The participant to be added to the conversation in JSON format. The JSON object attributes are as parameters in Participant Resource. The maximum number of participants that can be added in a single request is 10.

Response

Created

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'initializing' | 'inactive' | 'active' | 'closed'

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.

timersunknown
linksobject nullable

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

bindingsunknown
urlstring uri nullable

An absolute API resource URL for this conversation.

Changes

  • v17c6893e0ba68Revision changes
    • warning

      added the new initializing enum value to the response property for the response status

    • warning

      added the new initializing enum value to the response property for the response status

    • info

      added the new initializing enum value to the request property

  • v192d1169c37c2Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status