MUSUWAMUSUWA

API

メッセージを送信する

テキスト、メディア、位置情報、および関連する送信方法。

インデックスに戻る

認証: Authorization: Bearer sbot_…

POST/api/v1/bots/sendMessage
Bot Token

sendMessageテキストメッセージを送信する

向指定会话发送文本消息，对外以机器人系统账号身份发送。

  • 必須: chat_id (会話ID), text (先頭と末尾の空白をトリムした後の1-5000 UTF-16コードユニット)。
  • 長さの動作: 一回の sendMessage 呼び出しが一つのメッセージを作成します。APIはテキストを自動的に切り捨てたり分割したりしません; サイズオーバーのテキストはHTTP 400を返すため、呼び出し元は必要に応じて明示的に分割することができます。
  • オプション: reply_to_message_id (引用返信: 引用メッセージの ID、TG と同義)、reply_markup
  • 各InlineKeyboardボタンは正確に一つのターゲットを選択する必要があります: url (http(s)外部リンク), callback_data ( callback_queryを配信), または action (アプリ内ナビゲーション)。
  • ボットまたは通常のユーザープロファイルを開く: action: { type: "user_profile", user_id: "<system_user_id>" }。
  • 公開グループの詳細ページを開く: action: { type: "public_group", group_id: "<group_id>" }; プライベート、欠落、または解散したグループは400を返します。
  • actionはWeb、アプリ、デスクトップクライアントの内部ルーティングによって処理されます; 外部ブラウザを開いたり callback_queryを配信したりすることはありません。
  • 戻り値: メッセージ オブジェクト (message_id、chat、from、date を含む)
  • マルチメディアの場合は、sendPhoto / sendDocument / sendVideo / sendAudio を使用してください。
  • ヒント: reply_to_message_id は sendPhoto / sendDocument / sendVideo / sendAudio / sendVoice / sendVideoNote / sendAnimation / sendSticker / にも適用されますsendLocation / sendVenue / sendDice / sendPoll / sendContact / sendMediaGroup (メディア グループが最初の記事に基づいて活動します)
POST/api/v1/bots/sendPhoto
Bot Token

sendPhoto画像メッセージを送信する

`file_id`は`/files/complete`から取得し、画像形式でアップロードされたファイルを送信します。または、credentials秒伝（`uploadRequired: false`）の応答。

  • 必須：chat_id、file_id
  • オプション: caption (画像の説明テキスト、添付テキストは混合メッセージ)、reply_to_message_id (引用返信)、width / height (ピクセル、値、>0 の場合は metadata.width / height と書き込みます)
  • file_id に対応するファイル ドキュメントが metadata.dimensions に書き込まれている場合、プラットフォームは自動的にそれを完了します。
  • 戻り値: メッセージ オブジェクト (message_type=image)
POST/api/v1/bots/sendDocument
Bot Token

sendDocumentドキュメントメッセージを送信

アップロードされたファイルをドキュメント/添付ファイルとして送信します。

  • 必須：chat_id、file_id
  • オプション: caption (テキスト付きの添付ファイルは混合メッセージです)、reply_to_message_id (引用返信)、thumbnail_url (ファイルのサムネイル URL、metadata.thumbnailUrl と書き込みます)
  • 戻り値: メッセージ オブジェクト (message_type=file)
POST/api/v1/bots/sendVideo
Bot Token

sendVideoビデオメッセージを送信する

アップロードされたファイルをビデオとして送信します。

  • 必填：chat_id、file_id
  • 可选：caption (附件配文本即混合消息)、reply_to_message_id (引用回复)、duration (秒)、width / height (像素)、thumbnail_url
  • 所有可选字段 >0 / 非空时才写入 metadata.*；未提供时客户端会在播放时自动读取元数据
  • 返回：消息对象（message_type=video）
POST/api/v1/bots/sendAudio
Bot Token

sendAudio音声メッセージを送信

音声ファイル（音楽/ポッドキャスト）を送信します。音声ノートバブルにはsendVoiceを使用します。

  • 必須：chat_id、file_id
  • オプション: caption, reply_to_message_id, duration (秒), performer, title
  • performer / title は主に音楽 / ポッドキャスト シーン用です。 metadata と Webhook Update message.file を入力してください
  • 戻り値: メッセージ オブジェクト (message_type=audio)
POST/api/v1/bots/sendLocation
Bot Token

sendLocation位置情報メッセージを送信する

发送一个包含经纬度和可选地名的位置消息。

  • 必須：chat_id、latitude、longitude
  • オプション: name (場所名)、address (構造化アドレス)
  • 戻り値: メッセージ オブジェクト (message_type=location)
