Sign in

Welcome.
How can we help?

Developer API: /customers/campaigns

Topic: , Updated:

This resource is used to handle campaigns.

GET

Mandatory parameters

NameTypeDescription
customer_id int Freespee's unique ID for customer.

Optional parameters

NameTypeDescription
campaign_id int Freespee's unique ID for campaign.

Output

NameTypeDescription
name string Name of campaign.
email string Email address (for notifications).
smsnumber string SMS number (for notifications).
campaign_id int Freespee's unique ID for campaign.
partner_campaign_id string Partner's unique ID for campaign.
timestamp string Campaign creation timestamp.
expire string Campaign expire timestamp.
pricing_model_id string Unique ID for pricing model.
notify_on_missed_call int Send notification on missed call, 1=true, 0=false.
notify_on_answered_call int Send notification on answered call, 1=true, 0=false.
notify_on_new_voicemail int Send notification on new voicemail, 1=true, 0=false.
vm_divert_all int Divert all calls to voicemail, 1=true, 0=false.
vm_divert_busy int Divert calls to voicemail when busy, 1=true, 0=false.
vm_divert_noanswer int Divert calls to voicemail when no answer, 1=true, 0=false.
call_recording int Enable call recording, 1=true, 0=false.
sources array Array of sources attached to this campaign.
vm_greeting_id int Voicemail greeting ID.
state int Campaign state. 0=active, 1=upcoming, 2=archived.

POST

Mandatory parameters

NameTypeDescription
customer_id int Freespee's unique ID for customer.
pricing_model_id string Unique ID for pricing model.
name string Name of campaign.

Optional parameters

NameTypeDescription
email string Email address (for notifications).
smsnumber string SMS number (for notifications).
campaign_id int Freespee's unique ID for campaign.
partner_campaign_id string Partner's unique ID for campaign.
timestamp string Campaign creation timestamp.
expire string Campaign expire timestamp.
notify_on_missed_call int Send notification on missed call, 1=true, 0=false.
notify_on_answered_call int Send notification on answered call, 1=true, 0=false.
notify_on_new_voicemail int Send notification on new voicemail, 1=true, 0=false.
vm_divert_all int Divert all calls to voicemail, 1=true, 0=false.
vm_divert_busy int Divert calls to voicemail when busy, 1=true, 0=false.
vm_divert_noanswer int Divert calls to voicemail when no answer, 1=true, 0=false.
call_recording int Enable call recording, 1=true, 0=false.
vm_greeting_id int Voicemail greeting ID.

Output

Same as GET.

PUT

Mandatory parameters

NameTypeDescription
customer_id int Freespee's unique ID for customer.
campaign_id string Freespee's unique ID for campaign.

Optional parameters

NameTypeDescription
name string Name of campaign.
email string Email address (for notifications).
smsnumber string SMS number (for notifications).
campaign_id int Freespee's unique ID for campaign.
partner_campaign_id string Partner's unique ID for campaign.
timestamp string Campaign creation timestamp.
expire string Campaign expire timestamp.
notify_on_missed_call int Send notification on missed call, 1=true, 0=false.
notify_on_answered_call int Send notification on answered call, 1=true, 0=false.
notify_on_new_voicemail int Send notification on new voicemail, 1=true, 0=false.
vm_divert_all int Divert all calls to voicemail, 1=true, 0=false.
vm_divert_busy int Divert calls to voicemail when busy, 1=true, 0=false.
vm_divert_noanswer int Divert calls to voicemail when no answer, 1=true, 0=false.
call_recording int Enable call recording, 1=true, 0=false.
vm_greeting_id int Voicemail greeting ID.

Output

Same as GET.

DELETE

Mandatory parameters

NameTypeDescription
customer_id int Freespee's unique ID for customer.
campaign_id string Freespee's unique ID for campaign.

Optional parameters

None.

Output

N/A.

Was this article helpful?
0 out of 0 found this helpful

Comments


Not the answer to your question?

Powered by Zendesk