Path parameters

• ServiceSid string Required

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

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

• ChannelSid string Required

  The SID of the Channel the Member resources to read belong to. This value can be the Channel resource's sid or unique_name.

Query parameters

• Identity array[string]

  The User's identity value of the Member resources to read. See access tokens for more details.

• 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

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

    • sid string | null

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

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

    • account_sid string | null

      The SID of the Account that created the Member resource.

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

    • channel_sid string | null

      The SID of the Channel the Member resource belongs to.

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

    • service_sid string | null

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

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

    • identity string | null

      The application-defined string that uniquely identifies the resource's User within the Service. See access tokens for more info.

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

    • role_sid string | null

      The SID of the Role assigned to the member.

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

    • last_consumed_message_index integer | null

      The index of the last Message in the Channel that the Member has read.

    • last_consumption_timestamp string(date-time) | null

      The ISO 8601 timestamp of the last Message read event for the Member within the Channel.

    • url string(uri) | null

      The absolute URL of the Member resource.

    • attributes string | null

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

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