SendbirdSendbird 聊天平台服务端 API v3
POST/v3/group_channels/{channel_url}/invite
邀请成员
将一个或多个用户以成员身份邀请进群组频道,需提供 channel_url 与 user_ids。被邀请用户无需接受即可立即加入;如需让用户选择接受或拒绝邀请,可配置邀请偏好。
通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint;客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容,Pontx 不代理、缓存或聚合,调用方使用本地 SDK/CLI 直连。
请求
- operationId
inviteAsMembers- 服务器
https://api-{app_id}.sendbird.com- 认证
- apiTokenAuth
请求参数
channel_url
pathstring必填
频道 URL
group_channel_123
Body 参数
字段: hidden_statusinvitation_statusinviter_iduser_ids
响应
200
InviteAsMembersResponseapplication/json
请求成功。
字段: channel_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_rolenameoperatorspush_trigger_optionread_receiptsms_fallbackts_message_offsetunread_mention_countunread_message_countuser_last_read
400
SendbirdApiErrorapplication/json
请求参数无效。
字段: codemessage
401
SendbirdApiErrorapplication/json
未认证或 API 令牌无效。
字段: codemessage
403
SendbirdApiErrorapplication/json
无权限访问该资源。
字段: codemessage
404
SendbirdApiErrorapplication/json
未找到指定资源。
字段: codemessage
429
SendbirdApiErrorapplication/json
请求频率超限,请稍后重试。
字段: codemessage
500
SendbirdApiErrorapplication/json
上游服务内部错误。
字段: 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\"}"
}