TWtwilio
ConversationsV2Conversation

Create a new Conversation

Changed on

Create a new conversation

post/v2/Conversations

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v2/Conversations
  • Auth
    HTTP basic

Request body

configurationIdstring required

The ID of an existing configuration.

namestring

The name of the conversation.

metadataobject

Optional customer-managed key-value metadata for this Conversation. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.

Example request

{
  "configurationId": "conv_configuration_00000000000000000000000002",
  "name": "Support Chat",
  "configuration": {
    "workflows": [
      {
        "flowId": "FW00000000000000000000000000000000"
      }
    ]
  },
  "metadata": {
    "zendesk_ticket_id": "TKT-456"
  }
}

Response

Created

idstring required

Conversation ID.

accountIdstring required

Account ID.

configurationIdstring required

Configuration ID.

status'ACTIVE' | 'INACTIVE' | 'CLOSED'

Lifecycle status of a Conversation.

namestring nullable

Conversation name.

createdAtstring date-time

Timestamp when this Conversation was created.

updatedAtstring date-time

Timestamp when this Conversation was last updated.

metadataConversationsV2Metadata

Customer-managed key-value pairs. Maximum 8 entries; keys up to 128 characters allowing alphanumeric characters, periods, underscores, and dashes; values up to 512 characters.

actionIdstring

The Action created for the request's action, present only on the create response that dispatched one. Poll GET /v2/Conversations/{ConversationId}/Actions/{ActionId} for its status.

Example response

{
  "id": "conv_conversation_00000000000000000000000001",
  "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "configurationId": "conv_configuration_00000000000000000000000001",
  "status": "ACTIVE",
  "name": "Customer Support - Multi-channel",
  "createdAt": "2023-07-01T12:00:00Z",
  "updatedAt": "2023-07-01T12:30:00Z",
  "metadata": {
    "zendesk_ticket_id": "TKT-456"
  }
}

Changes

  • v24c4068f28797Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • v21abed68811c4Revision changes
    • info

      added the new optional request property /

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status