Programs, Schedules & Metrics
Programs
A Program is designated to an individual Business Unit and manages the delivery of Branded Communication solutions. Active/Inactive Status and TTLs can be controlled at the Program. The following endpoints are available at the Program level:
A GET action returning all programs associated with a given Business Unit.
A POST action allowing for the creation of a new program. Program creation requires the designation of Call Purpose and Daily Call Count Estimates, mappings of these fields are shown below in the Program Reference Data section.
A GET action returning available details for the specified program (i.e. active/inactive status, program name, daily call count estimates)
A PUT action providing the ability to alter an existing program.
A DELETE action removing the specified program.
Program Schedules
A collection of endpoints providing controls over the start date/time and end date/time of programs.
A GET action returning all schedules associated with a particular program.
A POST action allowing the creation of a new program schedule.
A GET action returning the details of a specified schedule.
A PUT action providing the ability to alter an existing schedule.
A DELETE action that removes an existing schedule.
Program Metrics Endpoint
Metrics associated with a specified Program can be called, aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Program Metrics API reference.
outputType
Each metrics request requires a designated "outputType" (i.e. daily, monthly, or all-time), returning metrics associated with the specified timeframe.
Sample Program metrics response body below
{
"body": {
"programMetricsSummaries": [
{
"programId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
},
{
"programId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
"metrics": [
{
"answerRate": 0.34526357,
"declineRate": 0.12345,
"totalTreatedCalls": 123453
}
]
}
]
},
"error": null
}
Program Delivery Channels
A GET action that returns the Delivery Channel object.
A GET action that returns details of a CallerName (long name, description, short name) associated with a Program's Delivery Channel.
A POST action that creates a new CallerName for a program's Delivery Channel.
A PUT action that updates the details of a CallerName associated with a program's delivery channel.
A DELETE action that deletes all the elements of a program for a specific Delivery Channel associated with that program's CallerName.
Program Reference Data
A GET action that returns the Call Purpose associated with a Program.
A GET action that returns the Daily Call Count ranges associated with a program. Resets daily.
See example program reference data response below:
{
"body":{
"dailyCallCountRanges":[
{
"rangeId":1,
"range":"Up to 100",
"displayOrder":1
},
{
"rangeId":2,
"range":"Up to 500",
"displayOrder":2
}
]
}
}
Call count ranges:
rangeId | range | displayOrder |
---|---|---|
1 | Unknown | 1 |
2 | Up to 100 | 2 |
3 | Up to 500 | 3 |
4 | Up to 1,000 | 4 |
5 | Up to 5,000 | 5 |
6 | Up to 10,000 | 6 |
7 | Up to 25,000 | 7 |
8 | Up to 50,000 | 8 |
9 | Up to 100,000 | 9 |
10 | Up to 250,000 | 10 |
11 | Up to 500,000 | 11 |
12 | Up to 1,000,000 | 12 |
13 | More than 1,000,000 | 13 |
Updated about 2 months ago