Methods

Objects

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

Methods

.cancel_test_call

Description

Cancel test

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .cancel_test_call

params: [int id]

Parameters

Parameter Type Description NULL
id int Test call id NO

Result

Type Description Format/Object
bool Successness

.check

Description

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

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.delete

Description

Delete campaign

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .delete

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Campaign ID NO

Result

Type Description Format/Object
bool True if deletion succeeded

.get

Description

Get campaign

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.get_object_template

Description

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

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.get_test_call_status

Description

Get test status

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.get_voice_ivr_action_objects_templates

Description

Get IVR actions available

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .get_voice_ivr_action_objects_templates

params: []

Parameters

No parameters.

Result

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

.get_voice_survey_question_object_template

Description

Get an object template with default value for a survey question

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.list_types

Description

List campaign types

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .list_types

params: []

Parameters

No parameters.

Result

Type Description Format/Object
array Campaign types available

.pause

Description

Pause campaign

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.save

Description

Save campaign

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.search

Description

Search campaigns

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.send_test_sms

Description

Test an SMS campaign on a phone number

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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)

.start

Description

Start campaign

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.start_test_call

Description

Test a voice campaign on a phone number

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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

.stop

Description

Stop campaign

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .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