Campaign Manager API

This page contains simple examples for the Campaign Manager REST API

This API has been developed in accordance with the OpenAPI specification defined here.

To generate your own client libs, click here.

Curl

curl \
  -u'username:password' \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -X POST \
  -d '{"name":"Campaign Name", "content":"Hello, World!", "schedule":"2016-07-21T12:00:00+12:00", "members":[{"destination":"+61411111111"}]}' \
  https://api.sms.optus.com.au/rest/campaign_manager/v1/application_name/scheduled_campaigns

Output:

{"id":49695}

PHP

<?php
require_once(__DIR__ . '/vendor/autoload.php');
 
$username = "username";
$password = "password";
$application_name = "application_name";
$schedule = (new \DateTime('next minute'))->format(DateTime::RFC3339);
$destination = "+614111111111";
 
// Configure HTTP basic authorization: BasicAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setUsername($username);
Swagger\Client\Configuration::getDefaultConfiguration()->setPassword($password);
 
$api_instance = new Swagger\Client\Api\DefaultApi();
 
$campaign = new \Swagger\Client\Model\ScheduleCampaignRequest(); // \Swagger\Client\Model\ScheduleCampaignRequest |
$campaign->setContent("Hello, World!");
$campaign->setName("Campaign Name");
$campaign->setSchedule($schedule);
 
$members = array();
$member = new \Swagger\Client\Model\Member();
$member->setDestination($destination);
$members[] = $member;
 
$campaign->setMembers($members);
try {
    $result = $api_instance->scheduleCampaign($application_name, $campaign);
    printf("Campaign Created: id %d", $result->getId());
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->scheduleCampaign: ', $e->getMessage(), PHP_EOL;
    echo $e->getResponseObject();
}

Output:

Campaign Created: id 49695