Superchat
superchatSuperchat is a unified messaging platform that enables businesses to communicate with customers across multiple channels, including WhatsApp, Instagram Direct, Facebook Messenger, Email, and more.
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.
Create ContactSUPERCHAT_CREATE_CONTACTAcciónTool to create a new contact. use when you need to register contact details before sending messages.
SUPERCHAT_CREATE_CONTACTAcciónTool to create a new contact. use when you need to register contact details before sending messages.
Parámetros de entrada
genderstringenumGender of the contact.
femalemalediversehandlesobject[]ObligatorioList of one or more contact handles.
last_namestringLast name of the contact.
first_namestringFirst name of the contact.
custom_attributesobject[]Optional list of custom attributes.
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 Template FolderSUPERCHAT_CREATE_TEMPLATE_FOLDERAcciónTool to create a new template folder in superchat. use when you need to organize message templates into folders before populating them.
SUPERCHAT_CREATE_TEMPLATE_FOLDERAcciónTool to create a new template folder in superchat. use when you need to organize message templates into folders before populating them.
Parámetros de entrada
namestringObligatorioName of the new template folder.
parent_folder_idstringID of an existing folder to nest this folder under (optional).
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 WebhookSUPERCHAT_DELETE_WEBHOOKAcciónTool to delete a specific webhook by its id. use when you need to remove an obsolete or compromised webhook after confirming its id. example: delete webhook wh 12345.
SUPERCHAT_DELETE_WEBHOOKAcciónTool to delete a specific webhook by its id. use when you need to remove an obsolete or compromised webhook after confirming its id. example: delete webhook wh 12345.
Parámetros de entrada
webhook_idstringObligatorioUnique identifier of the webhook to delete, always prefixed with 'wh_' or similar.
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 ContactSUPERCHAT_GET_CONTACTAcciónTool to retrieve details of a specific contact by its id. use when you need to view a contact's information after verifying its existence. example: "fetch contact info for id abc123".
SUPERCHAT_GET_CONTACTAcciónTool to retrieve details of a specific contact by its id. use when you need to view a contact's information after verifying its existence. example: "fetch contact info for id abc123".
Parámetros de entrada
contact_idstringObligatorioThe unique identifier of the contact.
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 FileSUPERCHAT_GET_FILEAcciónTool to retrieve metadata of a specific file. use when you have the file id and need file information before downloading.
SUPERCHAT_GET_FILEAcciónTool to retrieve metadata of a specific file. use when you have the file id and need file information before downloading.
Parámetros de entrada
file_idstringObligatorioUnique identifier of the file to retrieve, always prefixed with 'fi_'.
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 UserSUPERCHAT_GET_USERAcciónTool to retrieve details of a specific user by their id. use when you need to view or manage a user's profile. example: "fetch user info for id '123e4567-e89b-12d3-a456-426614174000'".
SUPERCHAT_GET_USERAcciónTool to retrieve details of a specific user by their id. use when you need to view or manage a user's profile. example: "fetch user info for id '123e4567-e89b-12d3-a456-426614174000'".
Parámetros de entrada
user_idstringObligatorioUnique identifier of the user 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 ChannelsSUPERCHAT_LIST_CHANNELSAcciónTool to list all channels. use when you need to fetch available channels, optionally paginated by `limit`, `after`, or `before`.
SUPERCHAT_LIST_CHANNELSAcciónTool to list all channels. use when you need to fetch available channels, optionally paginated by `limit`, `after`, or `before`.
Parámetros de entrada
afterstringCursor after which channels should be returned. Cannot be used with 'before'.
limitintegerTotal number of channels to return (1-100).
beforestringCursor before which channels should be returned. Cannot be used with 'after'.
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 ContactsSUPERCHAT_LIST_CONTACTSAcciónTool to list all contacts. use when you need to fetch the full list of contacts for selection or reporting.
SUPERCHAT_LIST_CONTACTSAcciónTool to list all contacts. use when you need to fetch the full list of contacts for selection or reporting.
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 ConversationsSUPERCHAT_LIST_CONVERSATIONSAcciónTool to list all conversations. use when you need to retrieve all conversation ids and metadata, optionally paginated.
SUPERCHAT_LIST_CONVERSATIONSAcciónTool to list all conversations. use when you need to retrieve all conversation ids and metadata, optionally paginated.
Parámetros de entrada
afterstringCursor after which to return conversations. Cannot be used with 'before'.
limitintegerNumber of conversations to return (minimum 1).
beforestringCursor before which to return conversations. Cannot be used with 'after'.
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 AttributesSUPERCHAT_LIST_CUSTOM_ATTRIBUTESAcciónTool to list all custom contact attributes. use when you need to retrieve definitions of custom contact fields in your account.
SUPERCHAT_LIST_CUSTOM_ATTRIBUTESAcciónTool to list all custom contact attributes. use when you need to retrieve definitions of custom contact fields in your 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 InboxesSUPERCHAT_LIST_INBOXESAcciónTool to list all inboxes. use when you need to retrieve inbox ids and metadata before sending or organizing messages.
SUPERCHAT_LIST_INBOXESAcciónTool to list all inboxes. use when you need to retrieve inbox ids and metadata before sending or organizing messages.
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 LabelsSUPERCHAT_LIST_LABELSAcciónTool to list all labels. use when you need to fetch available labels, optionally paginated.
SUPERCHAT_LIST_LABELSAcciónTool to list all labels. use when you need to fetch available labels, optionally paginated.
Parámetros de entrada
nextstringCursor for fetching the next page of results. Cannot be used with `previous`.
limitintegerMaximum number of labels to return (must be ≥1).
previousstringCursor for fetching the previous page of results. Cannot be used with `next`.
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 TemplatesSUPERCHAT_LIST_TEMPLATESAcciónTool to list all message templates. use when you need to fetch available message templates.
SUPERCHAT_LIST_TEMPLATESAcciónTool to list all message templates. use when you need to fetch available message templates.
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 UsersSUPERCHAT_LIST_USERSAcciónTool to list all users. use when you need to retrieve a directory of all workspace users.
SUPERCHAT_LIST_USERSAcciónTool to list all users. use when you need to retrieve a directory of all workspace users.
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 WebhooksSUPERCHAT_LIST_WEBHOOKSAcciónTool to list all webhooks. use when you need to retrieve all webhooks configured in the workspace.
SUPERCHAT_LIST_WEBHOOKSAcciónTool to list all webhooks. use when you need to retrieve all webhooks configured in the workspace.
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
Update ContactSUPERCHAT_UPDATE_CONTACTAcciónTool to update information for a specific contact in superchat. use after retrieving a contact to modify its name or attributes. example: "update contact co 12345 to change first name to jane."
SUPERCHAT_UPDATE_CONTACTAcciónTool to update information for a specific contact in superchat. use after retrieving a contact to modify its name or attributes. example: "update contact co 12345 to change first name to jane."
Parámetros de entrada
last_namestringLast name of the contact.
contact_idanyObligatorioUnique identifier of the contact to update, prefixed with 'co_'.
first_namestringFirst name of the contact.
custom_attributesobject[]List of custom attributes to update for this contact.
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 WebhookSUPERCHAT_UPDATE_WEBHOOKAcciónTool to update the details of a specific webhook. use when you need to modify an existing webhook's url, events, or status.
SUPERCHAT_UPDATE_WEBHOOKAcciónTool to update the details of a specific webhook. use when you need to modify an existing webhook's url, events, or status.
Parámetros de entrada
urlanyuriNew callback URL for the webhook.
eventsstring[]List of event names to subscribe to. Omit to leave unchanged.
statusstringenumWebhook status; 'active' to enable or 'inactive' to disable.
activeinactivewebhook_idanyObligatorioUnique identifier of the webhook to update, prefixed with 'wh_'.
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