Get Outbound Communication Batch

Python (SDK)

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)

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.outbound.batches.getById({
    batchId: "<id>",
  });

  console.log(result);
}

run();

const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Syllable-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Syllable-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "batch_id": "<string>",
  "campaign_id": 123,
  "last_updated_by": "<string>",
  "expires_on": "2026-08-18T00:00:00Z",
  "paused": true,
  "call_rate": 25,
  "auto_call_rate": false,
  "status": "PENDING",
  "auto_call_rate_baseline": 25,
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2026-08-17T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2026-08-17T00:00:00Z",
  "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
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

api

outbound

batches

{batch_id}

Python (SDK)

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)

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.outbound.batches.getById({
    batchId: "<id>",
  });

  console.log(result);
}

run();

const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Syllable-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Syllable-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "batch_id": "<string>",
  "campaign_id": 123,
  "last_updated_by": "<string>",
  "expires_on": "2026-08-18T00:00:00Z",
  "paused": true,
  "call_rate": 25,
  "auto_call_rate": false,
  "status": "PENDING",
  "auto_call_rate_baseline": 25,
  "upload_filename": "LATE_PAYMENTS_20250401.csv",
  "dispatch_id": "5ac42327fbd7e03b441650b79ae91ae1",
  "created_at": "2023-11-07T05:31:56Z",
  "deleted_at": "2026-08-17T00:00:00Z",
  "deleted_reason": "User request",
  "last_updated_at": "2026-08-17T00:00:00Z",
  "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
    }
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Syllable-API-Key

string

header

required

Path Parameters

batch_id

string

required

Response

Successful Response

batch_id

string

required

Unique ID for conversation batch

Example:

"20260817.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<date-time> | null

Timestamp of batch expiration

Example:

"2026-08-18T00:00:00Z"

paused

boolean | null

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

Example:

true

call_rate

integer | null

Target number of outreach attempts per hour for this batch. When omitted, the batch inherits the campaign's hourly_rate.

Required range: 1 <= x <= 3600

Example:

25

auto_call_rate

boolean

default:false

Pace this batch automatically to finish before expires_on, counting only the campaign's valid hours (daily_start_time..daily_end_time on active_days). The derived rate takes precedence over call_rate and over the campaign hourly_rate. Requires expires_on.

Examples:

true

false

status

enum<string>

default:PENDING

Status of batch

Available options:

PENDING,

ACTIVE,

PAUSED,

FAILED,

CANCELED,

EXPIRED

Examples:

"PENDING"

"ACTIVE"

"PAUSED"

"FAILED"

"CANCELED"

"EXPIRED"

auto_call_rate_baseline

number | null

Read-only. The auto-paced rate first computed for this batch, set on its first dialing cycle. Subsequent cycles hold the rate within +/- 20% of it. Null until the batch has dialed, or when auto_call_rate is off.

Example:

25

upload_filename

string | null

Name of file used to create batch

Example:

"LATE_PAYMENTS_20250401.csv"

dispatch_id

string | null

A unique identifier for dipatched job

Example:

"5ac42327fbd7e03b441650b79ae91ae1"

created_at

string<date-time>

Timestamp of batch creation

Example:

"2026-08-17T00:00:00Z"

deleted_at

string<date-time> | null

Timestamp of batch deletion

Example:

"2026-08-17T00:00:00Z"

deleted_reason

string | null

Reason for batch deletion

Example:

"User request"

last_updated_at

string<date-time> | null

Timestamp of last change to batch

Example:

"2026-08-17T00:00:00Z"

error_message

string | null

Error message if batch upload failed

Example:

"Invalid file format"

status_counts

Status Counts · object | null

Counts of requests by status

Show child attributes

Example:

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

detailed_status_counts

Detailed Status Counts · object | null

Per request_status: total count and optional counts by channel_manager_status

Show child attributes

Example:

{
  "CONNECTED": {
    "counts": { "COMPLETED": 95, "NO-ANSWER": 5 },
    "total_count": 100
  },
  "PENDING": {
    "counts": { "PENDING": 8, "SENT": 2 },
    "total_count": 10
  },
  "QUEUED": { "total_count": 200 }
}

⌘I