REST API Overview
Data Hierarchy
The Branded Communication API offers a single point of entry into First Orion's INFORM solution, 1/3 of United States devices. The API is structured under the following top-down hierarchy:
Create and Manage Businesses
A Business is represented in the BC API as an object containing the information needed for business registration. This includes information relevant to legal identification, addresses, contacts, and the context of the business, as shown below:
An API user can create, update, and get information about businesses via the Branded Communication Business endpoints.
Note: Only users with Partner permissions may access the endpoints used to create and manage businesses via API.
There are five business endpoints aside from the primary Business endpoint used for creation and management:
Business Reference Data
Below are the values representing information required for the business industry and employee count information submitted during business registration.
Service Grants
Service grants represent, and gate access to, the different distribution paths through which your business is sending branded calling. This is present on the business object.
| Service Grant | Meaning |
|---|---|
| "CT" | Your business numbers are being registered for First Orion to mitigate scam tagging on the T.Mobile network. All businesses have this added by default, and is the base requirement for having access to the branded calling platform. |
| "CE" | Branded calling numbers registered to a callername in an INFORM program are being distributed through the T.Mobile network. |
| "ATT" | CE service with additional ATT network distribution (requires CE grant) |
| "VZW" | CE service with additional Verizon network distribution (requires CE grant) |
*require extra authentication from First Orion Support
Business Industries
| industryId | industry | displayOrder |
|---|---|---|
| 12 | Automotive | 1 |
| 17 | Business Services | 2 |
| 4 | Delivery/Shipping | 3 |
| 1 | Education | 4 |
| 7 | Financial | 5 |
| 5 | Government | 6 |
| 6 | Health Care | 7 |
| 18 | Hospitality/Entertainment | 8 |
| 19 | Insurance | 9 |
| 10 | Legal | 10 |
| 20 | Manufacturing | 11 |
| 24 | Non-Profit | 12 |
| 16 | Personal Services | 13 |
| 8 | Public Service | 14 |
| 9 | Real Estate | 15 |
| 13 | Religious | 16 |
| 11 | Restaurant/Food Services | 17 |
| 3 | Retail | 18 |
| 23 | Technology | 19 |
| 22 | Telecommunications | 20 |
| 15 | Trade Contractors | 21 |
| 2 | Transportation | 22 |
| 25 | Travel | 23 |
| 26 | Utilities | 24 |
| 14 | Veterinary Services | 25 |
| 21 | Other Businesses | 26 |
| 27 | Prison | 27 |
Employee Count ranges
| rangeId | range | displayOrder |
|---|---|---|
| 1 | 1-10 employees | 2 |
| 2 | 11-50 employees | 3 |
| 3 | 51-200 employees | 4 |
| 4 | 201-500 employees | 5 |
| 5 | 501-1000 employees | 6 |
| 6 | 1001-5000 employees | 7 |
| 7 | 5001-10,000 employees | 8 |
| 8 | 10,001 + employees | 9 |
| 9 | Unknown | 1 |
Create and Manage Business Units
A Business Unit is represented in the Branded Communication API as simply its name. The successful activation of a business is required for Business Unit creation and management. Creating a business unit is a required step before program creation. There is one Business Unit endpoint used to create and manage the information associated with a business unit.
Create and Manage Branded Communication Programs
A Program is represented in the Branded Communication API by the purpose of the program, the estimated daily call count, and its schedule. There is an optional flag on the program object to allow for the use of PAIRED pre-call authenticated delivery.
There are three endpoints used to manipulate the information used in the Program Object:
Call Purpose Code
| callPurposeCode | Description |
|---|---|
| CS | Customer Service |
| DC | Debt Collection |
| EN | Informational / Notification |
| NP | Charity |
| OB | Multi-Use Line |
| PO | Political |
| PR | Prison |
| S6 | Do Not Originate |
| SR | Survey |
| TM | Telemarketing |
Daily Estimated Call Count Range
| 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 |
Delivery Channel Endpoints Overview
Branded Communication Delivery Channels represent how the end call will be displayed and to what channel(s) the calls will be distributed.
Phone Numbers Endpoints Overview
The Phone Number object is represented similarly to Branded Communication programs with the addition of the relationship object used to map the phone number to associated businesses and programs:
Call Purpose codes are the same as program call purpose codes.
There are three endpoints used to manipulate the information and entities associated with a phone number:
Pre-Call Push Overview
Pre-Call authentication is used to push the content to be delivered by a Pre-Call program ahead of the phone call. This can be used for Inform and Engage programs. The pre-call object is represented in Branded Communications by the services to be used as well as the length of time the assets will be associated with the phone numbers specified.
The pre-call push API consists of two endpoints used to push the information for either an Inform or Engage branded call with pre-call authentication.
Updated 24 days ago
