Methods

Objects

sendr/10/campaign

Campaign Sendr Service (v1.0). Create and manage your campaigns.

Method Description
sendr/10/campaign.cancel_test_call Cancel test
sendr/10/campaign.check Check campaign properties (partial object). Checks a full or partial c...
sendr/10/campaign.delete Delete campaign
sendr/10/campaign.get Get campaign
sendr/10/campaign.get_object_template Get a "template" object for a specific campaign type with default valu...
sendr/10/campaign.get_test_call_status Get test status
sendr/10/campaign.get_voice_ivr_action_objects_templates Get IVR actions available
sendr/10/campaign.get_voice_survey_question_object_template Get an object template with default value for a survey question
sendr/10/campaign.list_types List campaign types
sendr/10/campaign.pause Pause campaign
sendr/10/campaign.save Save campaign
sendr/10/campaign.search Search campaigns
sendr/10/campaign.send_test_sms Test an SMS campaign on a phone number
sendr/10/campaign.start Start campaign
sendr/10/campaign.start_test_call Test a voice campaign on a phone number
sendr/10/campaign.stop Stop campaign

Methods

sendr/10/campaign.cancel_test_call

Description

Cancel test

Signature

method: sendr/10/campaign.cancel_test_call

params: [int id]

Parameters

Parameter Type Description NULL
id int Test call id NO

Result

Type Description Format/Object
bool Successness

sendr/10/campaign.check

Description

Check campaign properties (partial object). Checks a full or partial campaign object and returns any errors found with the set values.

Signature

method: sendr/10/campaign.check

params: [object campaign_partial_object]

Parameters

Parameter Type Description NULL
campaign_partial_object object Campaign object to check (can be partial)
Object: Sendr.10.Campaign
NO

Result

Type Description Format/Object
array array of errors

sendr/10/campaign.delete

Description

Delete campaign

Signature

method: sendr/10/campaign.delete

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Campaign ID NO

Result

Type Description Format/Object
bool True if deletion succeeded

sendr/10/campaign.get

Description

Get campaign

Signature

method: sendr/10/campaign.get

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Campaign ID NO

Result

Type Description Format/Object
object Campaign object Object: Sendr.10.Campaign

sendr/10/campaign.get_object_template

Description

Get a "template" object for a specific campaign type with default values.

Signature

method: sendr/10/campaign.get_object_template

params: [string type]

Parameters

Parameter Type Description NULL
type string Campaign type
Values: "SMS_SIMPLE", "SMS_SURVEY", "VOICE_IVR", "VOICE_SIMPLE", "VOICE_SURVEY"
NO

Result

Type Description Format/Object
object Template object Object: Sendr.10.Campaign

sendr/10/campaign.get_test_call_status

Description

Get test status

Signature

method: sendr/10/campaign.get_test_call_status

params: [int id]

Parameters

Parameter Type Description NULL
id int Test call id NO

Result

Type Description Format/Object
object Call status Object: Sendr.10.Campaign.TestCall

sendr/10/campaign.get_voice_ivr_action_objects_templates

Description

Get IVR actions available

Signature

method: sendr/10/campaign.get_voice_ivr_action_objects_templates

params: []

Parameters

No parameters.

Result

Type Description Format/Object
object IVR actions (object templates)

sendr/10/campaign.get_voice_survey_question_object_template

Description

Get an object template with default value for a survey question

Signature

method: sendr/10/campaign.get_voice_survey_question_object_template

params: []

Parameters

No parameters.

Result

Type Description Format/Object
object Question object template Object: Sendr.10.Campaign.Ivr.Voice.Survey.Question

sendr/10/campaign.list_types

Description

List campaign types

Signature

method: sendr/10/campaign.list_types

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array Campaign types available

sendr/10/campaign.pause

Description

Pause campaign

Signature

method: sendr/10/campaign.pause

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Campaign ID NO

Result

Type Description Format/Object
object Campaign status Object: Sendr.10.Campaign.Status

sendr/10/campaign.save

Description

Save campaign

Signature

method: sendr/10/campaign.save

params: [object campaign_partial_object]

Parameters

Parameter Type Description NULL
campaign_partial_object object Campaign object . Object can be partial for editing.
Object: Sendr.10.Campaign
NO

Result

Type Description Format/Object
object The complete campaign object Object: Sendr.10.Campaign

sendr/10/campaign.search

Description

Search campaigns

Signature

method: sendr/10/campaign.search

params: [object filters, object options]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: Sendr.10.Campaign.SearchFilters
NO
options object Search options
Object: Search.Options
NO

Result

Type Description Format/Object
object Search results Object: Search.Results

sendr/10/campaign.send_test_sms

Description

Test an SMS campaign on a phone number

Signature

method: sendr/10/campaign.send_test_sms

params: [string number, object campaign_partial_object, array fields]

Parameters

Parameter Type Description NULL
number string Phone number to call
Format: phone_number (International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", or "+33678912345")
NO
campaign_partial_object object Campaign object (can be partial)
Object: Sendr.10.Campaign
NO
fields array Addressbook fields for dynamic text or SMS ($A, $B, etc.) NO

Result

Type Description Format/Object
string SMS id Format: hash (Unique object identifier)

sendr/10/campaign.start

Description

Start campaign

Signature

method: sendr/10/campaign.start

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Campaign ID NO

Result

Type Description Format/Object
object Campaign status Object: Sendr.10.Campaign.Status

sendr/10/campaign.start_test_call

Description

Test a voice campaign on a phone number

Signature

method: sendr/10/campaign.start_test_call

params: [string number, object campaign_partial_object, array fields]

Parameters

Parameter Type Description NULL
number string Phone number to call
Format: phone_number (International E.164 format "+CCNSN". Example: "+16467890800", "+447890123456", or "+33678912345")
NO
campaign_partial_object object Campaign object (can be partial)
Object: Sendr.10.Campaign
NO
fields array Addressbook fields for dynamic text ($A, $B, etc.) NO

Result

Type Description Format/Object
object Test Call object Object: Sendr.10.Campaign.TestCall

sendr/10/campaign.stop

Description

Stop campaign

Signature

method: sendr/10/campaign.stop

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Campaign ID NO

Result

Type Description Format/Object
object Campaign status Object: Sendr.10.Campaign.Status