GET
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.outbound.batches.get_by_id(batch_id="<id>")

    # Handle response
    print(res)
{
  "batch_id": "20250409.9",
  "campaign_id": 1,
  "expires_on": "2025-04-10T00:00:00Z",
  "status": "PENDING",
  "count": 152,
  "created_at": "2025-04-09T00:00:00Z",
  "deleted_at": "2025-04-09T00:00:00Z",
  "deleted_reason": "User request",
  "last_worked_on": "2025-04-09T00:00:00Z",
  "last_updated_by": "user@email.com",
  "status_counts": {
    "CANCELED": 7,
    "CONNECTED": 100,
    "DUPLICATE": 5,
    "FAILED": 10,
    "INITIATED": 20,
    "PENDING": 10
  }
}

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
batch_id
string
required

Response

200
application/json
Successful Response
​
batch_id
string
required

Unique ID for conversation batch

Example:

"20250409.9"

​
campaign_id
integer
required

Unique ID for campaign

Example:

1

​
last_updated_by
string
required

Email of user who last updated campaign

Example:

"user@email.com"

​
expires_on
string | null

Timestamp of batch expiration

Example:

"2025-04-10T00:00:00Z"

​
status
enum<string>

Status of batch

Available options:
PENDING,
ACTIVE,
PAUSED,
IDLE,
CANCELED,
EXPIRED
​
count
integer | null

Number of requests in batch

Example:

152

​
created_at
string

Timestamp of batch creation

Example:

"2025-04-09T00:00:00Z"

​
deleted_at
string | null

Timestamp of batch deletion

Example:

"2025-04-09T00:00:00Z"

​
deleted_reason
string | null

Reason for batch deletion

Example:

"User request"

​
last_worked_on
string | null

Timestamp of last batch activity

Example:

"2025-04-09T00:00:00Z"

​
status_counts
object | null

Counts of requests by status

Example:
{
  "CANCELED": 7,
  "CONNECTED": 100,
  "DUPLICATE": 5,
  "FAILED": 10,
  "INITIATED": 20,
  "PENDING": 10
}