SoChatSoChat

API

Orchestration

Virtual member orchestration APIs.

Back to index

Auth: Authorization: Bearer sbot_…

GET/api/v1/bots/listChatVirtualMembers
Bot Token

listChatVirtualMemberslistChatVirtualMembers (Value-added Capability)

List dispatchable members in group. Requires bot to be active member; not open by default, apply via support.

  • 必填 query：chat_id（群会话 ID）
  • 可选 query：limit (1-200，默认 50)、offset (≥0，默认 0)
  • 返回：{ items: [{ virtual_user_id, name, username, avatar, joined_at }], pagination: { total, limit, offset } }
  • 403：能力未开通、机器人不在该群或会话非群聊
POST/api/v1/bots/simulateSendMessage
Bot Token

simulateSendMessagesimulateSendMessage (Value-added Capability)

Send text, photo, document, audio, video, or location messages in a group as a selected dispatchable member. Access requirements are the same as `listChatVirtualMembers`, and every call is recorded for compliance.

  • Required for every message: chat_id and virtual_user_id from listChatVirtualMembers
  • Message type: optional type, default text; accepts text, photo / image, document / file, audio, video, and location
  • Text: text is required and must contain 1-1000 characters
  • Media: file_id is required; optional caption is limited to 1000 characters; use duration, width, height, performer, title, and thumbnail_url where applicable
  • Location: latitude (-90..90) and longitude (-180..180) are required; optional name (≤200) and address (≤500)
  • Optional for all types: reply_to_message_id (≤128); obtain media file_id through upload credentials and the complete endpoint first
  • Returns: the same message object shape as the corresponding send endpoint
  • 400: missing, unsupported, or invalid fields; 403: capability disabled / member not in group / member unavailable; 404: virtual member not found