Sign in

v50

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-02-055427357.6 KB
ChatV2Channel

get/v2/Services/{ServiceSid}/Channels/{Sid}

Path parameters

ServiceSidstring required

The SID of the Service to fetch the Channel resource from.

Sidstring required

The SID of the Channel resource to fetch. This value can be either the sid or the unique_name of the Channel resource to fetch.

Response

OK

sidstring nullable

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

account_sidstring nullable

The SID of the Account that created the Channel resource.

service_sidstring nullable

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

friendly_namestring nullable

The string that you assigned to describe the resource.

unique_namestring nullable

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.

attributesstring nullable

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

type'public' | 'private'

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

date_createdstring date-time nullable

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

date_updatedstring date-time nullable

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

created_bystring nullable

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

members_countinteger

The number of Members in the Channel.

messages_countinteger

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

urlstring uri nullable

The absolute URL of the Channel resource.

linksobject nullable

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