OPENAPI / COMPONENTS / SCHEMAS

GetAGroupChannelResponse data structure

GetAGroupChannelResponse

Response containing a group channel's details.

object46properties
channelstring

Channel object.

channel_urlstringrequired

Channel URL.

count_preferenceGetAGroupChannelResponseCountPreferenceEnum

cover_urlstring

Cover image URL.

created_atinteger

Creation timestamp.

created_bystring

created by field.

custom_typestring

Custom type identifier.

datastring

Additional data payload.

delivery_receiptstring

Delivery receipt.

disappearing_messagestring

disappearing message field.

freezeboolean

Whether the channel is frozen.

has_ai_botboolean

has ai bot field.

has_botboolean

has bot field.

hidden_stateGetAGroupChannelResponseHiddenStateEnum

ignore_profanity_filterboolean

ignore profanity filter field.

invited_atinteger

invited at field.

inviterstring

Inviter.

is_access_code_requiredboolean

is access code required field.

is_broadcastboolean

Whether broadcast channel.

is_discoverableboolean

is discoverable field.

is_distinctboolean

Whether the channel is distinct.

is_ephemeralboolean

Whether the message is ephemeral.

is_exclusiveboolean

is exclusive field.

is_hiddenboolean

is hidden field.

is_mutedboolean

Whether muted.

is_publicboolean

Whether the channel is public.

is_push_enabledboolean

is push enabled field.

is_superboolean

Whether the channel is a super channel.

joined_member_countnumber

joined member count field.

joined_tsinteger

joined ts field.

last_messagestring

Last message.

max_length_messagenumber

Maximum message length.

member_countnumber

Member count.

member_stateGetAGroupChannelResponseMemberStateEnum

membersarray

members field.

message_survival_secondsnumber

Message survival seconds.

metadatastring

Metadata map.

my_roleGetAGroupChannelResponseMyRoleEnum

namestring

Name.

push_trigger_optionstring

Push trigger option.

read_receiptobject

Read receipt.

sms_fallbackstring

sms fallback field.

ts_message_offsetinteger

ts message offset field.

unread_mention_countnumber

Unread mention count.

unread_message_countnumber

Unread message count.

user_last_readinteger

user last read field.