Pre-requisites

1. First Orion Branded Communications agreement
2. Access to First Orion Customer Portal
3. Vetted and Approved Business
4. Ability to originate phone calls from configured phone numbers in calling platform
5. Understanding of current calling platform and environment to integrate required API

Steps

The following steps detail the process of configuring an Authenticated Calling Program in the First Orion platform.

Step 1 - Login to First Orion Portal

Step 2 - Locate Business

1. Scroll down to the list of businesses
2. Search based on Business Name or Business ID
3. Click on the business

Step 3 - (Optional) Add Logo to Image Gallery (for new images)

If you are not using Call Authentication with Logo, skip to Step 4

1. Navigate to Image Gallery
2. Upload and SVG that adheres to the file restrictions.

Step 4 - Setup Program

Authenticated Inform

1. Navigate to the Business Unit level.
2. Click Manage in the top right.
3. Click Create Program.
4. Select the Authenticated Inform program type.
5. Name the program and select the call purpose.
6. Click into Display to add the text display and the program duration.
   1. Note - skip the "Image" step to ensure the Program is not created as Inform with Logo
7. Click into Phone Numbers to add numbers for branding.
8. Click Launch.

Inform with Logo

1. Navigate to the Business Unit level
2. Click Manage in the top right
3. Click Create Program
4. Select the Authenticated Inform program type.
5. Name the program and select the call purpose.
6. Click into Display to add the text display and the program duration.
7. Click into Image and select the previously uploaded image.
8. Click into Phone Numbers to add numbers for branding.
9. Click Launch

Sentry

1. Navigate to the Business Unit level
2. Click Manage in the top right
3. Click Create Program
4. Select the Sentry program type.
5. Name the program and select the call purpose.
6. Click into Display. Set program duration then either toggle branding off (just shows phone number) or add the text display.
7. Click into Phone Numbers to add numbers for Sentry.

Step 5 - Generate API Keys

1. Navigate to the API Keys section on the left hand side.
2. Click Generate Key to generate the new key.
3. Copy and save or download the generated keys.

Step 6 - Integrate Call Authentication API

1. Verify being able to generate an access token.

curl --location --request POST 'https://api.firstorion.com/v1/auth' \
--header 'X-API-KEY: [API KEY FROM PORTAL]' \
--header 'X-SECRET-KEY: [SECRET KEY FROM PORTAL]' \
--header 'X-SERVICE: auth' \
--header 'accept: application/json'

2. Verify being able to make an Authenticated Call API push.

curl --location 'https://api.firstorion.com/exchange/v1/calls/push' \
--header 'authorization: Bearer [FROM GET TOKEN ENDPOINT]' \
--header 'content-type: application/json' \
--data '{
    "aNumber": "+18668561234",
    "bNumber": "+15019515678",
    "businessId": "0e79a3bc-18d1-4f5c-a781-458f8bad9b22"
}'

3. Identify where in the platforms call flow this can live and integrate it.

Example Javascript below.

// Libraries
const axios = require('axios'); // Install with,  npm install axios

// Gets First Orion Auth Token
const getToken = async () => {
  
    try {
      const response = await axios.post(
        'https://api.firstorion.com/v1/auth',
        null,
        {
          headers: {
            'X-SERVICE':'auth',
            'X-API-KEY': 'your-api-key',
            'X-SECRET-KEY': 'your-secret-key',
            'Content-Type': 'application/json'
          }
        }
      );
      return response.data.token;
      
    } catch (error) {
      console.error('Error:', error);
      return {
        statusCode: error.response ? error.response.status : 500,
        body: JSON.stringify({ error: error.message })
      };
    }
}

// Create pre-call push to First Orion for Call Authentication
// Find out more at: https://developer.firstorion.com/firstorion-public/reference/callauthentication
const push_callauth = async (token) => {
    let data = JSON.stringify({
        "aNumber": '+15555555555',
        "bNumber": '15554444444',
        "businessId": 'your-business-id'
    });

    let config = {
        method: 'post',
        url: 'https://api.firstorion.com/exchange/v1/calls/push',
        headers: { 
            'Authorization': token, 
            'Content-Type': 'application/json'
        },
        data : data
    };

    axios.request(config)
    .then((response) => {
        console.log(JSON.stringify(response.data));
    })
    .catch((error) => {
        console.log(error);
    });
}

// Main function to invoke the pre-call push for call authentication.
const main = async () => {
    const token = await getToken();
    await push_callauth(token);
    await createCall();

}

main()