NAiOS IconNAiOS Logo
Volver al catálogo

Callpage

callpage

CallPage 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
17
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

  • limitinteger

    Maximum number of manager records to return.

  • offsetinteger

    Number of items to skip before starting to collect the result set.

  • widget_idintegerObligatorio

    Identifier of the widget to list managers for.

Parámetros de salida

  • dataobject[]Obligatorio

    List of manager assignments for the widget.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Additional information about the API response.

  • hasErrorbooleanObligatorio

    Indicates if the API request resulted in an error.

  • errorCodeintegerObligatorio

    Numeric error code (0 if successful).

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All SMS MessagesCALLPAGE_GET_ALL_SMS_MESSAGESAcción

Tool 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_idintegerObligatorio

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

Parámetros de salida

  • dataobject[]Obligatorio

    List of SMS messages for the given widget.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Error message, if any.

  • hasErrorbooleanObligatorio

    Indicates if an error occurred.

  • errorCodeintegerObligatorio

    Error code, if any.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All UsersCALLPAGE_GET_ALL_USERSAcción

Tool 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

  • limitinteger

    If set, the result will be limited to this number of users.

  • offsetinteger

    If set, the result will be offset by this value for pagination.

Parámetros de salida

  • dataobject[]Obligatorio

    List of user objects returned by this call.

  • metaobjectObligatorio

    Pagination metadata for the returned list.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Optional message from the API.

  • hasErrorbooleanObligatorio

    Indicates if the request resulted in an error.

  • errorCodeintegerObligatorio

    Numeric error code (0 if successful).

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get All WidgetsCALLPAGE_GET_ALL_WIDGETSAcción

Tool to retrieve a list of widgets with pagination. use when you need to page through all widgets after api authentication.

Parámetros de entrada

  • limitinteger

    Maximum number of widgets to return. Defaults to 100.

  • offsetinteger

    Number of items to skip before starting to collect the result set. Defaults to 0.

Parámetros de salida

  • dataobject[]Obligatorio

    List of widgets.

  • metaobjectObligatorio

    Pagination metadata.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Message returned by the API.

  • hasErrorbooleanObligatorio

    Whether the API returned an error.

  • errorCodeintegerObligatorio

    Error code returned by the API.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get API RootCALLPAGE_GET_API_ROOTAcción

Tool 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

  • dataarrayObligatorio

    Payload array; always empty for the root endpoint.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Greeting or error message from the API.

  • hasErrorbooleanObligatorio

    Indicates whether the API returned an error.

  • errorCodeintegerObligatorio

    Numeric error code, 0 when hasError is false.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Manager Status StatisticsCALLPAGE_GET_MANAGER_STATUS_STATISTICSAcción

Tool 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

  • limitinteger

    Maximum number of managers to retrieve per request (optional).

  • offsetinteger

    Pagination offset for listing managers (optional).

  • widget_idintegerObligatorio

    Widget identifier for which to retrieve manager status statistics.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get SMS StatisticsCALLPAGE_GET_SMS_STATISTICSAcción

Tool 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_idintegerObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get WidgetCALLPAGE_GET_WIDGETAcción

Tool 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

  • idintegerObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Detailed widget data.

  • metaarrayObligatorio

    Additional metadata (usually empty list).

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Message returned by the API.

  • hasErrorbooleanObligatorio

    Whether the API returned an error.

  • errorCodeintegerObligatorio

    Error code returned by the API.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Widget Status StatisticsCALLPAGE_GET_WIDGET_STATUS_STATISTICSAcción

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Voice MessageCALLPAGE_POST_CREATE_VOICE_MESSAGEAcción

Tool 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

  • filestringuri

    URL of the audio file for the custom message (.mp3, .mpga, .wav; max 10 MB).

  • enabledbooleanObligatorio

    Whether the custom voice message should be enabled.

  • widget_idintegerObligatorio

    Identifier of the widget for which to create the voice message.

  • message_idstringObligatorioenum

    Voice message identifier, either 'manager.call' or 'visitor.call'.

    manager.callvisitor.call

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • messagestring

    API response message or error description.

  • hasErrorbooleanObligatorio

    True if the API returned an error.

  • errorCodeinteger

    Error code if an error occurred.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create WidgetCALLPAGE_POST_CREATE_WIDGETAcción

