Sign in

v64

OpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB
outbound.batches

Get Outbound Communication Batch

get/api/v1/outbound/batches/{batch_id}

Path parameters

batch_idstring required

Response

Successful Response

batch_idstring required

Unique ID for conversation batch

campaign_idinteger required

Unique ID for campaign

expires_onstring date-time nullable

Timestamp of batch expiration

pausedboolean nullable

Whether the batch is on HOLD. When on HOLD, no outreach will be made.

status'PENDING' | 'ACTIVE' | 'PAUSED' | 'FAILED' | 'CANCELED' | 'EXPIRED'

Status of a communication batch.

upload_filenamestring nullable

Name of file used to create batch

dispatch_idstring nullable

A unique identifier for dipatched job

created_atstring date-time

Timestamp of batch creation

deleted_atstring date-time nullable

Timestamp of batch deletion

deleted_reasonstring nullable

Reason for batch deletion

last_updated_atstring date-time nullable

Timestamp of last change to batch

last_updated_bystring required

Email of user who last updated campaign

error_messagestring nullable

Error message if batch upload failed

status_countsobject nullable

Counts of requests by status

detailed_status_countsobject nullable

Per request_status: total count and optional counts by channel_manager_status

Example response

{
  "batch_id": "20260801.9",
  "campaign_id": 1,
  "expires_on": "2026-08-02T00:00:00Z",
  "paused": true,
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
  "created_at": "2026-08-01T00:00:00Z",
  "deleted_at": "2026-08-01T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2026-08-01T00:00:00Z",
  "last_updated_by": "user@email.com",
  "error_message": "Invalid file format",
  "status_counts": {
    "CANCELED": 7,
    "CONNECTED": 100,
    "DUPLICATE": 5,
    "FAILED": 10,
    "INITIATED": 20,
    "PENDING": 10
  },
  "detailed_status_counts": {
    "CONNECTED": {
      "counts": {
        "COMPLETED": 95,
        "NO-ANSWER": 5
      },
      "total_count": 100
    },
    "PENDING": {
      "counts": {
        "PENDING": 8,
        "SENT": 2
      },
      "total_count": 10
    },
    "QUEUED": {
      "total_count": 200
    }
  }
}