Chats

Get broadcast job status/results

Auth: User JWT

Privileged, same as the send route: requires a B2B Server JWT, or a user JWT with application.appSettings.read on the app. A plain App JWT or a non-admin user JWT is rejected.

get/v2/chats/broadcast/{jobId}

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/chats/broadcast/{jobId}
  • Auth: HTTP bearer

Path parameters

jobIdstring required

Job ID returned by the corresponding broadcast call. Polled to track per-room delivery results.

Response 

{
  ok: true,
  jobId: string,
  state: string,
  progress: { processed: number, total: number } | number,
  result?: {
    ok: true,
    total: number,
    processed: number,
    results: [{ chatName, roomJid?, status: 'sent'|'room_not_found'|'dry_run'|'failed', error? }]
  }
}

Changes

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