Agents

Make a BotInstance post a test message (v2)

The bot posts a system message into roomJid, or into every room it is currently in when roomJid is omitted. Confirms that the bot is connected and can deliver messages. The AI service's answer is passed through, status code included.

Owner only. Supports User JWT and B2B Server JWT.

post/v2/agents/{idOrAddress}/bot-instances/{botInstanceId}/test-message

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/agents/{idOrAddress}/bot-instances/{botInstanceId}/test-message
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idOrAddressstring required

Agent id, or the agent's 0x... address.

botInstanceIdstring required

BotInstance id (from the agent's bot-instances list).

Request body

textstring

Message text. Default is "(test message from <bot name>)".

roomJidstring

Only this room. The bot must already be in it.

Response 

{ ok: true, sent: number, total: number, results: [{ room: string, ok: boolean, error?: string }] }

Changes

No recorded changes to this operation across all 1 revision of this API.