Business & Metrics

Business Endpoints

A BusinessBusiness - A Business, as used for Branded Calling, represents the Enterprise or top-level entity responsible for managing the associated Business Units. represents the Enterprise or top-level entity responsible for managing their associated Business UnitsBusiness Units - A division of an Enterprise operating independently and with responsibility for a particular range of products or activities. Within Branded Calling, it designates a container for one or more created calling groups of a Business. A Business will have one or more Business Unit to serve as a container for one or more calling Programs. An Enterprise will often set up Branded Calling Business Units based upon departments, such as: customer service, billing, delivery, etc.. The following endpoints are available at the Business level:

A GET action returning all available data for the specified business. This includes the Legal Name of the business, DBA, Primary Phone Number, aNumberaNumber - The number initiating a call, also referred to as the originating number, business number, or calling party. May be written as: ANumber or A-Number.s , Addresses, Admin Contacts, Website, Duns Number (if available), Business Units, Programs, and Delivery Channels. For a full example of the response object, please see the above-linked API reference page.

Business Metrics

Metrics associated with the entire Business may be called, returning aggregated answer rate, decline rate, and call count data. See detailed response information in the Get Business 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.

See sample Business metrics response object below:

{
    "body": {
        "businessMetricsSummaries": [
            {
                "businessId": "fb67b5c6-53e6-4e03-b775-d171289ebfbd",
                "metrics": [
                    {
                        "answerRate": 0.34526357,
                        "declineRate": 0.12345,
                        "totalTreatedCalls": 123453
                    }
                ]
            },
            {
                "businessId": "lb3bj1bf-53e6-4e03-b775-d171289ebfbd",
                "metrics": [
                    {
                        "answerRate": 0.34526357,
                        "declineRate": 0.12345,
                        "totalTreatedCalls": 123453
                    }
                ]
            }
        ]
    },
    "error": null
}

Business Contacts

A collection of endpoints offering the management of contacts associated with a specific Business.

A GET action returning all existing administrative contacts available for a specified Business.

A POST action providing the ability to add a new administrative contact to a specified Business.

A GET action returning all available data (i.e. Name, Email, Phone Number) for a specific contact within a Business.

A PUT action providing the ability to alter the information associated with a specific administrative contact.

A DELETE action that removes an individual contact from the specified Business.

Business Addresses

A collection of endpoints offering the management of addresses associated with a specified Business. All Businesses can assign a primary address, and secondary addresses as needed.

A GET action returning all existing addresses associated with a specified Business.

A POST action providing the ability to add a new address to a specified Business.

A GET action returning available address data (i.e. City, State, Postal Code, Country, Street Number) for a specified Business.

A PUT action providing the ability to alter existing information for a specified address.

A DELETE action removing an existing address from a Business.

Business Reference Data

A collection of endpoints offering data points for reference associated with Businesses.

A GET action that returns the industries a Business is defined as.

See sample Business industries reference data response object below

{
  "body":{
    "callPurposes":[
      { 
        "industryId":"12",
        "industry":"Automotive",
        "displayOrder":1
      },
      { 
        "industryId":"DC",
        "industry":"Business Services",
        "displayOrder":2
      },
    ]
  }
}

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

A GET action that returns the employee size of a business as a count range.

See sample Business employee count ranges reference data response object below:

{
  "body":{
    "employeeCountRanges":[
      { 
        "rangeId":9,
        "range":"Unknown",
        "displayOrder":1
      }
      { 
        "rangeId":1,
        "range":"1-10 employees",
        "displayOrder":2
      },
      { 
        "rangeId":2,
        "range":"11-51 employees",
        "displayOrder":3
      }
    ]
  }
}

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


Did this page help you?