POST /v1/Services/{ChatServiceSid}/Conversations

Create a new conversation in your service

Servers

Path parameters

Name Type Required Description
ChatServiceSid String Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

X-Twilio-Webhook-Enabled String No

The X-Twilio-Webhook-Enabled HTTP request header

Possible values:

  • "false"
  • "true"

Request body fields

Name Type Required Description
UniqueName String No

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.

State String No

Possible values:

  • "inactive"
  • "active"
  • "closed"
Attributes String No

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.

FriendlyName String No

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

DateUpdated String No

The date that this resource was last updated.

Timers.Inactive String No

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

DateCreated String No

The date that this resource was created.

MessagingServiceSid String No

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

Timers.Closed String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.