Ingress FPG - Filter Phone Groups
- Alexander Conroy
This API Manages the TLDialer FPG (Filter Phone Group) Registry. You can add or remove phone numbers from any FPG. You can also search through the all FPGs or a just as specific FPG.
An FPG Must be provided for adding or removing from an FPG but you can search through all FPGs if needed by omitting the FPG Parameter.
There are two default FPG's created by TLD for all accounts: CLIENTS and BLOCK. These FPGs cannot be removed or renamed in TLD and are always present.
Any Policy that becomes a "Sale" or any lead status that "Converts", or any mapped Dialer Disposition that has the "Sale" flag will add to the CLIENTS FPG.
The BLOCK FPG is added to manually from the Contact Screen or API, and is used on Inbound DIDs and Agent Availability Pings such as the Dialer Ready API to stop unwanted inbound calls. There are other uses for FPG's but consider them the opposite of the DNC, used for Inbound Blocking instead of Outbound.
Endpoints: /api/ingress/fpg,/api/egress/fpg
Methods: POST, PUT, GET
API Version Support: v1
Security Notice: Please make sure to use API | Endpoint Protection when giving this access to third party systems as API Keys are unprotected unless specified.
The proper endpoint protection to set for an API using this Endpoint is /api/*/fpg*Make sure to include the *
Data Formats Supported
form-data, x-www-form-urlencoded Form Parameters or JSON Body with Content-Type: application/json set.
Note: The API will Attempt to Convert your Phone Numbers to a 10 digit Phone number or an {AreaCode}XXXXXXX Format. For Example you can Search for, Add, Replace and Delete 305XXXXXXX which is a DNC for an Areacode. You can also search or update with (512)665-3983, 512-665-3983, 512.665.3983, +15126653983, as examples.
Response Codes
200: Success and Warnings
400: Error
Search: Search the FPG
Endpoint: /api/egress/fpg
Method: GET | POST
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✘ | 10 or 11 Digit Phone Number. TLD Will attempt to accept any format of number. | Searches for a number or multiple phone numbers |  |
| ✘ | string | Specifies a FPG |
|
| ✘ | integer | Limits results set. Cannot be negative. |  |
| ✘ | integer | Paginates result set based on limit. Cannot be negative or 0. |  |
Search: Clients FPG
JSON Request Object
{
"phone_number": "5126653983",
"filter_phone_group_id": "CLIENTS",
"limit": "1",
"page": "1"
}Search: All FPG
JSON Request Object
{
"limit": "100",
"page": "1"
}Add: Add to an FPG
Endpoint: /api/ingress/fpg
Method: POST
Add: Add Single Number
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | 10 or 11 Digit Phone Number. TLD Will attempt to accept any format of number. | Searches for a number or multiple phone numbers |
|
| ✓ | string | Specifies a FPG to Add to |
|
JSON Request Object
{
"phone": "5126653983",
"filter_phone_group_id": "CLIENTS"
}
JSON Success Object
JSON Error Object
Add: Add Multiple Numbers
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | string|csv|array 10 or 11 Digit Phone Number. TLD Will attempt to accept any format of number. | Searches for a number or multiple phone numbers |
|
| ✓ | string | Specifies a FPG to Add to |
|
JSON Request Object
JSON Success Object
JSON Warning Object
JSON Error Object
Delete: Remove from an FPG
Endpoint: /api/ingress/fpg
Method: DELETE
Delete: Remove Single Number
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | 10 or 11 Digit Phone Number. TLD Will attempt to accept any format of number. | Searches for a number or multiple phone numbers |
|
| ✓ | string | Specifies a FPG to Remove from |
|
JSON Request Object
JSON Success Object
JSON Error Object
Delete: Remove Multiple Numbers
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | string|csv|array of 10 or 11 Digit Phone Number. TLD Will attempt to accept any format of number. | Searches for a number or multiple phone numbers |
|
| ✓ | string | Specifies a FPG to Remove from |
|
JSON Request Object
JSON Success Object
JSON Warning Object
JSON Error Object
Errors Possible
Error | Resolution |
|---|---|
No API ID Provided | Check API ID in Header or Parameters. See API | Using API ID and API Key |
No API Key Provided | Check API Key in Headers or Parameters. See API | Using API ID and API Key |
TLDialer Not Enabled | Contact TLD Support to Enable or Investigate. |
TLDialer Connection Error | Contact TLD Support to Investigate a Database Issue. |
Missing Phone Number | Check |
Missing Phone Numbers | Check |
FPG does not Exist | Check |
Number does not exists in FPG: { | Number was not in FPG. |
Number already exists in FPG: { | Number is already in the FPG. |