Chats

Get app-scoped broadcast job status/results (v2, tenant actor)

Auth: Tenant Actor

Same response shape as /v2/chats/broadcast/{jobId}. Cross-app jobId probing is rejected with 403 (the job's recorded appId must match the app in the path).

get/v2/apps/{appId}/chats/broadcast/{jobId}

Request

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

Path parameters

appIdstring required

Target App ID. Must be an app the calling actor owns or has been delegated access to.

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.