The Facebook integration is managed at the Group level. When enabled, all calls made to Number and NumberPools will be uploaded to Facebook Business Manager as an offline conversion.

To configure Facebook Integration for your Group, you will need to:

  • Authorize Telmetrics to post offline conversions via the Facebook API
  • Configure your Group to use Facebook

1. Facebook Authentication

Before posting conversions to Facebook, you will need to Authorize Telmetrics to post to Facebook via API. This configuration is completed via the Telmetrics Ordering Portal.

Log in to the Telmetrics Ordering Portal as an administrator user, and navigate to the 'Settings' menu. From the menu, select the 'Integrations' option:

From the 'Integrations' screen, select the Facebook option:

On the Facebook Integration screen, click the 'Add Configuration Link:

This will open a modal, where you can provide a name for your Facebook Integration:

Click the 'Configure' button to initiate the authorization process for your Facebook Business Manager account:

All integrations that are configured via the Telmetrics Ordering Portal can be retrieved via the following end-point:

GET https://api.telmetrics.com/v3/api/configurations/integrations

The resulting output will look something like:

[
    {
        "integration_auth_id": "da62a35b-b9af-4916-bbdc-bdbbecd59b04",
        "description": "Facebook - Conversion Tracking",
        "type": "Facebook",
        "created_datetime": "2018-05-14T12:53:40.307"
    }
 ]

The 'integration-auth_id' returned above, will be a required field when configuring an integration for your Group.

2. Configuring your Facebook Integration

Your Facebook configuration is associated with a Group. Below are the fields used when configuring this integration:

Field

Description

Required

Possible Values

type

The type of Integration you want to create

Yes

"Facebook"

integration_auth_id

Unique id created when you authorize Telmetrics to post conversion on your behalf

Yes

GUID

configuration -> business_manager_id

Facebook Business Manager ID

Yes

An active Facebook Business Manager ID

configuration -> phone_call_conversion

Name that the phone call conversion will be labelled as in your offline event set

No

String

configuration -> phone_call_conversion_value

Monetary value of a phone call conversion

No

Monetary value of phone call

configuration -> sms_conversion

Name that the SMS conversion will be labelled as in your offline event set

No

String

configuration -> sms_conversion_value

Monetary value of an SMS conversion

No

Monetary value of SMS conversation

configuration -> currency

Currency code that conversions should be uploaded as

No (default: USD)

For more details visit:
Facebook Currency Codes

Below is an example of how to configure a Facebook integration using the criteria outlined above:
POST https://api.telmetrics.com/v3/api/groups/{group_id}/integrations

Remember when configuring an Integration it must be assigned to a group.

{  
  "type": "Facebook",
  "integration_auth_id": "7b6eb191-e7d5-410f-a19c-0d32edf39d2a",
  "configuration": {
    "currency": "USD",
    "business_manager_id": "2818232993334",
    "phone_call_conversion": "telmetrics_calls",
    "phone_call_conversion_value": 2.15,
    "sms_conversion": "telmetrics_sms_convs",
    "sms_conversion_value": 2.15  
  }
}

This request will result in a response similar to the following:

{
    "type": "Facebook",
    "integration_id": "d889faef-b6cb-4daa-afab-f767673057b1",
    "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
    "group_id": 11623348,
    "created_datetime": "2018-05-14T17:05:09.7261789Z",
    "modified_datetime": "2018-05-14T17:05:09.7261789Z",
    "configuration": {
      "currency": "USD",
      "business_manager_id": "2818232993334",
      "phone_call_conversion": "telmetrics_calls",
      "phone_call_conversion_value": 2.15,
      "sms_conversion": "telmetrics_sms_convs",
      "sms_conversion_value": 2.15  
    }
}

Note that the 'integration_id' returned by this request must be used for any subsequent updates.

3. Updating Your Facebook Integration

In the event that you need to update your Facebook Integration, you will need to submit your request to the following end-point:

POST {{webserviceurl}}/v3/api/groups/integrations/{integration_id}

{  
  "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
  "configuration": {
    "currency": "USD",
    "business_manager_id": "2818232993334",
    "phone_call_conversion": "telmetrics_calls",
    "phone_call_conversion_value": 2.15,
    "sms_conversion": "telmetrics_sms_convs",
    "sms_conversion_value": 2.15  
  }
}

This request will result in a response similar to the following:

{
    "type": "Facebook",
    "integration_id": "d889faef-b6cb-4daa-afab-f767673057b1",
    "integration_auth_id": "6932dfd8-4efb-492e-97e3-48daba7b8ed5",
    "group_id": 11623348,
    "created_datetime": "2018-05-14T17:05:09.727",
    "modified_datetime": "2018-05-14T17:19:43.9688953Z",
    "configuration": {
      "currency": "USD",
      "business_manager_id": "2818232993334",
      "phone_call_conversion": "telmetrics_calls",
      "phone_call_conversion_value": 2.15,
      "sms_conversion": "telmetrics_sms_convs",
      "sms_conversion_value": 2.15  
    }
}