Tool to create a new widget. use when you need to install a widget on your site and retrieve its id.

Parámetros de entrada

  • urlstringObligatorio

    Website URL where the widget will be installed (e.g., https://callpage.io).

  • descriptionstring

    Optional description for the widget. If omitted, defaults to 'Created from REST API. Timestamp: {timestamp}'.

  • locale_codestringenum

    Locale code for the widget language. See widget languages in docs.

    cnczdeeeenesfrhuitltplpt+3

Parámetros de salida

  • dataobjectObligatorio

    Response payload containing the widget ID.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestring

    API response message or error description.

  • hasErrorbooleanObligatorio

    True if the API returned an error.

  • errorCodeinteger

    Error code if hasError is true.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Widget by IdCALLPAGE_POST_DELETE_WIDGETAcción

Tool 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

  • idintegerObligatorio

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

Parámetros de salida

  • datanull

    Always null on successful deletion.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Human-readable message returned by the API.

  • hasErrorbooleanObligatorio

    Indicates whether the API encountered an error.

  • errorCodeintegerObligatorio

    Numeric error code (0 if no error).

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Reset SMSCALLPAGE_POST_RESET_SMSAcción

Tool 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_idintegerObligatorio

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

  • message_idstring

    Optional 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

  • datanull

    Always null on successful reset.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestringObligatorio

    Description of the error, if any.

  • hasErrorbooleanObligatorio

    Indicates if there was an error during the request.

  • errorCodeintegerObligatorio

    Error code corresponding to the error encountered.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Reset Voice MessagesCALLPAGE_POST_RESET_VOICE_MESSAGEAcción

Tool 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_idintegerObligatorio

    Identifier of the widget.

  • message_idstring

    Identifier of a specific voice message to reset. If omitted, all voice messages will be reset.

Parámetros de salida

  • datanull
  • errorstring

    Error if any occurred during the execution of the action

  • messagestring
  • hasErrorbooleanObligatorio
  • errorCodeinteger
  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ManagerCALLPAGE_POST_UPDATE_MANAGERAcción

Tool 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

  • enabledbooleanObligatorio

    True to enable calling this manager; false to disable.

  • user_idintegerObligatorio

    Identifier of the manager (user). You can find it in the dashboard managers list.

  • widget_idintegerObligatorio

    Identifier 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

  • dataobjectObligatorio

    Payload with updated manager ID.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestring

    Error or status message.

  • hasErrorbooleanObligatorio

    Indicates if the API request resulted in an error.

  • errorCodeinteger

    Numeric error code (0 if successful).

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update WidgetCALLPAGE_POST_UPDATE_WIDGETAcción

Tool to update an existing widget. use when you need to change widget url, description, settings, language, or enabled state.

Parámetros de entrada

  • idintegerObligatorio

    Widget identifier. You can find it in the dashboard widgets list.

  • urlstringObligatorio

    Website URL where the widget will be installed (e.g., https://callpage.io).

  • enabledboolean

    Indicates whether the widget is enabled (true) or disabled (false).

  • settingsobject[]

    Optional list of widget settings objects as defined in the documentation.

  • descriptionstring

    Optional description for the widget. If omitted, existing description remains unchanged.

  • locale_codestringenum

    Locale code for the widget language (e.g., 'en').

    cnczdeeeenesfrhuitltplpt+3

Parámetros de salida

  • dataobjectObligatorio

    Payload data containing the widget ID.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestring

    Error or status message.

  • hasErrorbooleanObligatorio

    Indicates if there was an error.

  • errorCodeinteger

    Error code if hasError is true.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Widget Call or ScheduleCALLPAGE_POST_WIDGET_CALL_OR_SCHEDULEAcción

Tool 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

  • idintegerObligatorio

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

  • telstringObligatorio

    Phone number in E.164 format (e.g. +48123123123).

  • department_idinteger

    Department identifier. If omitted, the call is routed to all available managers.

Parámetros de salida

  • dataobjectObligatorio

    Data containing the call or schedule request ID.

  • errorstring

    Error if any occurred during the execution of the action

  • messagestring

    API response message.

  • hasErrorbooleanObligatorio

    Indicates whether the API returned an error.

  • errorCodeinteger

    Error code if an error occurred.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not