Call Scheduling and Pacing API
- NEW! - Interactive API docs, now live!
Visit api-docs.plumvoice.com to read Plum API documentation, build and test requests in our interactive API sandbox, review the responses, and share it all with your team.
IMPORTANT: Development on this API is ongoing – please bear in mind that additional, unforeseen changes may occur between the time of this writing and product release.
The Outbound Call Scheduling and Pacing API allows you to create outbound calling campaigns as well as reusable resources to define schedules and call pacing for each campaign. This API consists of three main resources:
- Schedules: Sets the days of the week that your campaign will run. Once created, a schedule can be reused across one or more campaigns.
- Profiles: Sets call pacing for your campaign. Once created, a profile can be reused across one or more campaigns. One or multiple profiles can be used in a single campaign if desired.
- Campaigns: Creates outbound calling campaigns linked to your chosen VXML application. Also controls existing campaign activity. Existing schedules and profiles are linked to campaigns during campaign creation.
This API contains the following endpoints (6 total):
- https://scheduler.plumvoice.com/api/schedules
- https://scheduler.plumvoice.com/api/profiles
- https://scheduler.plumvoice.com/api/campaigns
- https://scheduler.plumvoice.com/api/campaigns/start
- https://scheduler.plumvoice.com/api/campaigns/stop
- https://scheduler.plumvoice.com/api/campaigns/add-calls
API requests are authenticated using a bearer token. Currently, this token will be generated for you. In the future, users will be able to generate their own bearer tokens as needed.
NOTE: In each of the following methods, you can view an example request and success response by expanding the Responses section and viewing the 200: OK response.
NOTE: The example cURL commands in each API method below use a back slash (
\) as a line continuation character. The back slash may be removed or replaced based on your operating system (e.g., replace with (^) for Windows cmd, (`) for Powershell).post
https://scheduler.plumvoice.com/api
/schedules
Create Schedule
get
https://scheduler.plumvoice.com/api
/schedules
Get Schedules
patch
https://scheduler.plumvoice.com/api
/schedules/{id}
Update Schedule
delete
https://scheduler.plumvoice.com/api
/schedules/{id}
Delete Schedule
post
https://scheduler.plumvoice.com/api
/profiles
Create Profile
get
https://scheduler.plumvoice.com/api
/profiles
Get Profiles
patch
https://scheduler.plumvoice.com/api
/profiles/{id}
Update Profile
delete
https://scheduler.plumvoice.com/api
/profiles/{id}
Delete Profile
post
https://scheduler.plumvoice.com/api
/campaigns
Create Campaign
get
https://scheduler.plumvoice.com/api
/campaigns
Get Campaigns
post
https://scheduler.plumvoice.com/api
/campaigns/start
Start Campaign
post
https://scheduler.plumvoice.com/api
/campaigns/stop
Stop Campaign
post
https://scheduler.plumvoice.com/api
/campaigns/add-calls
Add Calls
patch
https://scheduler.plumvoice.com/api
/campaigns/{id}
Update Campaign
delete
https://scheduler.plumvoice.com/api
/campaigns/{id}
Delete Campaign
Last modified 5mo ago