ConversationsV2Communication

Create Communication

Create a Communication.

post/v2/Conversations/{ConversationId}/Communications

Request body

channelIdstring
occurredAtstring date-time

Timestamp when this Communication occurred. If omitted, the server uses the current time.

Response

Created

idstring required

Communication ID.

conversationIdstring required

Conversation ID.

accountIdstring required

Account ID.

channelIdstring

Channel-specific reference ID.

resourceIdstring

External resource identifier for this Communication (e.g. MessageSid for SMS/RCS/WhatsApp, TranscriptionSid + MessageIndex for Voice). When set, used for Communication deduplication/uniqueness within a Conversation.

createdAtstring date-time

Timestamp when this Communication was created.

updatedAtstring date-time

Timestamp when this Communication was last updated.

occurredAtstring date-time

ISO 8601 timestamp when the communication occurred.

Example response

{
  "id": "conv_communication_00000000000000000000000001",
  "conversationId": "conv_conversation_00000000000000000000000001",
  "accountId": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "author": {
    "address": "+18005550100",
    "channel": "SMS",
    "participantId": "conv_participant_00000000000000000000000001"
  },
  "content": {
    "type": "TEXT",
    "text": "Hello, I need help with my order"
  },
  "resourceId": "SM12345678901234567890123456789012",
  "recipients": [
    {
      "address": "+18005550102",
      "channel": "SMS",
      "participantId": "conv_participant_00000000000000000000000002",
      "deliveryStatus": "DELIVERED"
    }
  ],
  "createdAt": "2023-07-01T12:15:00Z",
  "updatedAt": "2023-07-01T12:15:05Z"
}

Changes

Changed in 1 of the 4 revisions of this API.1

    • added the new READ enum value to the recipients/items/allOf[subschema #2]/deliveryStatus response property for the response status 201

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog