Skip to main content
Callpage logo
  • Category: phone & sms
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 26
  • Triggers: 0
  • Slug: CALLPAGE
  • Version: 20261101_00

Tools

Slug: CALLPAGE_ADD_USERS_TO_WIDGETTool to add users to a widget as managers. Use when you need to create or update manager assignments for a widget. If a user-widget pair already exists, the existing manager will be updated instead of creating a new one.

Input Parameters

integer
required
Widget identifier to which users will be added as managers.
string
required
User identifier(s) to add as manager(s). Can be a single integer for one user or an array for multiple users. If the user-widget pair already exists, the manager will be updated.
array
Optional list of working hours for the manager(s). Array of day schedules defining availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_CREATE_SMS_MESSAGECreate a custom SMS message for a widget event, such as a completed dial, scheduled call, or cancelled scheduled call.

Input Parameters

string
required
Custom SMS text content. Maximum 240 characters. Supports variables: :company_name (company name), :name (recipient name), :tel (phone number), :url (callback URL).
boolean
Indicates whether the message should be enabled or not. Defaults to true.
integer
required
Widget identifier. You can find it in the widgets tab.
string ("visitor.dial-completed" | "visitor.call-scheduled" | "visitor.cancel-scheduled" | "visitor.incoming-dial-completed")
required
Message identifier determining when the SMS will be sent. Options: visitor.dial-completed (after visitor completes call), visitor.call-scheduled (when visitor schedules a call), visitor.cancel-scheduled (when a scheduled call is cancelled), visitor.incoming-dial-completed (after visitor’s incoming call is completed).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_CREATE_USERTool to create a new user with specified name, phone number, email and role. Use when you need to add a new admin or manager user to your CallPage account.

Input Parameters

string
required
A phone number in E.164 format e.g. +48123123123. Must be valid format (e.g., +48 followed by 9 digits for Polish numbers).
string
required
User name.
string ("admin" | "manager")
User role enum for CallPage users.
string
Valid email address.
boolean
required
Whether the user is enabled. Required by API despite not being documented in official docs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_DELETE_MANAGERTool to delete a manager from a widget. Use when you need to remove a manager assignment after verifying both user_id and widget_id.

Input Parameters

integer
required
User identifier. You can find it in the users tab.
integer
required
Widget identifier. You can find it in the widgets tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_DELETE_USERTool to delete a user by id. Use when you need to remove an existing user after verifying their ID.

Input Parameters

integer
required
User identifier to delete. You can find it in the users list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_ALL_MANAGERSRetrieve a paginated list of managers assigned to a widget. An HTTP 404 is returned as a successful empty list.

Input Parameters

integer
Maximum number of manager records to return.
integer
Number of items to skip before starting to collect the result set.
integer
required
Identifier of the widget to list managers for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_ALL_SMS_MESSAGESTool to retrieve all SMS messages for a widget. Use when you need to fetch both default and custom SMS templates after confirming the widget exists.

Input Parameters

integer
required
Widget identifier. You can find it in the widgets tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_ALL_USERSTool to retrieve a list of all users with pagination. Use when you need to page through all users in your CallPage account to synchronize or audit user records.

Input Parameters

integer
If set, the result will be limited to this number of users.
integer
If set, the result will be offset by this value for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_ALL_VOICE_MESSAGESTool to retrieve all voice messages for a widget. Returns custom voice messages if configured, otherwise returns default messages. Use when you need to view or audit voice message settings.

Input Parameters

integer
required
Widget identifier for which to retrieve voice messages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_ALL_WIDGETSTool to retrieve a list of widgets with pagination. Use when you need to page through all widgets after API authentication.

Input Parameters

integer
Maximum number of widgets to return. Defaults to 100.
integer
Number of items to skip before starting to collect the result set. Defaults to 0.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_API_ROOTTool to get the root API greeting. Use to verify connectivity and retrieve the initial API greeting after setting the API key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_CALLS_HISTORYTool to retrieve calls history with filtering and pagination. By default returns all calls for all users’ widgets. Use when you need to query historical call data with optional filters for date range, status, widgets, users, tags, or phone numbers.

Input Parameters

string
Filter by widget installation URL.
integer
Maximum number of calls to return for pagination.
integer
Number of calls to skip before starting to collect results for pagination.
array
Show calls by specific call IDs. Can provide multiple IDs.
integer
Filter calls until this end date as Unix timestamp (seconds since epoch).
array
Show calls for specified tag IDs. Can provide multiple tag IDs.
array
Filter by call status. Common values: ‘completed’, ‘in-progress’, ‘scheduled’, ‘cancelled’.
array
Show calls for specified user IDs. Can provide multiple user IDs.
integer
Filter calls from this start date as Unix timestamp (seconds since epoch).
array
Show calls for specified widget IDs. Can provide multiple widget IDs.
string
Filter by phone number in E.164 format (e.g., +48123123123).
integer
Determine if should display hidden calls. Set to 1 to show hidden calls.
array
Show calls for specified incoming number IDs. Can provide multiple IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_MANAGERTool to retrieve a specific manager by user_id and widget_id. Use when you need detailed information about a manager’s configuration, availability, and assigned departments.

Input Parameters

integer
required
User identifier of the manager.
integer
required
Widget identifier where the manager is assigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_MANAGER_STATUS_STATISTICSRetrieve manager status counts for a widget from the returned page of managers. The counts reflect that page, not necessarily all managers for the widget.

Input Parameters

