List all Channels for an Interaction

GET /v1/Interactions/{InteractionSid}/Channels

TODO: Resource-level docs

List all Channels for an Interaction.

Path parameters

  • InteractionSid string Required

    The Interaction Sid for this channel.

Query parameters

  • PageSize integer

    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.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • channels array[object]
      Hide channels attributes Show channels attributes array[object]
      • interaction_sid string | null

        The Interaction Sid for this channel.

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

      • links object(uri-map) | null
      • sid string | null

        The unique string that identifies the resource

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

      • type string | null

        The Interaction Channel's type.

        Values are voice, sms, email, web, whatsapp, or chat.

      • url string(uri) | null
    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri)
      • page integer
      • page_size integer
      • previous_page_url string(uri)
      • url string(uri)
GET /v1/Interactions/{InteractionSid}/Channels 
curl \
 -X GET https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels \
 --user "username:password"
Response examples (200) 
{
  "channels": [
    {
      "interaction_sid": "string",
      "links": {},
      "sid": "string",
      "type": "voice",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}
Response examples (200) 
{
  "channels": [
    {
      "interaction_sid": "string",
      "links": {},
      "sid": "string",
      "type": "voice",
      "url": "https://example.com"
    }
  ],
  "meta": {
    "first_page_url": "https://example.com",
    "key": "string",
    "next_page_url": "https://example.com",
    "page": 42,
    "page_size": 42,
    "previous_page_url": "https://example.com",
    "url": "https://example.com"
  }
}