NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Callpage connects to a Nagent workspace with an API key. Once it is connected, agents can call 26 Callpage actions, such as "Add Users to Widget", "Create SMS Message" and "Create User". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Callpage, with input parameters and output schema.
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
Widget identifier to which users will be added as managers.
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.
Optional list of working hours for the manager(s). Array of day schedules defining availability.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLPAGE_CREATE_SMS_MESSAGETool to create custom SMS messages for specific widget events. Use when you need to set up automated SMS notifications for call events like completed dials, scheduled calls, or missed calls.
Input parameters
Custom SMS text content. Maximum 240 characters. Supports variables: :company_name (company name), :name (recipient name), :tel (phone number), :url (callback URL).
Indicates whether the message should be enabled or not. Defaults to true.
Widget identifier. You can find it in the widgets tab.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
A phone number in E.164 format e.g. +48123123123. Must be valid format (e.g., +48 followed by 9 digits for Polish numbers).
User name.
User role enum for CallPage users.
Valid email address.
Whether the user is enabled. Required by API despite not being documented in official docs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
User identifier. You can find it in the users tab.
Widget identifier. You can find it in the widgets tab.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLPAGE_DELETE_USERTool to delete a user by id. Use when you need to remove an existing user after verifying their ID.
Input parameters
User identifier to delete. You can find it in the users list.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLPAGE_GET_ALL_MANAGERSTool to retrieve a list of managers for a specific widget with pagination. Use when you need to page through all managers assigned to a widget after confirming its ID.
Input parameters
Maximum number of manager records to return.
Number of items to skip before starting to collect the result set.
Identifier of the widget to list managers for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Widget identifier. You can find it in the widgets tab.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
If set, the result will be limited to this number of users.
If set, the result will be offset by this value for pagination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Widget identifier for which to retrieve voice messages.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Maximum number of widgets to return. Defaults to 100.
Number of items to skip before starting to collect the result set. Defaults to 0.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter by widget installation URL.
Maximum number of calls to return for pagination.
Number of calls to skip before starting to collect results for pagination.
Show calls by specific call IDs. Can provide multiple IDs.
Filter calls until this end date as Unix timestamp (seconds since epoch).
Show calls for specified tag IDs. Can provide multiple tag IDs.
Filter by call status. Common values: 'completed', 'in-progress', 'scheduled', 'cancelled'.
Show calls for specified user IDs. Can provide multiple user IDs.
Filter calls from this start date as Unix timestamp (seconds since epoch).
Show calls for specified widget IDs. Can provide multiple widget IDs.
Filter by phone number in E.164 format (e.g., +48123123123).
Determine if should display hidden calls. Set to 1 to show hidden calls.
Show calls for specified incoming number IDs. Can provide multiple IDs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
User identifier of the manager.
Widget identifier where the manager is assigned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLPAGE_GET_MANAGER_STATUS_STATISTICSTool to retrieve statistical data about manager statuses. Use when you need summary counts of enabled and disabled managers for a specific widget.
Input parameters
Maximum number of managers to retrieve per request (optional).
Pagination offset for listing managers (optional).
Widget identifier for which to retrieve manager status statistics.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLPAGE_GET_WIDGETTool to retrieve details of a specific widget by id. Use when you have a widget id and need its complete configuration.
Input parameters
Widget identifier. You can find it in the widgets tab.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
True to enable calling this manager; false to disable.
Identifier of the user to assign as manager. You can find it in the dashboard users list.
Identifier of the widget to which the manager will be assigned.
Optional list of working-hour rules defining when the manager is available. If omitted, defaults to Monday–Friday, 09:00–17:00.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
URL of the audio file for the custom message (.mp3, .mpga, .wav; max 10 MB).
Whether the custom voice message should be enabled.
Identifier of the widget for which to create the voice message.
Voice message identifier, either 'manager.call' or 'visitor.call'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Website URL where the widget will be installed (e.g., https://callpage.io).
Optional description for the widget. If omitted, defaults to 'Created from REST API. Timestamp: {timestamp}'.
Locale code for the widget language. See widget languages in docs.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Widget identifier. You can find it in the widgets tab.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Widget identifier. You can find it in the widgets tab.
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
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Identifier of the widget.
Identifier of a specific voice message to reset. If omitted, all voice messages will be reset.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
CALLPAGE_POST_UPDATE_MANAGERTool to update an existing manager. Use when you need to modify a manager's availability or business hours after retrieving their record.
Input parameters
True to enable calling this manager; false to disable.
Identifier of the manager (user). You can find it in the dashboard managers list.
Identifier of the widget to which the manager is assigned.
Optional list of working-hour rules. If omitted, defaults to Monday–Friday, 09:00–17:00.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
SMS text content. Maximum 240 characters. You can use placeholders like :company_name and :tel.
Indicates whether the message should be enabled or not. Defaults to true.
Widget identifier. You can find it in the widgets tab.
Message identifier. Allowed values include: visitor.call-scheduled, visitor.cancel-scheduled, visitor.dial-completed, visitor.incoming-dial-completed.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
User identifier. You can find it in the dashboard users list.
A phone number in E.164 format (e.g., +48123456789).
User name to update.
User role for CallPage users.
Valid email address for the user.
Whether the user is enabled (true) or disabled (false).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Widget identifier. You can find it in the dashboard widgets list.
Website URL where the widget will be installed (e.g., https://callpage.io).
Indicates whether the widget is enabled (true) or disabled (false).
Optional list of widget settings objects as defined in the documentation.
Optional description for the widget. If omitted, existing description remains unchanged.
Locale code for the widget language (e.g., 'en').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Widget identifier. You can find it in the widgets tab.
Phone number in E.164 format (e.g. +48123123123).
Department identifier. If omitted, the call is routed to all available managers.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 26 Callpage actions on Nagent, including "Add Users to Widget", "Create SMS Message" and "Create User". Add Users to Widget: Add users to a widget as managers. Each action is listed on this page with its input parameters and its output.
Callpage connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Add Users to Widget takes 2 required inputs: id and user_id. It also takes 1 optional input: business_times. It returns data, error and successful.