Unblocking a number with delete_fpg_phone

Filter Phone Groups are easy to over-populate. You block a range of numbers to test a campaign, or a teammate adds a number that turns out to be a live lead, and now the dialer is skipping calls it should be making. The Non-Agent API gives you delete_fpg_phone to clean those entries out one at a time.

What delete_fpg_phone does

It removes a phone number from a Filter Phone Group. A Filter phone group holds numbers that a campaign's Filter uses to exclude leads, so removing a number from the group lets the dialer reach it again. This is purely a dialing decision - it has nothing to do with your DNC (do not call) lists, so deleting an FPG entry never un-blocks an opt-out.

Like its add counterpart, this function works on a group that already exists. It does not delete the group itself, only the single number you name inside it.

Permissions you need first

The API user needs user_level 8 or higher and the "modify lists" permission enabled - the same grant the add function uses. Unlike DNC deletion, there is no extra permission flag here. If you are still mapping out which level grants what, VICIdial API user level and permissions lays it out.

The required fields

• phone_number - the number to release, 6 to 20 characters
• group - 2 to 30 characters, a valid Filter Phone Group ID in the system

Example call

http://your-server/vicidial/non_agent_api.php?source=test&function=delete_fpg_phone&user=6666&pass=1234&phone_number=7275551212&group=TEST_IN_FILTER

How the call decides

flowchart TD
    A[delete_fpg_phone call] --> B{user_level 8 and modify lists?}
    B -->|no| C[ERROR: NO PERMISSION]
    B -->|yes| D{group ID exists?}
    D -->|no| E[ERROR: GROUP DOES NOT EXIST]
    D -->|yes| F{number in this group?}
    F -->|no| G[ERROR: NUMBER DOES NOT EXIST]
    F -->|yes| H[remove number from group]
    H --> I[SUCCESS: NUMBER HAS BEEN DELETED]

Reading the response

A clean removal returns: SUCCESS: delete_fpg_phone FILTER PHONE GROUP NUMBER HAS BEEN DELETED - 6666|7275551212|TEST_IN_FILTER. The errors to handle:

• ERROR: delete_fpg_phone USER DOES NOT HAVE PERMISSION TO DELETE FILTER PHONE GROUP NUMBERS - 6666|0 - the API user lacks user_level 8 or "modify lists".
• ERROR: delete_fpg_phone YOU MUST USE ALL REQUIRED FIELDS - 6666|||1000 - phone_number or group is missing.
• ERROR: delete_fpg_phone FILTER PHONE GROUP DOES NOT EXIST - 6666|TEST_IN_FILTER2 - the group ID is wrong.
• ERROR: delete_fpg_phone FILTER PHONE GROUP NUMBER DOES NOT EXIST - 6666|7275551212|TEST_IN_FILTER - the number was not in that group, so confirm the group ID.

The function that put the number there in the first place is covered in blocking a number with the add_fpg_phone API.

Run it on a hosted box

The API (application programming interface) is part of every VICIdial build, so delete_fpg_phone is ready as soon as your dialer is live. VICIfast runs the API for you on every plan - see pricing.