integer
Maximum number of managers to retrieve per request (optional).
integer
Pagination offset for listing managers (optional).
integer
required
Widget identifier for which to retrieve manager status statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_GET_WIDGETRetrieve details of a specific widget by ID, including its basic configuration and assignments.

Input Parameters

integer
required
Widget identifier. You can find it in the widgets tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_CREATE_MANAGERTool to create a new manager for a widget. Use when you need to assign a user as a manager to handle calls for a specific widget.

Input Parameters

boolean
required
True to enable calling this manager; false to disable.
integer
required
Identifier of the user to assign as manager. You can find it in the dashboard users list.
integer
required
Identifier of the widget to which the manager will be assigned.
array
Optional list of working-hour rules defining when the manager is available. If omitted, defaults to Monday–Friday, 09:00–17:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_CREATE_VOICE_MESSAGETool to create a custom voice message for a widget. Use when you need to customize greeting messages for manager or visitor after setting widget locale.

Input Parameters

string
URL of the audio file for the custom message (.mp3, .mpga, .wav; max 10 MB).
boolean
required
Whether the custom voice message should be enabled.
integer
required
Identifier of the widget for which to create the voice message.
string ("manager.call" | "visitor.call")
required
Voice message identifier, either ‘manager.call’ or ‘visitor.call’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_CREATE_WIDGETTool to create a new widget. Use when you need to install a widget on your site and retrieve its ID.

Input Parameters

string
required
Website URL where the widget will be installed (e.g., https://callpage.io).
string
Optional description for the widget. If omitted, defaults to ‘Created from REST API. Timestamp: {timestamp}’.
string ("cn" | "cz" | "de" | "ee" | "en" | "es" | "fr" | "hu" | "it" | "lt" | "pl" | "pt" | "ru" | "se" | "tr")
Locale code for the widget language. See widget languages in docs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_DELETE_WIDGETTool to delete a widget by id. Use when you need to remove an existing widget after verifying its ID. Example: Delete widget with id 3409.

Input Parameters

integer
required
Widget identifier. You can find it in the widgets tab.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_RESET_SMSTool to reset SMS messages to default for a widget. Use when you need to restore default SMS templates after customization tests.

Input Parameters

integer
required
Widget identifier. You can find it in the widgets tab.
string
Optional SMS message identifier to reset. Allowed values include: visitor.call-scheduled, visitor.cancel-scheduled, visitor.dial-completed, visitor.incoming-dial-completed. If omitted, all SMS messages for the widget will be reset to defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_RESET_VOICE_MESSAGETool to reset voice messages to default for a widget. Use when you need to clear custom messages and revert to system defaults. Example: Reset all voice messages for widget with id 123.

Input Parameters

integer
required
Identifier of the widget.
string
Identifier of a specific voice message to reset. If omitted, all voice messages will be reset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_UPDATE_MANAGERUpdate a manager’s availability and business hours for a widget. If business hours are omitted, the request sends Monday–Friday 09:00–17:00, with weekends disabled.

Input Parameters

boolean
required
True to enable calling this manager; false to disable.
integer
required
Identifier of the manager (user). You can find it in the dashboard managers list.
integer
required
Identifier of the widget to which the manager is assigned.
array
Optional list of working-hour rules. If omitted, defaults to Monday–Friday, 09:00–17:00.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_UPDATE_SMSTool to update a custom SMS message for a widget. Use when you need to modify custom SMS templates. Note: it’s impossible to update default SMS - if you haven’t created custom SMS yet, use the create endpoint first.

Input Parameters

string
required
SMS text content. Maximum 240 characters. You can use placeholders like :company_name and :tel.
boolean
Indicates whether the message should be enabled or not. Defaults to true.
integer
required
Widget identifier. You can find it in the widgets tab.
string
required
Message identifier. Allowed values include: visitor.call-scheduled, visitor.cancel-scheduled, visitor.dial-completed, visitor.incoming-dial-completed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_UPDATE_USERTool to update an existing user by ID. Use when you need to modify a user’s details, phone number, role, or enabled status. This operation can override parent user depending on who makes the request.

Input Parameters

integer
required
User identifier. You can find it in the dashboard users list.
string
required
A phone number in E.164 format (e.g., +48123456789).
string
required
User name to update.
string ("admin" | "manager")
User role for CallPage users.
string
Valid email address for the user.
boolean
required
Whether the user is enabled (true) or disabled (false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_UPDATE_WIDGETTool to update an existing widget. Use when you need to change widget URL, description, settings, language, or enabled state.

Input Parameters

integer
required
Widget identifier. You can find it in the dashboard widgets list.
string
required
Website URL where the widget will be installed (e.g., https://callpage.io).
boolean
Indicates whether the widget is enabled (true) or disabled (false).
array
Optional list of widget settings objects as defined in the documentation.
string
Optional description for the widget. If omitted, existing description remains unchanged.
string ("cn" | "cz" | "de" | "ee" | "en" | "es" | "fr" | "hu" | "it" | "lt" | "pl" | "pt" | "ru" | "se" | "tr")
Locale code for the widget language (e.g., ‘en’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CALLPAGE_POST_WIDGET_CALL_OR_SCHEDULETool to initiate or schedule a call via widget. Use when you need to call immediately or schedule at the first available timeslot through a widget.

Input Parameters

integer
required
Widget identifier. You can find it in the widgets tab.
string
required
Phone number in E.164 format (e.g. +48123123123).
integer
Department identifier. If omitted, the call is routed to all available managers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not