📞
API Docs
  • Welcome
  • NUMBERS / ORDERING
    • List Areas
    • List Numbers
    • Order Numbers - No Cart
    • Delete Numbers
    • Change Call Forward
    • Vanity Tollfree - Search
    • Vanity Toll Free - Order
  • Shopping Cart Ordering
    • Add Number to Cart
    • List Numbers in Cart
    • Delete Number from Cart
    • Complete Order Cart
  • MY INVENTORY
    • List My Nmbers
    • List Call Flows
    • Change CallFlow
    • CDR Records
  • SMS/MMS
    • Send SMS
    • Send MMS
    • Receive SMS/MMS
    • Receive Delivery Receipts
  • Campaigns
    • Submit TollFree Campaign
  • CALL APIS
    • Calls
    • Set Incoming URL
    • Incoming Calls
    • Listing Calls
    • Making Calls
      • Example Code
        • Outbound to Tel#
        • Outbound to SIP Device
        • Example Responses
    • Modifying Live Calls
      • Examples
    • Recordings
      • Get List of Recordings
      • Delete a Recording
  • CALL API MARKUP
    • API Call Markup Language
      • Say
      • Dial
        • Number
        • Client
        • SIP
      • Play
      • Gather
      • Record
      • Hangup
      • Pause
      • Reject
      • Redirect
  • LOOKUPS
    • Carrier and CNAM
  • Number Portability
    • Validate Portability
    • Lookup Port Request
    • Submit Port Request
  • FAXING
    • Create Outbound Fax
    • Lookup Outbound Fax Status
    • List Faxes
    • Download File
  • registered agent
    • List Companies
    • List Registered Agents
    • List Documents
    • Download Document
    • Create Company
    • Delete Company
    • Create Registered Agent
    • Modify Registered Agent
Powered by GitBook
On this page
  1. Campaigns

Submit TollFree Campaign

SMS Enable a toll free number by submitting a campaign request for it

GET or POST Request

https://v1.api19.com/campaigns/tollfree/submit

Argument

Required

Type

did

yes

the number you're activating SMS on

businessname

yes

string

firstname

yes

string

lastname

yes

string

contactemail

yes

string

contactphone

yes

string

website

yes

string

address1

yes

string

address2

no

string

city

yes

string

state

yes

string

zip

yes

string

usecase

yes

Summarize the Use Case

optininfo

yes

How will handsets be opting-in to SMS program? (Please provide proof of opt-in. You may provide a screenshot if opt-in is not visible from URL provided. Images may be uploaded at the bottom of the page. NOTE: consent from end user to receive SMS must be explicit.)

messagecontent

yes

Please provide sample message content for this campaign

wherepublished

yes

Tell us where the number will be published (website link, billboard)

urls_messagecontent

yes

List any urls that will be in the message content

numbers_messagecontent

yes

List any phone numbers that will be in the message content

enable_canada

no

Allow Canadian traffic

yes / no

advertising

no

This number will have Marketing/Advertising in messages yes / no

fortune500

no

This company is a fortune 100 or fortune 500 company yes / no

donations

no

This number will be asking for Donations / Collections yes / no

donations_data

no

if donations is yes: Please provide the Tax-ID, and non-profit website All other information on this form must match this non-profit

msgvolume

yes

Daily Message Volume

file1_url

no

http url - if you want to attach an image to the campaign

file2_url

no

http url - if you want to attach an image to the campaign

key

yes

your api key

Send a POST with all of the information required from above

curl -X POST https://v1.api19.com/campaigns/tollfree/submit \
  -d "key=2h9fh23f23f2" \
  -d "did=8883038888" \
  -d "businessname=Acme Corporation" \
  -d "firstname=John" \
  -d "lastname=Doe" \
  -d "contactemail=john.doe@example.com" \
  -d "contactphone=1234567890" \
  -d "website=https://www.acme-corp.com" \
  -d "address1=123 Main Street" \
  -d "address2=Apt 4B" \
  -d "city=Metropolis" \
  -d "state=NY" \
  -d "zip=10001" \
  -d "usecase=Marketing Campaign" \
  -d "optininfo=customer opt in by calling our 800 number, and ...." \
  -d "messagecontent=Hello, this is a test message for our campaign!" \
  -d "wherepublished=Social Media" \
  -d "urls_messagecontent=https://www.example.com/test-message" \
  -d "numbers_messagecontent=5551234" \
  -d "enable_canada=true" \
  -d "advertising=yes" \
  -d "fortune500=no" \
  -d "donations=yes" \
  -d "donations_data=Charity Drive 2023, TIN 87-1771212" \
  -d "msgvolume=500000" \
  -d "file1_url=http://mypic.com/screenshot.jpg" \
  -d "file2_url=http://mypic.com/screenshot2.jpg" 
{"status":"ok"}

OR

{"status":"error","error":"Missing required fields: lastname"}

OR

{"status":"error", "error":"you do not own this number"}
PreviousReceive Delivery ReceiptsNextCalls

Last updated 1 month ago