List user channel

GET /v2/Services/{ServiceSid}/Users/{UserSid}/Channels

TODO: Resource-level docs

Path parameters

  • ServiceSid string Required
  • UserSid string Required

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]
      • account_sid string | null

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

      • channel_sid string | null

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

      • last_consumed_message_index integer | null
      • member_sid string | null

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

      • notification_level string | null

        Values are default or muted.

      • service_sid string | null

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

      • status string | null

        Values are joined, invited, or not_participating.

      • unread_messages_count integer | null
      • url string(uri) | null
      • user_sid string | null

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

    • 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 /v2/Services/{ServiceSid}/Users/{UserSid}/Channels
curl \
 -X GET https://ip-messaging.twilio.com/v2/Services/{ServiceSid}/Users/{UserSid}/Channels \
 --user "username:password"
Response examples (200)
{
  "channels": [
    {
      "account_sid": "string",
      "channel_sid": "string",
      "last_consumed_message_index": 42,
      "links": {},
      "member_sid": "string",
      "notification_level": "default",
      "service_sid": "string",
      "status": "joined",
      "unread_messages_count": 42,
      "url": "https://example.com",
      "user_sid": "string"
    }
  ],
  "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": [
    {
      "account_sid": "string",
      "channel_sid": "string",
      "last_consumed_message_index": 42,
      "links": {},
      "member_sid": "string",
      "notification_level": "default",
      "service_sid": "string",
      "status": "joined",
      "unread_messages_count": 42,
      "url": "https://example.com",
      "user_sid": "string"
    }
  ],
  "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"
  }
}