List all Participants for a Channel.

GET /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants
Account sid auth token

List all Participants for a Channel.

Path parameters

  • InteractionSid string Required

    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}$.

  • ChannelSid string Required

    The Channel Sid for this Participant.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^UO[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
    • participants array[object]
      Hide participants attributes Show participants attributes object
      • sid string | null

        The unique string created by Twilio to identify an Interaction Channel Participant resource.

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

      • type string

        Participant type. Can be: agent, customer, supervisor, external, unknown

        Values are supervisor, customer, external, agent, or unknown.

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

      • channel_sid string | null

        The Channel Sid for this Participant.

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

      • url string(uri) | null
      • routing_properties

        The Participant's routing properties.

    • 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/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants 
curl \
 --request GET 'https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants' \
 --user "username:password"
Response examples (200) 
{
  "meta": {
    "key": "participants",
    "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "participants": [
    {
      "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
      "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
      "type": "customer",
      "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
      "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "routing_properties": null
    },
    {
      "sid": "UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2",
      "url": "https://flex-api.twilio.com/v1/Interactions/KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1/Participants/UTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa2",
      "type": "agent",
      "channel_sid": "UOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa1",
      "interaction_sid": "KDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "routing_properties": {
        "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "worker_sid": "WKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "reservation_sid": "WRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      }
    }
  ]
}