List all Participants for a Channel

GET /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants

TODO: Resource-level docs

List all Participants for a Channel.

Path parameters

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
    • meta object
      Hide meta attributes Show meta attributes
    • participants array[object]
      Hide participants attributes Show participants attributes
      • 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}$.

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

      • sid string | null

        The unique string that identifies the resource

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

      • type string | null

        Participant type.

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

      • url string(uri) | null
GET /v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants 
curl \
 -X GET https://flex-api.twilio.com/v1/Interactions/{InteractionSid}/Channels/{ChannelSid}/Participants \
 --user "username:password"
Response examples (200) 
{
  "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"
  },
  "participants": [
    {
      "channel_sid": "string",
      "interaction_sid": "string",
      "sid": "string",
      "type": "supervisor",
      "url": "https://example.com"
    }
  ]
}