Getting Started with Branded Communication APIs

Overview

This section details a sequence of API requests to quickly create all the necessary elements to initiate an INFORM Program.

Included Endpoints

StepEndpointPath Parameters
Request Authentication Tokenv1/auth
Add Business Unitexchange/v1/businesses/{businessId}/business-unitsbusinessId
Create Programexchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programsbusinessId
businessUnitId
Create New CallerName Delivery Channelexchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerNamebusinessId
businessUnitId
programID
deliveryChannelType (callerName)
Create New Program Scheduleexchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/schedulesbusinessId
businessUnitId
programID
Add New CallerName aNumberexchange/v1/businesses/{businessId}/business-units/{businessUnitId}/programs/{programId}/delivery-channels/callerName/a-numbersbusinessId
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.

1436

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

Step 2

Step 3

Step 4

Step 5

Step 6

Step 7 (Optional)

Now check out the API Reference Page and plug in your own variables!