NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

SMS Alert

sms_alert

SMS Alert is a versatile multi-channel communication platform enabling businesses to engage with customers through SMS, RCS, Telegram, and WhatsApp via a unified REST API.

Phone & SMSNotificationsWeb del proveedor
Acciones
19
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 (19)

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 SMS Alert BalanceSMS_ALERT_GET_BALANCE_CHECKAcción

Tool to retrieve the current sms credit balance. use when you need an up-to-date credit status before sending 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

Get Group DetailSMS_ALERT_GET_GROUP_DETAILAcción

Tool to retrieve details of a specific sms alert group. use after confirming the group id.

Parámetros de entrada

  • group_idintegerObligatorio

    ID of the group to fetch details

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

Tool to retrieve a list of sms alert groups. use when you need to fetch all groups associated with your account. call after authenticating your api key.

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

Get Sender ID ListSMS_ALERT_GET_SENDER_ID_LISTAcción

Tool to fetch the list of available sender ids. use when you need to retrieve all sender ids associated with your account. use after configuring your api key.

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

Get SMS Template ListSMS_ALERT_GET_TEMPLATE_LISTAcción

Tool to retrieve list of sms templates from your smsalert account. use when you need to display or manage your smsalert templates.

Parámetros de entrada

  • template_typestring

    Filter templates by type, e.g., 'transactional' or 'promotional'.

Parámetros de salida

  • dataobject[]Obligatorio

    List of SMS template objects.

  • errorstring

    Error if any occurred during the execution of the action

  • statusstringObligatorio

    API call status, 'success' or 'error'.

  • messagestring

    Additional information or error message from the API.

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create New ContactSMS_ALERT_POST_CREATE_CONTACTAcción

Create new contact

Parámetros de entrada

  • namestringObligatorio

    Full name of the contact

  • groupstringObligatorio

    Name of the group to which the contact(s) will be added

  • mobilestringObligatorio

    Mobile number(s) as a 10-digit string, comma-separated for multiple contacts

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

Tool to create a new contact group. use when needing to organize contacts into a new group.

Parámetros de entrada

  • namestringObligatorio

    Name of the group to create. Only letters, numbers, hyphens, and underscores are allowed. Spaces are not permitted.

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

Tool to create a short url for a given long url. use when you need to shorten a url before sharing.

Parámetros de entrada

  • urlstringObligatorio

    The original long URL to shorten

  • aliasstring

    Custom alias for the short URL; omit or set to null for system-generated alias

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

Tool to create a new sms template. use when you need to define reusable message content.

Parámetros de entrada

  • namestringObligatorio

    Name of the SMS template

  • textstringObligatorio

    Text content of the SMS template

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

Tool to delete a specified contact. use after confirming the contact's id.

Parámetros de entrada

  • idstringObligatorio

    The Contact Number 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

Delete GroupSMS_ALERT_POST_DELETE_GROUPAcción

Tool to delete a specified group. use after confirming the group's id.

Parámetros de entrada

  • idintegerObligatorio

    The unique identifier of the SMS Alert group 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

Delete Short URLSMS_ALERT_POST_DELETE_SHORT_URLAcción

Tool to delete an existing short url. use after confirming the short url's id.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the short URL 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

Delete SMS TemplateSMS_ALERT_POST_DELETE_TEMPLATEAcción

Tool to delete an existing sms template. use when you have the template id to remove it.

Parámetros de entrada

  • template_idstringObligatorio

    The unique identifier of the SMS template 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

Edit ContactSMS_ALERT_POST_EDIT_CONTACTAcción

Tool to edit an existing contact’s details. use when you need to update a contact’s information after confirming the contact id.

Parámetros de entrada

  • namestring

    New name for the contact

  • emailstring

    New email address for the contact

  • group_idstring

    ID of the group to assign the contact to

  • mobilenostring

    New mobile number for the contact; must be unique

  • contact_idstringObligatorio

    Unique identifier of the contact 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

Edit GroupSMS_ALERT_POST_EDIT_GROUPAcción

Tool to edit an existing groups name. use when you need to rename a group after confirming the group id.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the group to update

  • namestringObligatorio

    New name for the group

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

Tool to update user account profile details. use when modifying authenticated user profile after login.

Parámetros de entrada

  • gststring

    GST number

  • citystring

    City name

  • emailstring

    Email address

  • statestring

    State name

  • addressstring

    Physical address

  • companystring

    Company name

  • countrystring

    Country

  • pincodestring

    Postal PIN code

  • mobilenostringObligatorio

    Registered mobile number

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

Edit SMS TemplateSMS_ALERT_POST_EDIT_TEMPLATEAcción

Tool to edit an existing sms template. use when you need to update a template after confirming the template id.

Parámetros de entrada

  • idstringObligatorio

    Unique identifier of the template to update

  • namestringObligatorio

    New name for the template

  • textstringObligatorio

    New SMS content for the template

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

Generate OTPSMS_ALERT_POST_GENERATE_OTPAcción

Tool to generate a one-time password (otp). use when you need to send an otp to a mobile number using a predefined template.

Parámetros de entrada

  • senderstring

    Sender ID approved by SMS Alert, up to 6 characters

  • mobilenostringObligatorio

    Mobile number(s) to send OTP, comma-separated, with or without country code

  • templatestringObligatorio

    Template for OTP containing the [otp] tag, e.g., '[otp]'

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 Sent SMS ReportSMS_ALERT_POST_SENT_SMS_REPORTAcción

Tool to retrieve sms campaign sent report details. use after campaigns are sent to analyze delivery results.

Parámetros de entrada

  • pageinteger

    Page number for results (≥ 1)

  • limitinteger

    Records per page (≥ 1)

  • mobilestring

    Comma-separated mobile numbers to filter the report

  • campaignuniqueidstring

    Filter by specific campaign unique ID

Parámetros de salida

  • dataobject[]Obligatorio

    List of sent SMS log entries

  • pageintegerObligatorio

    Current page number returned

  • errorstring

    Error if any occurred during the execution of the action

  • limitintegerObligatorio

    Limit of records per page

  • statusstringObligatorioenum

    API response status, success or failure

    successfailure
  • messagestringObligatorio

    Response message from API

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

  • total_recordsintegerObligatorio

    Total records matching the query