Create a new message Interaction to send directly from your system to one [Participant]

POST /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions

TODO: Resource-level docs

Create a new message Interaction to send directly from your system to one Participant. The inbound properties for the Interaction will always be empty.

Path parameters

Body

  • Body string

    The message to send to the participant

  • MediaUrl array[string(uri)]

    Reserved. Not currently supported.

Responses

  • 201

    Created

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • data string | null

      A JSON string that includes the message body sent to the participant

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was created

    • date_updated string(date-time) | null

      The ISO 8601 date and time in GMT when the resource was last updated

    • inbound_participant_sid string | null

      Always empty for Message Interactions

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KP[0-9a-fA-F]{32}$.

    • inbound_resource_sid string | null

      Always empty for Message Interactions

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$.

    • inbound_resource_status string | null

      Always empty for Message Interactions

      Values are accepted, answered, busy, canceled, completed, deleted, delivered, delivery-unknown, failed, in-progress, initiated, no-answer, queued, received, receiving, ringing, scheduled, sending, sent, undelivered, or unknown.

    • inbound_resource_type string | null

      Always empty for Message Interactions

    • inbound_resource_url string(uri) | null

      Always empty for Message Interactions

    • outbound_participant_sid string | null

      The SID of the outbound Participant resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KP[0-9a-fA-F]{32}$.

    • outbound_resource_sid string | null

      The SID of the outbound Message resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^[a-zA-Z]{2}[0-9a-fA-F]{32}$.

    • outbound_resource_status string | null

      The outbound resource status

      Values are accepted, answered, busy, canceled, completed, deleted, delivered, delivery-unknown, failed, in-progress, initiated, no-answer, queued, received, receiving, ringing, scheduled, sending, sent, undelivered, or unknown.

    • outbound_resource_type string | null

      The outbound resource type

    • outbound_resource_url string(uri) | null

      The URL of the Twilio message resource

    • participant_sid string | null

      The SID of the Participant resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KP[0-9a-fA-F]{32}$.

    • service_sid string | null

      The SID of the resource's parent Service

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KS[0-9a-fA-F]{32}$.

    • session_sid string | null

      The SID of the resource's parent Session

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KC[0-9a-fA-F]{32}$.

    • sid string | null

      The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^KI[0-9a-fA-F]{32}$.

    • type string | null

      The Type of Message Interaction

      Values are message, voice, or unknown.

    • url string(uri) | null

      The absolute URL of the MessageInteraction resource
POST /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions 
curl \
 -X POST https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants/{ParticipantSid}/MessageInteractions \
 --user "username:password" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d 'Body=string&MediaUrl=https%3A%2F%2Fexample.com'
Request example 
{
  "Body": "string",
  "MediaUrl": [
    "https://example.com"
  ]
}
Request examples 
{
  "Body": "string",
  "MediaUrl": [
    "https://example.com"
  ]
}
Response examples (201) 
{
  "account_sid": "string",
  "data": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "date_updated": "2023-05-04T09:42:00+00:00",
  "inbound_participant_sid": "string",
  "inbound_resource_sid": "string",
  "inbound_resource_status": "accepted",
  "inbound_resource_type": "string",
  "inbound_resource_url": "https://example.com",
  "outbound_participant_sid": "string",
  "outbound_resource_sid": "string",
  "outbound_resource_status": "accepted",
  "outbound_resource_type": "string",
  "outbound_resource_url": "https://example.com",
  "participant_sid": "string",
  "service_sid": "string",
  "session_sid": "string",
  "sid": "string",
  "type": "message",
  "url": "https://example.com"
}
Response examples (201) 
{
  "account_sid": "string",
  "data": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "date_updated": "2024-05-04T09:42:00+00:00",
  "inbound_participant_sid": "string",
  "inbound_resource_sid": "string",
  "inbound_resource_status": "accepted",
  "inbound_resource_type": "string",
  "inbound_resource_url": "https://example.com",
  "outbound_participant_sid": "string",
  "outbound_resource_sid": "string",
  "outbound_resource_status": "accepted",
  "outbound_resource_type": "string",
  "outbound_resource_url": "https://example.com",
  "participant_sid": "string",
  "service_sid": "string",
  "session_sid": "string",
  "sid": "string",
  "type": "message",
  "url": "https://example.com"
}