Callpage
callpageCallPage is a lead capture tool that enables businesses to connect with website visitors through immediate phone callbacks, enhancing lead generation and sales conversion rates.
Acciones disponibles (17)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Get All ManagersCALLPAGE_GET_ALL_MANAGERSAcciónTool 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.
CALLPAGE_GET_ALL_MANAGERSAcciónTool 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.
Parámetros de entrada
limitintegerMaximum number of manager records to return.
offsetintegerNumber of items to skip before starting to collect the result set.
widget_idintegerObligatorioIdentifier of the widget to list managers for.
Parámetros de salida
dataobject[]ObligatorioList of manager assignments for the widget.
errorstringError if any occurred during the execution of the action
messagestringObligatorioAdditional information about the API response.
hasErrorbooleanObligatorioIndicates if the API request resulted in an error.
errorCodeintegerObligatorioNumeric error code (0 if successful).
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All SMS MessagesCALLPAGE_GET_ALL_SMS_MESSAGESAcciónTool 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.
CALLPAGE_GET_ALL_SMS_MESSAGESAcciónTool 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.
Parámetros de entrada
widget_idintegerObligatorioWidget identifier. You can find it in the widgets tab.
Parámetros de salida
dataobject[]ObligatorioList of SMS messages for the given widget.
errorstringError if any occurred during the execution of the action
messagestringObligatorioError message, if any.
hasErrorbooleanObligatorioIndicates if an error occurred.
errorCodeintegerObligatorioError code, if any.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All UsersCALLPAGE_GET_ALL_USERSAcciónTool 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.
CALLPAGE_GET_ALL_USERSAcciónTool 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.
Parámetros de entrada
limitintegerIf set, the result will be limited to this number of users.
offsetintegerIf set, the result will be offset by this value for pagination.
Parámetros de salida
dataobject[]ObligatorioList of user objects returned by this call.
metaobjectObligatorioPagination metadata for the returned list.
errorstringError if any occurred during the execution of the action
messagestringObligatorioOptional message from the API.
hasErrorbooleanObligatorioIndicates if the request resulted in an error.
errorCodeintegerObligatorioNumeric error code (0 if successful).
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get All WidgetsCALLPAGE_GET_ALL_WIDGETSAcciónTool to retrieve a list of widgets with pagination. use when you need to page through all widgets after api authentication.
CALLPAGE_GET_ALL_WIDGETSAcciónTool to retrieve a list of widgets with pagination. use when you need to page through all widgets after api authentication.
Parámetros de entrada
limitintegerMaximum number of widgets to return. Defaults to 100.
offsetintegerNumber of items to skip before starting to collect the result set. Defaults to 0.
Parámetros de salida
dataobject[]ObligatorioList of widgets.
metaobjectObligatorioPagination metadata.
errorstringError if any occurred during the execution of the action
messagestringObligatorioMessage returned by the API.
hasErrorbooleanObligatorioWhether the API returned an error.
errorCodeintegerObligatorioError code returned by the API.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get API RootCALLPAGE_GET_API_ROOTAcciónTool to get the root api greeting. use to verify connectivity and retrieve the initial api greeting after setting the api key.
CALLPAGE_GET_API_ROOTAcciónTool to get the root api greeting. use to verify connectivity and retrieve the initial api greeting after setting the api key.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataarrayObligatorioPayload array; always empty for the root endpoint.
errorstringError if any occurred during the execution of the action
messagestringObligatorioGreeting or error message from the API.
hasErrorbooleanObligatorioIndicates whether the API returned an error.
errorCodeintegerObligatorioNumeric error code, 0 when hasError is false.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Manager Status StatisticsCALLPAGE_GET_MANAGER_STATUS_STATISTICSAcciónTool to retrieve statistical data about manager statuses. use when you need summary counts of enabled and disabled managers for a specific widget.
CALLPAGE_GET_MANAGER_STATUS_STATISTICSAcciónTool to retrieve statistical data about manager statuses. use when you need summary counts of enabled and disabled managers for a specific widget.
Parámetros de entrada
limitintegerMaximum number of managers to retrieve per request (optional).
offsetintegerPagination offset for listing managers (optional).
widget_idintegerObligatorioWidget identifier for which to retrieve manager status statistics.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get SMS StatisticsCALLPAGE_GET_SMS_STATISTICSAcciónTool to retrieve statistical data about sms messages. use when you need summary counts of sms messages for a given widget.
CALLPAGE_GET_SMS_STATISTICSAcciónTool to retrieve statistical data about sms messages. use when you need summary counts of sms messages for a given widget.
Parámetros de entrada
widget_idintegerObligatorioWidget identifier. You can find it in the widgets tab.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get WidgetCALLPAGE_GET_WIDGETAcciónTool to retrieve details of a specific widget by id. use when you have a widget id and need its complete configuration.
CALLPAGE_GET_WIDGETAcciónTool to retrieve details of a specific widget by id. use when you have a widget id and need its complete configuration.
Parámetros de entrada
idintegerObligatorioWidget identifier. You can find it in the widgets tab.
Parámetros de salida
dataobjectObligatorioDetailed widget data.
metaarrayObligatorioAdditional metadata (usually empty list).
errorstringError if any occurred during the execution of the action
messagestringObligatorioMessage returned by the API.
hasErrorbooleanObligatorioWhether the API returned an error.
errorCodeintegerObligatorioError code returned by the API.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Widget Status StatisticsCALLPAGE_GET_WIDGET_STATUS_STATISTICSAcciónTool to retrieve statistical data about widget statuses. use when you need counts of enabled vs disabled widgets.
CALLPAGE_GET_WIDGET_STATUS_STATISTICSAcciónTool to retrieve statistical data about widget statuses. use when you need counts of enabled vs disabled widgets.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Voice MessageCALLPAGE_POST_CREATE_VOICE_MESSAGEAcciónTool 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.
CALLPAGE_POST_CREATE_VOICE_MESSAGEAcciónTool 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.
Parámetros de entrada
filestringuriURL of the audio file for the custom message (.mp3, .mpga, .wav; max 10 MB).
enabledbooleanObligatorioWhether the custom voice message should be enabled.
widget_idintegerObligatorioIdentifier of the widget for which to create the voice message.
message_idstringObligatorioenumVoice message identifier, either 'manager.call' or 'visitor.call'.
manager.callvisitor.call
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
messagestringAPI response message or error description.
hasErrorbooleanObligatorioTrue if the API returned an error.
errorCodeintegerError code if an error occurred.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create WidgetCALLPAGE_POST_CREATE_WIDGETAcciónTool to create a new widget. use when you need to install a widget on your site and retrieve its id.
CALLPAGE_POST_CREATE_WIDGETAcciónTool to create a new widget. use when you need to install a widget on your site and retrieve its id.
Parámetros de entrada
urlstringObligatorioWebsite URL where the widget will be installed (e.g., https://callpage.io).
descriptionstringOptional description for the widget. If omitted, defaults to 'Created from REST API. Timestamp: {timestamp}'.
locale_codestringenumLocale code for the widget language. See widget languages in docs.
cnczdeeeenesfrhuitltplpt+3
Parámetros de salida
dataobjectObligatorioResponse payload containing the widget ID.
errorstringError if any occurred during the execution of the action
messagestringAPI response message or error description.
hasErrorbooleanObligatorioTrue if the API returned an error.
errorCodeintegerError code if hasError is true.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Widget by IdCALLPAGE_POST_DELETE_WIDGETAcciónTool 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.
CALLPAGE_POST_DELETE_WIDGETAcciónTool 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.
Parámetros de entrada
idintegerObligatorioWidget identifier. You can find it in the widgets tab.
Parámetros de salida
datanullAlways null on successful deletion.
errorstringError if any occurred during the execution of the action
messagestringObligatorioHuman-readable message returned by the API.
hasErrorbooleanObligatorioIndicates whether the API encountered an error.
errorCodeintegerObligatorioNumeric error code (0 if no error).
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reset SMSCALLPAGE_POST_RESET_SMSAcciónTool to reset sms messages to default for a widget. use when you need to restore default sms templates after customization tests.
CALLPAGE_POST_RESET_SMSAcciónTool to reset sms messages to default for a widget. use when you need to restore default sms templates after customization tests.
Parámetros de entrada
widget_idintegerObligatorioWidget identifier. You can find it in the widgets tab.
message_idstringOptional SMS message identifier to reset. Allowed values are listed in the documentation. If omitted, all SMS messages for the widget will be reset to defaults.
Parámetros de salida
datanullAlways null on successful reset.
errorstringError if any occurred during the execution of the action
messagestringObligatorioDescription of the error, if any.
hasErrorbooleanObligatorioIndicates if there was an error during the request.
errorCodeintegerObligatorioError code corresponding to the error encountered.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reset Voice MessagesCALLPAGE_POST_RESET_VOICE_MESSAGEAcciónTool 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.
CALLPAGE_POST_RESET_VOICE_MESSAGEAcciónTool 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.
Parámetros de entrada
widget_idintegerObligatorioIdentifier of the widget.
message_idstringIdentifier of a specific voice message to reset. If omitted, all voice messages will be reset.
Parámetros de salida
datanullerrorstringError if any occurred during the execution of the action
messagestringhasErrorbooleanObligatorioerrorCodeintegersuccessfulbooleanObligatorioWhether or not the action execution was successful or not
Update ManagerCALLPAGE_POST_UPDATE_MANAGERAcciónTool to update an existing manager. use when you need to modify a manager's availability or business hours after retrieving their record.
CALLPAGE_POST_UPDATE_MANAGERAcciónTool to update an existing manager. use when you need to modify a manager's availability or business hours after retrieving their record.
Parámetros de entrada
enabledbooleanObligatorioTrue to enable calling this manager; false to disable.
user_idintegerObligatorioIdentifier of the manager (user). You can find it in the dashboard managers list.
widget_idintegerObligatorioIdentifier of the widget to which the manager is assigned.
business_timesobject[]Optional list of working-hour rules. If omitted, defaults to Monday–Friday, 09:00–17:00.
Parámetros de salida
dataobjectObligatorioPayload with updated manager ID.
errorstringError if any occurred during the execution of the action
messagestringError or status message.
hasErrorbooleanObligatorioIndicates if the API request resulted in an error.
errorCodeintegerNumeric error code (0 if successful).
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update WidgetCALLPAGE_POST_UPDATE_WIDGETAcciónTool to update an existing widget. use when you need to change widget url, description, settings, language, or enabled state.
CALLPAGE_POST_UPDATE_WIDGETAcciónTool to update an existing widget. use when you need to change widget url, description, settings, language, or enabled state.
Parámetros de entrada
idintegerObligatorioWidget identifier. You can find it in the dashboard widgets list.
urlstringObligatorioWebsite URL where the widget will be installed (e.g., https://callpage.io).
enabledbooleanIndicates whether the widget is enabled (true) or disabled (false).
settingsobject[]Optional list of widget settings objects as defined in the documentation.
descriptionstringOptional description for the widget. If omitted, existing description remains unchanged.
locale_codestringenumLocale code for the widget language (e.g., 'en').
cnczdeeeenesfrhuitltplpt+3
Parámetros de salida
dataobjectObligatorioPayload data containing the widget ID.
errorstringError if any occurred during the execution of the action
messagestringError or status message.
hasErrorbooleanObligatorioIndicates if there was an error.
errorCodeintegerError code if hasError is true.
successfulbooleanObligatorioWhether or not the action execution was successful or not
Widget Call or ScheduleCALLPAGE_POST_WIDGET_CALL_OR_SCHEDULEAcciónTool 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.
CALLPAGE_POST_WIDGET_CALL_OR_SCHEDULEAcciónTool 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.
Parámetros de entrada
idintegerObligatorioWidget identifier. You can find it in the widgets tab.
telstringObligatorioPhone number in E.164 format (e.g. +48123123123).
department_idintegerDepartment identifier. If omitted, the call is routed to all available managers.
Parámetros de salida
dataobjectObligatorioData containing the call or schedule request ID.
errorstringError if any occurred during the execution of the action
messagestringAPI response message.
hasErrorbooleanObligatorioIndicates whether the API returned an error.
errorCodeintegerError code if an error occurred.
successfulbooleanObligatorioWhether or not the action execution was successful or not