Sendbird/getAGroupChannel

Online calls unavailable · details below

SendbirdSendbird Chat Platform server-side API v3

GET/v3/group_channels/{channel_url}

Get a group channel

Retrieves information about the group channel identified by channel_url; optional query parameters determine whether delivery receipts, read receipts, or member information are included in the response.

Manage users, group channels, open channels, messages, metadata, moderation, bots, and announcements through the official Sendbird Chat Platform API v3. The complete boundary is the 83 REST endpoints reconstructed from a pinned official generated SDK revision; client realtime protocols and Chat SDKs are not part of this collection. Application data is the caller's private content, so Pontx does not proxy, cache, or aggregate it and callers use the local SDK/CLI directly.

Request

operationId
getAGroupChannel
Server
https://api-{app_id}.sendbird.com
Authentication
apiTokenAuth

Request parameters

channel_url

pathstringrequired

Channel URL.

group_channel_123

show_delivery_receipt

queryboolean

show delivery receipt field.

true

show_read_receipt

queryboolean

show read receipt field.

true

show_member

queryboolean

Whether to show members.

true

member_active_mode

querystring

member active mode field.

all

user_id

querystring

User identifier.

user_id_123

Responses

200

GetAGroupChannelResponseapplication/json

Request succeeded.

Properties: channelchannel_urlcount_preferencecover_urlcreated_atcreated_bycustom_typedatadelivery_receiptdisappearing_messagefreezehas_ai_bothas_bothidden_stateignore_profanity_filterinvited_atinviteris_access_code_requiredis_broadcastis_discoverableis_distinctis_ephemeralis_exclusiveis_hiddenis_mutedis_publicis_push_enabledis_superjoined_member_countjoined_tslast_messagemax_length_messagemember_countmember_statemembersmessage_survival_secondsmetadatamy_rolenamepush_trigger_optionread_receiptsms_fallbackts_message_offsetunread_mention_countunread_message_countuser_last_read

400

SendbirdApiErrorapplication/json

Request parameters are invalid.

Properties: codemessage

401

SendbirdApiErrorapplication/json

Unauthenticated or the API token is invalid.

Properties: codemessage

403

SendbirdApiErrorapplication/json

Access to the resource is forbidden.

Properties: codemessage

404

SendbirdApiErrorapplication/json

The requested resource was not found.

Properties: codemessage

429

SendbirdApiErrorapplication/json

Rate limited; retry later.

Properties: codemessage

500

SendbirdApiErrorapplication/json

Upstream internal error.

Properties: codemessage

{
  "channel_url": "group_channel_123",
  "count_preference": "false",
  "cover_url": "https://example.com/avatar.png",
  "created_at": 1,
  "custom_type": "default",
  "data": "{\"key\":\"value\"}"
}