RESTful Outbound Campaign Interface (OBI)

This interface provides the ability to view, manage, and control campaigns.

/campaigns

Resource Request method Object: required rights

/campaigns

GET

Outbound campaign: View

/campaigns/{campaignId}

PUT

Outbound campaign: Modify

GET

Outbound campaign: View
/campaigns/{campaignId}/status

PUT

Outbound campaign: Modify

/campaigns/{campaignId}/customerResultStatistics

GET

Outbound campaign: View and Statistics summary

/campaigns/{campaignId}/customers

GET

  • Outbound campaign: View

  • Outbound customer: View

POST

  • Outbound campaign: View or Modify

  • Outbound customer: Create or Modify

/campaigns/{campaignId}/customers/{customerId}

GET

  • Outbound campaign: View

  • Outbound customer: View

DELETE

  • Outbound campaign: View

  • Outbound customer: Delete

/campaigns/{campaignId}/customers/list

POST

  • Outbound campaign: View or Modify

  • Outbound customer: Create or Modify

/statistics

Resource Request method Object: required rights

/statistics

GET

User: Statistics summary