Spoki
spokiSpoki is an Italian platform that integrates WhatsApp's official APIs to automate communication for marketing, sales, customer support, and payments.
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ónTool to create a new custom field. use when defining extra data points for contacts.
SPOKI_CREATE_CUSTOM_FIELDAcciónTool to create a new custom field. use when defining extra data points for contacts.
Parámetros de entrada
codestringObligatorioProgrammatic code (uppercase underscore, unique, non-reserved).
labelstringObligatorioHuman-readable label (uppercase, unique, non-reserved).
examplestringObligatorioExample or default value for the field.
field_typeintegerObligatorioenumType: 1=TEXT, 2=DATE, 3=DATETIME.
123
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 or Update ContactSPOKI_CREATE_OR_UPDATE_CONTACTAcciónTool to create or update a contact. use when you need to upsert a single contact record via the sync endpoint.
SPOKI_CREATE_OR_UPDATE_CONTACTAcciónTool to create or update a contact. use when you need to upsert a single contact record via the sync endpoint.
Parámetros de entrada
emailstringemailEmail address of the contact
phonestringObligatorioContact phone number in E.164 format, e.g. '+393331234567'
languagestringLanguage code for the contact, e.g. 'en'
last_namestringLast name of the contact
first_namestringFirst name of the contact
custom_fieldsobjectCustom field values as key-value pairs
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
Delete contactSPOKI_DELETE_CONTACTAcciónTool to delete a specific contact. use after confirming the contact id. example prompt: "delete contact with id 1091234."
SPOKI_DELETE_CONTACTAcciónTool to delete a specific contact. use after confirming the contact id. example prompt: "delete contact with id 1091234."
Parámetros de entrada
idintegerObligatorioID of the contact to delete
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 Account Current ReportSPOKI_GET_ACCOUNT_CURRENT_REPORTAcciónTool 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.
SPOKI_GET_ACCOUNT_CURRENT_REPORTAcciónTool 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_idintegerObligatorioID of the account to retrieve the current report for
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
List AgenciesSPOKI_LIST_AGENCIESAcciónTool to list all agencies accessible to the user. use when you need to retrieve all agencies for the authenticated account.
SPOKI_LIST_AGENCIESAcciónTool 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[]ObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List AutomationsSPOKI_LIST_AUTOMATIONSAcciónTool to list, search, and filter automations. use after authenticating to retrieve available automations and apply optional search or platform filters.
SPOKI_LIST_AUTOMATIONSAcciónTool to list, search, and filter automations. use after authenticating to retrieve available automations and apply optional search or platform filters.
Parámetros de entrada
searchstringSearch automations by name or webhook link
is_activebooleanFilter by active (true) or inactive (false) automations
webhook_platformstringenumFilter automations by webhook integration platform
ApiActive CampaignWoocommerceMagentoPrestashopShopifyZapierQapla'BrainLeadHubSpotKlaviyoZoho+7
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
List campaignsSPOKI_LIST_CAMPAIGNSAcciónTool to list, search, and filter campaigns. use when you need to retrieve campaigns optionally filtered by scheduled datetime.
SPOKI_LIST_CAMPAIGNSAcciónTool to list, search, and filter campaigns. use when you need to retrieve campaigns optionally filtered by scheduled datetime.
Parámetros de entrada
scheduled_datetime_gtestringOnly include campaigns scheduled on or after this timestamp (ISO 8601).
scheduled_datetime_ltestringOnly include campaigns scheduled on or before this timestamp (ISO 8601).
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
List ContactsSPOKI_LIST_CONTACTSAcciónTool to list, search, and filter contacts. use when you need to retrieve contacts with optional search and filters.
SPOKI_LIST_CONTACTSAcciónTool to list, search, and filter contacts. use when you need to retrieve contacts with optional search and filters.
Parámetros de entrada
tagintegerFilter by tag ID
emailstringFilter by email (exact match)
phonestringFilter by phone (exact match)
searchstringSearch query for phone, email, first_name, last_name, language, or notes
languagestringFilter by language code
last_namestringFilter by last name
first_namestringFilter by first name
is_blockedbooleanFilter blocked contacts only when true
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
List tagsSPOKI_LIST_TAGSAcciónTool to list, search, and filter tags. use when you need to fetch all tags for the account.
SPOKI_LIST_TAGSAcciónTool 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
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
List templatesSPOKI_LIST_TEMPLATESAcciónTool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.
SPOKI_LIST_TEMPLATESAcciónTool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.
Parámetros de entrada
searchstringSearch term to filter templates by id, name, or text
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
List TicketsSPOKI_LIST_TICKETSAcciónTool to list, search, and filter tickets. use when you need to retrieve tickets with optional pagination and filters.
SPOKI_LIST_TICKETSAcciónTool to list, search, and filter tickets. use when you need to retrieve tickets with optional pagination and filters.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1.
orderstringenumOrder of sorting: 'asc' or 'desc'.
ascdescstatusstringFilter tickets by status, e.g., OPEN, PENDING, RESOLVED, or CLOSED.
sort_bystringField to sort by, e.g., created_datetime.
per_pageintegerNumber of tickets per page, must be >= 1.
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
Retrieve AccountSPOKI_RETRIEVE_ACCOUNTAcciónTool to retrieve details of a specific account. use after confirming the account id is valid.
SPOKI_RETRIEVE_ACCOUNTAcciónTool to retrieve details of a specific account. use after confirming the account id is valid.
Parámetros de entrada
account_idintegerObligatorioUnique identifier of the account to retrieve
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
Retrieve AutomationSPOKI_RETRIEVE_AUTOMATIONAcciónTool 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.
SPOKI_RETRIEVE_AUTOMATIONAcciónTool 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
idintegerObligatorioID of the automation to retrieve
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
Retrieve ContactSPOKI_RETRIEVE_CONTACTAcciónTool to retrieve details of a specific contact. use when you have a contact id and need full profile details.
SPOKI_RETRIEVE_CONTACTAcciónTool to retrieve details of a specific contact. use when you have a contact id and need full profile details.
Parámetros de entrada
contact_idintegerObligatorioUnique identifier of the contact to retrieve
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
Retrieve TagSPOKI_RETRIEVE_TAGAcciónTool to retrieve details of a specific tag. use when you need tag metadata by id.
SPOKI_RETRIEVE_TAGAcciónTool to retrieve details of a specific tag. use when you need tag metadata by id.
Parámetros de entrada
idintegerObligatorioID of the tag to retrieve
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
Retrieve TemplateSPOKI_RETRIEVE_TEMPLATEAcciónTool to retrieve details of a specific template. use after obtaining a template id.
SPOKI_RETRIEVE_TEMPLATEAcciónTool to retrieve details of a specific template. use after obtaining a template id.
Parámetros de entrada
template_idintegerObligatorioUnique identifier of the template to retrieve
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
List Custom FieldsSPOKI_SPOKI_LIST_CUSTOM_FIELDSAcciónTool to list, search, and filter custom fields. use when you need to fetch available custom-field definitions by label or code.
SPOKI_SPOKI_LIST_CUSTOM_FIELDSAcciónTool 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
codestringFilter custom fields whose code contains this string
labelstringFilter custom fields whose label contains this string
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
Spoki list partnersSPOKI_SPOKI_LIST_PARTNERSAcciónDeprecated placeholder for spoki list partners action file
SPOKI_SPOKI_LIST_PARTNERSAcciónDeprecated placeholder for spoki list partners action file
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
List TagsSPOKI_SPOKI_LIST_TAGSAcciónTool to list, search, and filter tags. use when you need to fetch all tags for the account.
SPOKI_SPOKI_LIST_TAGSAcciónTool 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
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
List WhatsApp templatesSPOKI_SPOKI_LIST_TEMPLATESAcciónTool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.
SPOKI_SPOKI_LIST_TEMPLATESAcciónTool to list, search, and filter whatsapp templates. use when you need to retrieve available templates, optionally filtering by keywords.
Parámetros de entrada
searchstringFilter templates by id, name, or text
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
Retrieve Custom FieldSPOKI_SPOKI_RETRIEVE_CUSTOM_FIELDAcciónTool to retrieve details of a specific custom field. use when you have a field id and need its metadata before using it in automations.
SPOKI_SPOKI_RETRIEVE_CUSTOM_FIELDAcciónTool 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_idintegerObligatorioThe unique identifier of the custom field to retrieve
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
Update Custom FieldSPOKI_UPDATE_CUSTOM_FIELDAcciónTool to update a specific custom field. use after retrieving a field to change its label.
SPOKI_UPDATE_CUSTOM_FIELDAcciónTool to update a specific custom field. use after retrieving a field to change its label.
Parámetros de entrada
labelstringObligatorioNew display label of the custom field
custom_field_idintegerObligatorioUnique identifier of the custom field to update
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