Fetch Outbound Communication Batch 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();

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.results(batch_id="<id>")

    # Handle response
    print(res)

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

fetch('https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}/results', 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}/results",
  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}/results"

	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}/results")

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

[
  {
    "reference_id": "<string>",
    "target": "<string>",
    "request_variables": {},
    "channel_manager_sid": "LMc4b16a9df2ce33d84b3d30581fe6598c",
    "created_at": "2023-11-07T05:31:56Z",
    "sent_at": "2026-07-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."
    },
    "line_type": "mobile",
    "enrichment": {
      "carrier_name": "Onvoy, LLC - Sinch",
      "line_type": "mobile",
      "mcc": "313",
      "mnc": "410"
    }
  }
]

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

GET

api

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();

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.results(batch_id="<id>")

    # Handle response
    print(res)

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

fetch('https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}/results', 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}/results",
  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}/results"

	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}/results")

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

[
  {
    "reference_id": "<string>",
    "target": "<string>",
    "request_variables": {},
    "channel_manager_sid": "LMc4b16a9df2ce33d84b3d30581fe6598c",
    "created_at": "2023-11-07T05:31:56Z",
    "sent_at": "2026-07-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."
    },
    "line_type": "mobile",
    "enrichment": {
      "carrier_name": "Onvoy, LLC - Sinch",
      "line_type": "mobile",
      "mcc": "313",
      "mnc": "410"
    }
  }
]

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

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

Show child attributes

channel_manager_sid

string | null

Channel manager SID

Example:

"LMc4b16a9df2ce33d84b3d30581fe6598c"

created_at

string<date-time>

Timestamp of request creation

Example:

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

sent_at

string<date-time> | null

Timestamp at which request was sent

Example:

"2026-07-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,

SKIPPED

Examples:

"PENDING"

"DUPLICATE"

"INITIATED"

"CONNECTED"

"COMPLETED"

"FAILED"

"CANCELED"

"INVALID"

"SKIPPED"

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 | null

Insights from call

Show child attributes

Example:

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

line_type

string | null

Line type of the target number from Twilio Lookup (e.g. 'mobile', 'landline', 'voip'); resolved at ingestion.

Example:

"mobile"

enrichment

Enrichment · object | null

Full Twilio Lookup v2 line_type_intelligence payload resolved at ingestion (line_type / carrier_name / mcc / mnc / error_code). None when no lookup was performed.

Example:

{
  "carrier_name": "Onvoy, LLC - Sinch",
  "line_type": "mobile",
  "mcc": "313",
  "mnc": "410"
}

⌘I