Overview
This section details a sequence of API requests to quickly create all the necessary elements to initiate an INFORM Program.
Included Endpoints
| Step | Endpoint | Path Parameters |
|---|---|---|
| Request Authentication Token | v1/auth | |
| Add Business Unit | exchange/v1/businesses/{businessId}/business-units | businessId |
| Create Program | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs | businessId businessUnitId |
| Create New CallerName Delivery Channel | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerName | businessId businessUnitId programID deliveryChannelType (callerName) |
| Create New Program Schedule | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/schedules | businessId businessUnitId programID |
| Add New CallerName aNumber | exchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerName/a-numbers | businessId businessUnitId programID deliveryChannelType (callerName) |
| Optional: Pre-Call Program Content Prep | exchange/v1/calls/push |
API Call Sequence Diagram
The Following sequence diagram details the API requests necessary, and in what order, to add a business unit and start branding your calls after you've had your business approved.
Sequence Diagram to Brand Calls for an Approved Businesse
API Code Sample Recipes
The following recipes cover the details around the API Calls in the sequence diagram above (with the additional Pre-Call Content Prep step) in sequential order:
Step 1
Initial Authentication
Open Recipe
Step 2
Create a Business Unit
Open Recipe
Step 3
Create an Inform Program
Open Recipe
Step 4
Create Inform Delivery Channel
Open Recipe
Step 5
Add Inform Program Schedule
Open Recipe
Step 6
Add New Inform aNumber
Open Recipe
Step 7 (Optional)
Push Pre-Call Program Prep
Open Recipe
Now check out the API Reference Page and plug in your own variables!
