Get Outbound Communication Campaign

GET /api/v1/outbound/campaigns/{campaign_id}

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.outbound.campaigns.getById({
    campaignId: 11227,
  });

  console.log(result);
}

run();

200

{
  "campaign_name": "Outbound Campaign 1",
  "campaign_variables": {
    "key": "value",
    "key2": "value2"
  },
  "caller_id": 19995551234,
  "active_days": "[\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"]",
  "id": 1,
  "last_updated_by": "[e-mail]",
  "description": "This is a test campaign",
  "mode": "voice",
  "sms_session_ttl": 720,
  "label": "test",
  "labels": [
    "test",
    "demo"
  ],
  "daily_start_time": "09:00:00",
  "daily_end_time": "17:00:00",
  "source": "[phone]",
  "hourly_rate": 25,
  "max_daily_calls": 2500,
  "retry_count": 1,
  "retry_interval": "30m",
  "outreach_override_rules": {
    "dates": {
      "2026-11-26": {
        "active": false
      }
    },
    "days": {
      "fri": {
        "daily_end_time": "15:00:00",
        "max_daily_calls": 1300
      },
      "sat": {
        "max_daily_calls": 0
      },
      "thu": {
        "max_daily_calls": 1300
      }
    }
  },
  "voicemail_detection": {
    "voicemail_detection_overall_timeout": 30,
    "voicemail_detection_post_speech_timeout": 1.75,
    "voicemail_detection_pre_speech_timeout": 3.5
  },
  "allowed_line_types": [
    "mobile",
    "voip"
  ],
  "include_unknown_line_types": true,
  "target_filters": {
    "match": "any",
    "on_unknown": "include",
    "rules": [
      {
        "field": "line_type",
        "op": "in",
        "values": [
          "landline",
          "fixedVoip",
          "nonFixedVoip"
        ]
      },
      {
        "field": "carrier_name",
        "op": "in",
        "values": [
          "Onvoy, LLC - Sinch"
        ]
      }
    ]
  },
  "agent_id": "agent_id",
  "created_at": "2026-09-17T00:00:00Z",
  "updated_at": "2026-09-17T00:00:00Z",
  "webhooks": {
    "id": 1,
    "request_method": "POST",
    "trigger_statuses": [
      "COMPLETED"
    ],
    "url": "https://example.com/hooks/syllable"
  }
}

Authorizations

Syllable-API-Key · string · header · required

Path Parameters

campaign_id · integer · required

Response

200

application/json

Successful Response

campaign_name · string · required

Human readable name of campaign

Example:

"Outbound Campaign 1"

campaign_variables · Campaign Variables · object · required

Variables for campaign

Show child attributes

Example:

{ "key": "value", "key2": "value2" }

caller_id · string | null · required

Caller ID for call

Example:

19995551234

active_days · enum<string>[] · required

Days of the week when campaign is active

Enum representing days of the week.

Available options: mon, tue, wed, thu, fri, sat, sun

Example:

"[\"mon\", \"tue\", \"wed\", \"thu\", \"fri\"]"

id · integer · required

Unique ID for campaign

Example:

1

last_updated_by · string · required

Email of user who last updated campaign

Example:

"[e-mail]"

description · string | null

Description of campaign

Example:

"This is a test campaign"

mode · string | null

Mode of the campaign (e.g. voice, sms, email)

Example:

"voice"

sms_session_ttl · integer | null

Time to live for SMS session in minutes

Example:

720

label · string | null · deprecated

Label for campaign (DEPRECATED - use labels instead)

Example:

"test"

labels · string[] | null

Labels for campaign

Example:

["test", "demo"]

daily_start_time · string | null

Start time of campaign each day

Example:

"09:00:00"

daily_end_time · string | null

End time of campaign each day

Example:

"17:00:00"

source · string | null

Source phone number, email, or SMS number

Example:

"[phone]"

hourly_rate · integer · default: 1

Target number of outreach calls per hour

Required range: 1 <= x <= 3600

Example:

25

max_daily_calls · integer | null

Maximum number of outreach calls per day

Example:

2500

retry_count · integer · default: 0

Number of retries per target

Example:

1

retry_interval · string | null

How long to wait before retrying

Example:

"30m"

outreach_override_rules · OutreachOverrideRules · object | null

Weekday- and date-specific outreach windows and daily maximums. The most specific rule wins: date, then weekday, then the campaign defaults above. Omitted or null means the campaign defaults apply to every active day.

Show child attributes

Example:

{
  "dates": { "2026-11-26": { "active": false } },
  "days": {
    "fri": {
      "daily_end_time": "15:00:00",
      "max_daily_calls": 1300
    },
    "sat": { "max_daily_calls": 0 },
    "thu": { "max_daily_calls": 1300 }
  }
}

voicemail_detection · VoicemailDetectionConfig · object | null

Config for voicemail detection for voice campaigns. Set to None to disable.

Show child attributes

Example:

{
  "voicemail_detection_overall_timeout": 30,
  "voicemail_detection_post_speech_timeout": 1.75,
  "voicemail_detection_pre_speech_timeout": 3.5
}

allowed_line_types · enum<string>[] | null

Line-type buckets this campaign is allowed to dial. Empty or omitted means no filter (all line types are dialed).

Friendly line-type buckets a campaign can be restricted to dial.

These map to raw Twilio Lookup v2 line types via lib.twilio.line_type_lookup.LINE_TYPE_BUCKETS.

Available options: mobile, landline, voip

Example:

["mobile", "voip"]

include_unknown_line_types · boolean · default: true

When a line-type filter is active, whether to also dial numbers whose line type is unknown or could not be classified. Has no effect when allowed_line_types is empty.

Example:

true

target_filters · TargetFilters · object | null

Generic target filter (a flat rule list over request enrichment attributes such as line_type, caller_type, caller_name, carrier_name, mcc, mnc). When set, takes precedence over allowed_line_types / include_unknown_line_types. Omitted or null means those legacy fields are used instead. Rules on caller_type / caller_name are resolved by Twilio's separately billed caller_name (CNAM) lookup, which only returns data for US numbers.

Show child attributes

Example:

{
  "match": "any",
  "on_unknown": "include",
  "rules": [
    {
      "field": "line_type",
      "op": "in",
      "values": ["landline", "fixedVoip", "nonFixedVoip"]
    },
    {
      "field": "carrier_name",
      "op": "in",
      "values": ["Onvoy, LLC - Sinch"]
    }
  ]
}

agent_id · integer | null

ID of agent assigned to campaign

Example:

"agent_id"

created_at · string<date-time>

Timestamp of campaign creation

Example:

"2026-09-17T00:00:00Z"

updated_at · string<date-time>

Timestamp of campaign update

Example:

"2026-09-17T00:00:00Z"

webhooks · OutboundCampaignWebhookResponse · object[] | null

Webhooks for campaign

Show child attributes

Example:

{
  "id": 1,
  "request_method": "POST",
  "trigger_statuses": ["COMPLETED"],
  "url": "https://example.com/hooks/syllable"
}