Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page.

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

Retrieve a list of all Interactions for a Session. A maximum of 100 records will be returned per page.

Path parameters

  • ServiceSid string Required

    The SID of the parent Service to read the resources from.

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

  • SessionSid string Required

    The SID of the parent Session to read the resources from.

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

Query parameters

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 1000.

    Minimum value is 1, maximum value is 1000.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • interactions array[object]
      Hide interactions attributes Show interactions attributes object
      • sid string | null

        The unique string that we created to identify the Interaction resource.

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

      • session_sid string | null

        The SID of the parent Session resource.

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

      • service_sid string | null

        The SID of the parent Service resource.

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

      • account_sid string | null

        The SID of the Account that created the Interaction 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 (e.g. {"body": "hello"}) or the call duration (when available) of a call (e.g. {"duration": "5"}).

      • type string

        The Type of the Interaction. Can be: message, voice or unknown.

        Values are message, voice, or unknown.

      • 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; either the Call or Message.

        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

        The inbound resource status of the Interaction. Will always be delivered for messages and in-progress for calls.

        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. Can be Call or Message.

      • 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; either the Call or Message.

        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

        The inbound resource status of the Interaction. Will always be delivered for messages and in-progress for calls.

        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. Can be: Call or Message.

      • outbound_resource_url string(uri) | null

        The URL of the Twilio outbound resource.

      • 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.

      • url string(uri) | null

        The absolute URL of the Interaction resource.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions
curl \
 --request GET 'https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/Interactions' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "interactions",
    "url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://proxy.twilio.com/v1/Services/KSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Sessions/KCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Interactions?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "interactions": []
}