Path parameters

• ServiceSid string Required

  The SID of the Service to read the Channel resources from.

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

Query parameters

• Type array[string]

  The visibility of the Channels to read. Can be: public or private and defaults to public.

  Values are public or private.

• 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

  • channels array[object]
    Hide channels attributes Show channels attributes object

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

    • account_sid string | null

      The SID of the Account that created the Channel resource.

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

    • service_sid string | null

      The SID of the Service the Channel resource is associated with.

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

    • friendly_name string | null

      The string that you assigned to describe the resource.

    • unique_name string | null

      An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource's sid in the URL.

    • attributes string | null

      The JSON string that stores application-specific data. If attributes have not been set, {} is returned.

    • type string

      The visibility of the channel. Can be: public or private.

      Values are public or private.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • created_by string | null

      The identity of the User that created the channel. If the Channel was created by using the API, the value is system.

    • members_count integer

      The number of Members in the Channel.

      Default value is 0.

    • messages_count integer

      The number of Messages that have been passed in the Channel.

      Default value is 0.

    • url string(uri) | null

      The absolute URL of the Channel resource.

    • links object(uri-map) | null

      The absolute URLs of the Members, Messages, Invites, Webhooks and, if it exists, the last Message for the Channel.

  • 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)