GET
/
api
/
v1
/
outbound
/
batches
/
{batch_id}
/
results
curl --request GET \
  --url https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}/results \
  --header 'Syllable-API-Key: <api-key>'
[
  {
    "batch_id": "20250117.9",
    "reference_id": "12345",
    "target": "user@email.com",
    "request_status": "PENDING",
    "request_variables": {},
    "call_manager_sid": "LMc4b16a9df2ce33d84b3d30581fe6598c",
    "created_at": "2024-01-01T00:00:00Z",
    "sent_at": "2024-01-02T00:00:00Z",
    "attempt_count": 0,
    "session_id": 1,
    "conversation_id": 1,
    "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

Response

200
application/json
Successful Response
​
batch_id
string
required

Unique ID for conversation batch

Example:

"20250117.9"

​
reference_id
string
required

ID for target outreach (unique within batch)

Example:

"12345"

​
target
string
required

Target phone number or email address

Example:

"user@email.com"

​
request_variables
object
required

Variables for request

​
request_status
enum<string>

Status of request

Available options:
PENDING,
QUEUEING,
INITIATED,
CONNECTED,
FAILED,
CANCELED
​
call_manager_sid
string | null

Call manager SID

Example:

"LMc4b16a9df2ce33d84b3d30581fe6598c"

​
created_at
string

Timestamp of request creation

Example:

"2024-01-01T00:00:00Z"

​
sent_at
string | null

Timestamp at which request was sent

Example:

"2024-01-02T00: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

​
insights
object | null

Insights from call

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