Buttons

Buttons are configurable UI components displayed on the call screen or keypad based on conditions. When pressed, buttons invoke associated functions.

JSON Schema

Button definitions are part of the main Functions Framework schema, available here.

Button Configuration

Each button is a JSON object with the following fields:

Field	Required	Description
id	Yes	Unique identifier — at least 2 characters, lowercase letters, numbers, and underscores only.
definition	Yes	Object defining interactions, location, and style (see below).
condition	No	Condition determining button visibility or activity state. If omitted, the button is always visible.

---

Definition Properties

interactions

Defines which function is triggered by each gesture. Functions are referenced by their id.

Gesture	Description
press	Standard tap/click.
longPress	Long press gesture.

"interactions": {
    "press": { "id": "openBrowser" },
    "longPress": { "id": "startRecording" }
}

location

Specifies where the button appears in the UI.

Property	Values	Description
keypad	voiceMail, call, gsmCall	Show on the specified keypad slot.
callScreen	custom1 – custom6	Show on the specified call screen slot.

"location": {
    "@": "keypad",
    "slot": "call"
}

"location": {
    "@": "callScreen",
    "slot": "custom1"
}

style

Described here

---

Complete Example

A button visible when a call is established, placed on the keypad call slot, that invokes the echo_test function on press:

{
    "$schema": "https://schemas.acrobits.net/core/functions/input.json",
    "version": 1,
    "buttons": [
        {
            "id": "call_button",
            "definition": {
                "interactions": {
                    "press": {
                        "id": "echo_test"
                    }
                },
                "location": {
                    "@": "keypad",
                    "slot": "call"
                },
                "style": {
                    "labels": {
                        "normal": {
                            "raw": "Call"
                        }
                    },
                    "icons": {
                        "normal": {
                            "android": "call_functions_button_custom_0",
                            "ios": "call_functions_button_custom_0",
                            "desktop": "desktopth_call_functions_button_custom_0"
                        },
                        "hover": {
                            "android": "call_functions_button_custom_0",
                            "ios": "call_functions_button_custom_0",
                            "desktop": "desktopth_call_functions_button_custom_0_hover"
                        },
                        "pressed": {
                            "android": "call_functions_button_custom_0",
                            "ios": "call_functions_button_custom_0",
                            "desktop": "desktopth_call_functions_button_custom_0_hover"
                        }
                    },
                    "tooltip": {
                        "raw": "Make a Call"
                    }
                }
            },
            "condition": {
                "@": "callState",
                "states": [
                    "established"
                ]
            }
        }
    ],
    "triggers": [],
    "functions": []
}