API Reference
API Reference

Fetch Outbound Communication Batch Results

GET/api/v1/outbound/batches/{batch_id}/results

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

batch_id string path required

Query parameters

reference_id string | null query optional
status string | null query optional
insights_status string | null query optional

Responses

200Successful Response

application/json

response CommunicationRequestResult[] required
Item schema
itemsCommunicationRequestResultrequired
15 fields
reference_idstringrequired

ID for target outreach (unique within batch)

targetstringrequired

Target phone number

request_variablesobjectrequired

Variables for request

1 field
{key}stringoptional
channel_manager_sidstring | nulloptional

Channel manager SID

created_atstring (date-time)optional

Timestamp of request creation

sent_atstring (date-time) | nulloptional

Timestamp at which request was sent

attempt_countintegeroptional

Number of attempts for request

Default 0
session_idinteger | nulloptional

Unique ID for call session

conversation_idinteger | nulloptional

Unique ID for conversation

request_statusenum<string>optional

Status of request

Allowed values ["PENDING","DUPLICATE","INITIATED","CONNECTED","COMPLETED","FAILED","CANCELED","INVALID","SKIPPED"]Default PENDING
channel_manager_statusstring | nulloptional

Status of request in channel manager (see ChannelManagerStatus)

insights_statusstring | nulloptional

Status of session in insight workflow

insightsobject | nulloptional

Insights from call

1 options
{key}string | integer | numberoptional
3 options
Option 1stringoptional
Option 2integeroptional
Option 3numberoptional
line_typestring | nulloptional

Raw Twilio Lookup v2 line type of the target number (e.g. 'mobile', 'landline', 'fixedVoip', 'tollFree'); resolved at ingestion. 'unknown' means Twilio answered but could not determine the line type; None means no lookup data at all. See ALL_LINE_TYPES in lib/twilio/line_type_lookup.py for the full vocabulary.

enrichmentobject | nulloptional

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.

Response example
[
  {
    "reference_id": "string",
    "target": "string",
    "request_variables": "string",
    "channel_manager_sid": "string",
    "created_at": "string",
    "sent_at": "string",
    "attempt_count": 0,
    "session_id": "string",
    "conversation_id": "string",
    "request_status": "PENDING",
    "channel_manager_status": "string",
    "insights_status": "string",
    "insights": "string",
    "line_type": "string",
    "enrichment": "string"
  }
]
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}