Agents

Remove a BotInstance from one chat (v2)

Takes the bot out of one room without stopping it or deleting the BotInstance: the AI service leaves the room, the bot's room affiliation is removed so it does not rejoin on reconnect, and it is dropped from the room's member list.

The AI service step is best-effort: when it fails the rest still runs and aiServiceOk: false comes back with the reason.

Owner only. Supports User JWT and B2B Server JWT.

post/v2/agents/{idOrAddress}/bot-instances/{botInstanceId}/leave-chat

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/agents/{idOrAddress}/bot-instances/{botInstanceId}/leave-chat
  • 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

chatJidstring required

Full room JID, <appId>_<chatId>@conference.<xmpp host>.

Response 

{
  ok: true,
  aiServiceOk: boolean,
  aiServiceError: string|null,
  botInstance: { id: string, xmppUsername: string, joinedRooms: string[], status: 'on'|'off' }
}

Changes

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