sms_broadcast

Time	Status	User Agent
Retrieving recent requests…

callerid_choice

string

enum

required

Defaults to exists

Type of callerid option

Allowed:

callerid

string

required

CallerId for the campaign to receive and send messages. Required Phone number in E.164 format when callerid_choice="exists"

phonebook

array of strings

required

Array of phonebook assign to the campaign

phonebook*

text_message

string

required

auto_replies

array of objects

required

Put [] if not required

auto_replies*

timezone_choices

string

Defaults to User Profile Settings e.g., "America/Chicago"

use_contact_tz

string

enum

Defaults to campaign_timezone

Defaults to Campaign Timezone

Allowed:

startingdate

string

Starting Date for the campaign YYYY-MM-DD HH:MM:SS

expirationdate

string

Expiration date for the campaign YYYY-MM-DD HH:MM:SS

sender_name

string

For non-US countries supporting alphanumeric sender IDs

country_iso

string

Two-letter ISO country code

daily_start_time

string

required

Defaults to 08:00

Daily start time for the campaign "HH:MM" format

daily_stop_time

string

required

Defaults to 21:00

Daily Stop time for the campaign "HH:MM" format

dont_text_dnc

string

Skip Federal DNC numbers

dont_text_litigator

string

Skip litigator numbers

opt_out_language

string

enum

Defaults to en

Allowed:

help_compliance_message

string

Defaults to Reply STOP to unsubscribe

Compliance text

name

string

Name of the campaign

monday

string

Defaults to on