POST/api/v1/bots/sendVenue
Bot Token

sendVenue送信場所

`sendLocation` に基づくタイトルが必要です。クライアントはそれを「タイトル付きアドレス カード」スタイルとして表示します。

  • 必須：chat_id、latitude、longitude、title
  • 任意：address、reply_markup
  • 戻り値: メッセージ オブジェクト (message_type=venue、metadata.isVenue=true)
POST/api/v1/bots/sendVoice
Bot Token

sendVoice音声メッセージを送信する

`sendAudio` と同じものをアップロードし、`file_id` で送信します。クライアントはそれを「吹き出し」スタイルでレンダリングします。

  • 必須：chat_id、file_id
  • オプション: caption、duration (秒)、performer、title
  • 戻り値: メッセージ オブジェクト (message_type=voice)
POST/api/v1/bots/sendVideoNote
Bot Token

sendVideoNoteビデオノートを送信する

回覧された短いビデオ。クライアントは `width = height` の循環プレーヤーに従ってレンダリングします。

  • 必須：chat_id、file_id
  • オプション: duration または length (秒)、width / height (ピクセル)、thumbnail_url
  • 戻り値: メッセージ オブジェクト (message_type=video_note)
POST/api/v1/bots/sendAnimation
Bot Token

sendAnimationGIF を送信します

通常は GIF / MP4 ショート アニメーション。クライアントはビデオに従って自動的にループします。

  • 必須：chat_id、file_id
  • オプション: caption、duration (秒)、width / height (ピクセル)、thumbnail_url
  • 戻り値: メッセージ オブジェクト (message_type=animation)
POST/api/v1/bots/sendSticker
Bot Token

sendStickerステッカーを送る

`file_id` ソースは他のマルチメディアと同じです。 webp/lottieがおすすめです。

  • 必須：chat_id、file_id
  • 任意：width / height、thumbnail_url
  • 戻り値: メッセージ オブジェクト (message_type=sticker)
POST/api/v1/bots/sendDice
Bot Token

sendDiceサイコロ/ランダム絵文字を送信

サーバー側のローリングポイント。 🎲 / 🎯 / 🏀 / ⚽ / 🎳 / 🎰 および他の絵文字には、異なる値の範囲があります。

  • 必須：chat_id
  • オプション: emoji (デフォルト 🎲; 🎰 → 1–64、⚽/🏀 → 1–5、残りのデフォルト 1–6)、reply_markup
  • 戻り値: メッセージ オブジェクト (message_type=dice、metadata.diceEmoji / metadata.diceValue、text は 🎲 4 のような形状です)
POST/api/v1/bots/sendPoll
Bot Token

sendPoll投票を送信する

現在、`regular` / `quiz` の 2 つのタイプのみがサポートされています。クライアントはそれらを投票バブルとしてレンダリングします。

  • 必須：chat_id、question、options[] (2..12)
  • オプション: is_anonymous (デフォルト true)、type (regular / quiz)、correct_option_id (quiz の場合は必須)、reply_markup
  • 戻り値: メッセージ オブジェクト (message_type=poll; metadata.poll = { question, options, ... })
POST/api/v1/bots/sendContact
Bot Token

sendContact連絡先を送信

クライアントは、名刺の吹き出しに電話番号と名前を表示します。

  • 必須：chat_id、phone_number、first_name
  • 任意：last_name、reply_markup
  • 戻り値: メッセージ オブジェクト (message_type=contact; metadata.contact = { phone_number, first_name, last_name })
POST/api/v1/bots/sendMediaGroup
Bot Token

sendMediaGroup送信メディアグループ

2 ～ 10 枚のメディアをグループとして送信します。プラットフォームはメッセージを複数の独立したメッセージに分割して保存し、最後のメッセージのみに `reply_markup` が含まれます。

  • 必填：chat_id、media[] (2..10)
  • media[i] 必填：type (photo / video / document / audio)、media 或 file_id；可选 caption
  • 可选：reply_markup (仅作用于最后一条)、reply_to_message_id (引用回复，仅作用于首条)
  • 返回：消息对象数组
POST/api/v1/bots/sendChatAction
Bot Token

sendChatActionsendChatアクション

チャット アクションをブロードキャストします (`typing` / `upload_photo` など)。クライアントに「入力中...」というメッセージが 3..5 秒間表示されます。

  • 必須: chat_id、action (typing / upload_photo / record_voice など)
  • リターン：{ ok: true }