NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Spoki

spoki

Spoki is an Italian platform that integrates WhatsApp's official APIs to automate communication for marketing, sales, customer support, and payments.

Marketing AutomationPhone & SMSWeb del proveedor
Acciones
22
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 (22)

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.

Create custom fieldSPOKI_CREATE_CUSTOM_FIELDAcción

Tool to create a new custom field. use when defining extra data points for contacts.

Parámetros de entrada

  • codestringObligatorio

    Programmatic code (uppercase underscore, unique, non-reserved).

  • labelstringObligatorio

    Human-readable label (uppercase, unique, non-reserved).

  • examplestringObligatorio

    Example or default value for the field.

  • field_typeintegerObligatorioenum

    Type: 1=TEXT, 2=DATE, 3=DATETIME.

    123

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 or Update ContactSPOKI_CREATE_OR_UPDATE_CONTACTAcción

Tool to create or update a contact. use when you need to upsert a single contact record via the sync endpoint.

Parámetros de entrada

  • emailstringemail

    Email address of the contact

  • phonestringObligatorio

    Contact phone number in E.164 format, e.g. '+393331234567'

  • languagestring

    Language code for the contact, e.g. 'en'

  • last_namestring

    Last name of the contact

  • first_namestring

    First name of the contact

  • custom_fieldsobject

    Custom field values as key-value pairs

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

Delete contactSPOKI_DELETE_CONTACTAcción

Tool to delete a specific contact. use after confirming the contact id. example prompt: "delete contact with id 1091234."

Parámetros de entrada

  • idintegerObligatorio

    ID of the contact to delete

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 Account Current ReportSPOKI_GET_ACCOUNT_CURRENT_REPORTAcción

Tool to get the current report for a specified account. use when you need up-to-date metrics on messages and conversations for an account. note: result is cached for 30 minutes.

Parámetros de entrada

  • account_idintegerObligatorio

    ID of the account to retrieve the current report for

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

List AgenciesSPOKI_LIST_AGENCIESAcción

Tool to list all agencies accessible to the user. use when you need to retrieve all agencies for the authenticated account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobject[]Obligatorio

    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

List AutomationsSPOKI_LIST_AUTOMATIONSAcción

Tool to list, search, and filter automations. use after authenticating to retrieve available automations and apply optional search or platform filters.

Parámetros de entrada

  • searchstring

    Search automations by name or webhook link

  • is_activeboolean

    Filter by active (true) or inactive (false) automations

  • webhook_platformstringenum

    Filter automations by webhook integration platform

    ApiActive CampaignWoocommerceMagentoPrestashopShopifyZapierQapla'BrainLeadHubSpotKlaviyoZoho+7

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

List campaignsSPOKI_LIST_CAMPAIGNSAcción

Tool to list, search, and filter campaigns. use when you need to retrieve campaigns optionally filtered by scheduled datetime.

Parámetros de entrada

  • scheduled_datetime_gtestring

    Only include campaigns scheduled on or after this timestamp (ISO 8601).

  • scheduled_datetime_ltestring

    Only include campaigns scheduled on or before this timestamp (ISO 8601).

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

List ContactsSPOKI_LIST_CONTACTSAcción

Tool to list, search, and filter contacts. use when you need to retrieve contacts with optional search and filters.

Parámetros de entrada

  • taginteger

    Filter by tag ID

  • emailstring

    Filter by email (exact match)

  • phonestring

    Filter by phone (exact match)

  • searchstring

    Search query for phone, email, first_name, last_name, language, or notes

  • languagestring

    Filter by language code

  • last_namestring

    Filter by last name

  • first_namestring

    Filter by first name

  • is_blockedboolean

    Filter blocked contacts only when true

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

List tagsSPOKI_LIST_TAGSAcción

Tool to list, search, and filter tags. use when you need to fetch all tags for the account.

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

List templatesSPOKI_LIST_TEMPLATESAcción

Tool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.

Parámetros de entrada

  • searchstring

    Search term to filter templates by id, name, or text

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

List TicketsSPOKI_LIST_TICKETSAcción

Tool to list, search, and filter tickets. use when you need to retrieve tickets with optional pagination and filters.

Parámetros de entrada

  • pageinteger

    Page number for pagination, must be >= 1.

  • orderstringenum

    Order of sorting: 'asc' or 'desc'.

    ascdesc
  • statusstring

    Filter tickets by status, e.g., OPEN, PENDING, RESOLVED, or CLOSED.

  • sort_bystring

    Field to sort by, e.g., created_datetime.

  • per_pageinteger

    Number of tickets per page, must be >= 1.

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

Retrieve AccountSPOKI_RETRIEVE_ACCOUNTAcción

Tool to retrieve details of a specific account. use after confirming the account id is valid.

Parámetros de entrada

  • account_idintegerObligatorio

    Unique identifier of the account to retrieve

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

Retrieve AutomationSPOKI_RETRIEVE_AUTOMATIONAcción

Tool to retrieve details of a specific automation. use after listing automations to fetch full details including webhooks and timestamps. example: retrieve automation with id 345016.

Parámetros de entrada

  • idintegerObligatorio

    ID of the automation to retrieve

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

Retrieve ContactSPOKI_RETRIEVE_CONTACTAcción

Tool to retrieve details of a specific contact. use when you have a contact id and need full profile details.

Parámetros de entrada

  • contact_idintegerObligatorio

    Unique identifier of the contact to retrieve

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

Retrieve TagSPOKI_RETRIEVE_TAGAcción

Tool to retrieve details of a specific tag. use when you need tag metadata by id.

Parámetros de entrada

  • idintegerObligatorio

    ID of the tag to retrieve

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

Retrieve TemplateSPOKI_RETRIEVE_TEMPLATEAcción

Tool to retrieve details of a specific template. use after obtaining a template id.

Parámetros de entrada

  • template_idintegerObligatorio

    Unique identifier of the template to retrieve

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

List Custom FieldsSPOKI_SPOKI_LIST_CUSTOM_FIELDSAcción

Tool to list, search, and filter custom fields. use when you need to fetch available custom-field definitions by label or code.

Parámetros de entrada

  • codestring

    Filter custom fields whose code contains this string

  • labelstring

    Filter custom fields whose label contains this string

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

Spoki list partnersSPOKI_SPOKI_LIST_PARTNERSAcción

Deprecated placeholder for spoki list partners action file

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

List TagsSPOKI_SPOKI_LIST_TAGSAcción

Tool to list, search, and filter tags. use when you need to fetch all tags for the account.

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

List WhatsApp templatesSPOKI_SPOKI_LIST_TEMPLATESAcción

Tool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.

Parámetros de entrada

  • searchstring

    Filter templates by id, name, or text

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

Retrieve Custom FieldSPOKI_SPOKI_RETRIEVE_CUSTOM_FIELDAcción

Tool to retrieve details of a specific custom field. use when you have a field id and need its metadata before using it in automations.

Parámetros de entrada

  • custom_field_idintegerObligatorio

    The unique identifier of the custom field to retrieve

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

Update Custom FieldSPOKI_UPDATE_CUSTOM_FIELDAcción

Tool to update a specific custom field. use after retrieving a field to change its label.

Parámetros de entrada

  • labelstringObligatorio

    New display label of the custom field

  • custom_field_idintegerObligatorio

    Unique identifier of the custom field to update

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