Skip to main content
GET
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
/
results
Typescript (SDK)
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.results({
    batchId: "<id>",
  });

  console.log(result);
}

run();
[
  {
    "reference_id": "<string>",
    "target": "<string>",
    "request_variables": {},
    "channel_manager_sid": "LMc4b16a9df2ce33d84b3d30581fe6598c",
    "created_at": "2023-11-07T05:31:56Z",
    "sent_at": "2026-03-30T00:00:00Z",
    "attempt_count": 0,
    "session_id": 1,
    "conversation_id": 1,
    "request_status": "PENDING",
    "channel_manager_status": "COMPLETED",
    "insights_status": "PENDING",
    "insights": {
      "rating": "Good",
      "summary": "The customer service agent successfully assisted the caller with their inquiry and the call ended positively."
    }
  }
]

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
batch_id
string
required

Query Parameters

​
reference_id
string | null
​
status
string | null
​
insights_status
string | null

Response

Successful Response

​
reference_id
string
required

ID for target outreach (unique within batch)

Example:

"12345"

​
target
string
required

Target phone number

Examples:

"512-555-1234"

"+15125551234"

​
request_variables
Request Variables · object
required

Variables for request

​
channel_manager_sid
string | null

Channel manager SID

Example:

"LMc4b16a9df2ce33d84b3d30581fe6598c"

​
created_at
string<date-time>

Timestamp of request creation

Example:

"2026-03-29T00:00:00Z"

​
sent_at
string<date-time> | null

Timestamp at which request was sent

Example:

"2026-03-30T00:00:00Z"

​
attempt_count
integer
default:0

Number of attempts for request

Example:

0

​
session_id
integer | null

Unique ID for call session

Example:

1

​
conversation_id
integer | null

Unique ID for conversation

Example:

1

​
request_status
enum<string>
default:PENDING

Status of request

Available options:
PENDING,
DUPLICATE,
INITIATED,
CONNECTED,
COMPLETED,
FAILED,
CANCELED,
INVALID
Examples:

"PENDING"

"DUPLICATE"

"INITIATED"

"CONNECTED"

"COMPLETED"

"FAILED"

"CANCELED"

"INVALID"

​
channel_manager_status
string | null

Status of request in channel manager (see ChannelManagerStatus)

Example:

"COMPLETED"

​
insights_status
string | null

Status of session in insight workflow

Example:

"PENDING"

​
insights
Insights · object

Insights from call

Example:
{
  "rating": "Good",
  "summary": "The customer service agent successfully assisted the caller with their inquiry and the call ended positively."
}