Sendbird/scheduleAnAnnouncement

暂不支持在线调用 · 原因见下方

SendbirdSendbird 聊天平台服务端 API v3

POST/v3/announcements

创建公告

创建一条公告,用于向指定频道批量发送系统消息。也可在 Sendbird Dashboard 中创建并排期公告,需提供消息内容与目标频道。

通过官方 Sendbird Chat Platform API v3 管理用户、群组频道、开放频道、消息、元数据、审核、机器人与公告。完整边界为固定官方生成 SDK revision 重建的 83 个 REST Endpoint;客户端实时协议与 Chat SDK 不在本集合内。应用数据为调用方私有内容,Pontx 不代理、缓存或聚合,调用方使用本地 SDK/CLI 直连。

请求

operationId
scheduleAnAnnouncement
服务器
https://api-{app_id}.sendbird.com
认证
apiTokenAuth

请求参数

无 URL、查询或 Header 参数。

Body 参数

ScheduleAnAnnouncementRequest

字段: announcement_groupassign_sender_as_channel_invitercease_atcreate_channelcreate_channel_optionsenable_pushend_atkeep_channel_hidden_for_sendermark_as_readmessageresume_atscheduled_atsend_to_frozen_channelstarget_attarget_channel_typetarget_custom_typetarget_listunique_id

响应

200

ScheduleAnAnnouncementResponseapplication/json

请求成功。

字段: announcement_groupcease_atcompleted_atcreate_channelcreate_channel_optionsenable_pushend_atmark_as_readmessageopen_countopen_ratepriorityresume_atscheduled_atsend_to_frozen_channelssent_channel_countsent_user_countstatustarget_attarget_channel_counttarget_channel_typetarget_custom_typetarget_user_countunique_id

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

{
  "announcement_group": "announcement_group_value",
  "cease_at": "cease_at_value",
  "completed_at": 1,
  "create_channel": true,
  "create_channel_options": {
    "cover_url": "https://example.com/avatar.png",
    "custom_type": "default",
    "data": "{\"key\":\"value\"}",
    "distinct": true,
    "name": "Example Channel"
  },
  "enable_push": true,
  "end_at": 1,
  "mark_as_read": true
}