Fetch channel

GET /v1/Services/{ServiceSid}/Channels/{Sid}

Channels represent chat rooms

Path parameters

  • ServiceSid string Required

    The SID of the Service to fetch the resource from.

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

  • Sid string Required

    The Twilio-provided string that uniquely identifies the Channel resource to fetch.

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
    • 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 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. Note If this property has been assigned a value, it's only displayed in a FETCH action that returns a single resource; otherwise, it's null. If the 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 RFC 2822 format.

    • date_updated string(date-time) | null

      The date and time in GMT when the resource was last updated specified in RFC 2822 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 in the Channel.

      Default value is 0.

    • url string(uri) | null

      The absolute URL of the Channel resource.

GET /v1/Services/{ServiceSid}/Channels/{Sid}
curl \
 --request GET 'https://chat.twilio.com/v1/Services/{ServiceSid}/Channels/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "public",
  "links": {
    "invites": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Invites",
    "members": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Members",
    "messages": "https://chat.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels/CHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages",
    "last_message": null
  },
  "attributes": "{ \"foo\": \"bar\" }",
  "created_by": "system",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "unique_name": "unique_name",
  "date_created": "2015-12-16T22:18:37Z",
  "date_updated": "2015-12-16T22:18:37Z",
  "friendly_name": "friendly_name",
  "members_count": 0,
  "messages_count": 0
}