ASasksyllable
outbound.batches

Fetch Outbound Communication Batch Results

Changed on
get/api/v1/outbound/batches/{batch_id}/results

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/outbound/batches/{batch_id}/results
  • Auth
    API key in header Syllable-API-Key

Path parameters

batch_idstring required

Query parameters

reference_idstring nullable
statusstring nullable
insights_statusstring nullable

Response

Successful Response

reference_idstring required

ID for target outreach (unique within batch)

targetstring required

Target phone number

request_variablesobject required

Variables for request

channel_manager_sidstring nullable

Channel manager SID

created_atstring date-time

Timestamp of request creation

sent_atstring date-time nullable

Timestamp at which request was sent

attempt_countinteger

Number of attempts for request

session_idinteger nullable

Unique ID for call session

conversation_idinteger nullable

Unique ID for conversation

request_status'PENDING' | 'DUPLICATE' | 'INITIATED' | 'CONNECTED' | 'COMPLETED' | 'FAILED' | 'CANCELED' | 'INVALID' | 'SKIPPED'

Status of a communication request.

channel_manager_statusstring nullable

Status of request in channel manager (see ChannelManagerStatus)

insights_statusstring nullable

Status of session in insight workflow

insightsobject nullable

Insights from call

line_typestring nullable

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 nullable

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 response

[
  {
    "reference_id": "12345",
    "target": "512-555-1234",
    "channel_manager_sid": "LMc4b16a9df2ce33d84b3d30581fe6598c",
    "created_at": "2026-11-01T00:00:00Z",
    "sent_at": "2026-11-02T00:00:00Z",
    "session_id": 1,
    "conversation_id": 1,
    "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"
    }
  }
]

Changes

  • e5def85f259cRevision changes
    • info

      added the optional property / to the response with the status

  • 4827e4fc5f78Revision changes
    • warning

      added the new SKIPPED enum value to the / response property for the response status

    • info

      added the optional property / to the response with the status