List channel

GET /v1/Channels

Flex chat channels

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
    • flex_chat_channels array[object]
      Hide flex_chat_channels attributes Show flex_chat_channels attributes object
      • account_sid string | null

        The SID of the Account that created the Channel resource and owns this Workflow.

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

      • flex_flow_sid string | null

        The SID of the Flex Flow.

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

      • sid string | null

        The unique string that we created to identify the Channel resource.

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

      • user_sid string | null

        The SID of the chat user.

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

      • task_sid string | null

        The SID of the TaskRouter Task. Only valid when integration type is task. null for integration types studio & external

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

      • url string(uri) | null

        The absolute URL of the Flex chat channel resource.

      • date_created string(date-time) | null

        The date and time in GMT when the Flex chat channel was created specified in ISO 8601 format.

      • date_updated string(date-time) | null

        The date and time in GMT when the Flex chat channel was last updated specified in ISO 8601 format.

    • 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/Channels
curl \
 --request GET 'https://flex-api.twilio.com/v1/Channels' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "flex_chat_channels",
    "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "flex_chat_channels": [
    {
      "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "url": "https://flex-api.twilio.com/v1/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "task_sid": "WTaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "user_sid": "USaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-08-01T22:10:40Z",
      "date_updated": "2016-08-01T22:10:40Z",
      "flex_flow_sid": "FOaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ]
}
{
  "meta": {
    "key": "flex_chat_channels",
    "url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://flex-api.twilio.com/v1/Channels?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "flex_chat_channels": []
}