Retrieve a list of all Participants in a Session

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

TODO: Resource-level docs

Retrieve a list of all Participants in a Session.

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

  • OK

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

      • date_created string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was created

      • date_deleted string(date-time) | null

        The ISO 8601 date the Participant was removed

      • date_updated string(date-time) | null

        The ISO 8601 date and time in GMT when the resource was last updated

      • friendly_name string | null

        The string that you assigned to describe the participant

      • identifier string | null

        The phone number or channel identifier of the Participant

      • proxy_identifier string | null

        The phone number or short code of the participant's partner

      • The SID of the Proxy Identifier assigned to the Participant

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

      • 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: ^KP[0-9a-fA-F]{32}$.

      • url string(uri) | null

        The absolute URL of the Participant resource

GET /v1/Services/{ServiceSid}/Sessions/{SessionSid}/Participants
curl \
 -X GET https://proxy.twilio.com/v1/Services/{ServiceSid}/Sessions/{SessionSid}/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": [
    {
      "account_sid": "string",
      "date_created": "2023-05-04T09:42:00+00:00",
      "date_deleted": "2023-05-04T09:42:00+00:00",
      "date_updated": "2023-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "identifier": "string",
      "links": {},
      "proxy_identifier": "string",
      "proxy_identifier_sid": "string",
      "service_sid": "string",
      "session_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}
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": [
    {
      "account_sid": "string",
      "date_created": "2024-05-04T09:42:00+00:00",
      "date_deleted": "2024-05-04T09:42:00+00:00",
      "date_updated": "2024-05-04T09:42:00+00:00",
      "friendly_name": "string",
      "identifier": "string",
      "links": {},
      "proxy_identifier": "string",
      "proxy_identifier_sid": "string",
      "service_sid": "string",
      "session_sid": "string",
      "sid": "string",
      "url": "https://example.com"
    }
  ]
}