Retrieve a list of Interactions for a given [Session]

GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid}

TODO: Resource-level docs

Retrieve a list of Interactions for a given Session.

Path parameters

  • ServiceSid string Required

    The SID of the parent Service of the resource to fetch.

  • SessionSid string Required

    The SID of the parent Session of the resource to fetch.

  • Sid string Required

    The Twilio-provided string that uniquely identifies the Interaction resource to fetch.

Responses

  • • 200

    OK

    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 of message interactions

    • date_created string(date-time) | null

      The ISO 8601 date and time in GMT when the Interaction 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

      The SID of the inbound Participant resource

      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

      The SID of the inbound resource

      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

      The inbound resource status of the Interaction

      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

      The inbound resource type

    • inbound_resource_url string(uri) | null

      The URL of the Twilio inbound resource

    • outbound_participant_sid string | null

      The SID of the outbound Participant

      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 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 of the Interaction

      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 outbound resource

    • 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 the Interaction

      Values are message, voice, or unknown.

    • url string(uri) | null

      The absolute URL of the Interaction resource
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid} 
curl \
 -X GET https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions/{Sid} \
 --user "username:password"
Response examples (200) 
{
  "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",
  "service_sid": "string",
  "session_sid": "string",
  "sid": "string",
  "type": "message",
  "url": "https://example.com"
}