NAiOS IconNAiOS Logo
Volver al catálogo

Superchat

superchat

Superchat 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
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.

Create ContactSUPERCHAT_CREATE_CONTACTAcción

Tool to create a new contact. use when you need to register contact details before sending messages.

Parámetros de entrada

  • genderstringenum

    Gender of the contact.

    femalemalediverse
  • handlesobject[]Obligatorio

    List of one or more contact handles.

  • last_namestring

    Last name of the contact.

  • first_namestring

    First name of the contact.

  • custom_attributesobject[]

    Optional list of custom attributes.

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

Tool 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

  • namestringObligatorio

    Name of the new template folder.

  • parent_folder_idstring

    ID of an existing folder to nest this folder under (optional).

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

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

    Unique identifier of the webhook to delete, always prefixed with 'wh_' or similar.

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

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

    The unique identifier of the contact.

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

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

    Unique identifier of the file to retrieve, always prefixed with 'fi_'.

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

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

    Unique identifier of the user 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 ChannelsSUPERCHAT_LIST_CHANNELSAcción

Tool to list all channels. use when you need to fetch available channels, optionally paginated by `limit`, `after`, or `before`.

Parámetros de entrada

  • afterstring

    Cursor after which channels should be returned. Cannot be used with 'before'.

  • limitinteger

    Total number of channels to return (1-100).

  • beforestring

    Cursor before which channels should be returned. Cannot be used with 'after'.

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

Tool 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

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

Tool to list all conversations. use when you need to retrieve all conversation ids and metadata, optionally paginated.

Parámetros de entrada

  • afterstring

    Cursor after which to return conversations. Cannot be used with 'before'.

  • limitinteger

    Number of conversations to return (minimum 1).

  • beforestring

    Cursor before which to return conversations. Cannot be used with 'after'.

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

Tool 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

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

Tool 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

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

Tool to list all labels. use when you need to fetch available labels, optionally paginated.

Parámetros de entrada

  • nextstring

    Cursor for fetching the next page of results. Cannot be used with `previous`.

  • limitinteger

    Maximum number of labels to return (must be ≥1).

  • previousstring

    Cursor for fetching the previous page of results. Cannot be used with `next`.

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

Tool 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

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

Tool 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

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

Tool 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

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

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

    Last name of the contact.

  • contact_idanyObligatorio

    Unique identifier of the contact to update, prefixed with 'co_'.

  • first_namestring

    First name of the contact.

  • custom_attributesobject[]

    List of custom attributes to update for this contact.

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

Tool 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

  • urlanyuri

    New callback URL for the webhook.

  • eventsstring[]

    List of event names to subscribe to. Omit to leave unchanged.

  • statusstringenum

    Webhook status; 'active' to enable or 'inactive' to disable.

    activeinactive
  • webhook_idanyObligatorio

    Unique identifier of the webhook to update, prefixed with 'wh_'.

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