Nqdev: Tích hợp EsmsVN icon

Nqdev: Tích hợp EsmsVN

Send SMS and OTT messages using EsmsVN API.

Actions8

SMS Message → Gửi tin nhắn SMS

AI-generated

Overview

This node integrates with the EsmsVN API to send SMS messages, specifically supporting the "Gửi tin nhắn SMS" (Send SMS Message) operation under the SMS Message resource. It allows users to send text messages to specified phone numbers using different SMS types and brand names.

Common scenarios where this node is beneficial include:

  • Sending promotional or transactional SMS messages to customers.
  • Delivering notifications or alerts via SMS.
  • Using branded sender names (brandnames) for marketing or customer service communications.
  • Testing SMS sending in a sandbox environment without incurring costs.

Practical example:

  • A business wants to send a birthday greeting SMS to a customer with a custom brand name displayed as the sender.
  • An application sends OTP codes or alerts to users' mobile phones using the SMS service.

Properties

Name Meaning
SmsType Type of SMS to send. Options:
- Brandname QC
- Brandname CSKH (default)
- Cố định giá rẻ (Fixed low price)
Brandname The brand name displayed as the sender of the SMS. Only applicable when SmsType is Brandname QC or Brandname CSKH. Can be selected from a list or entered manually.
PhoneNumber Recipient's phone number. Must follow Vietnamese phone number format, e.g., +84912345678 or 0912345678.
Content The content/text of the SMS message to send.
Options Additional optional settings:
- IsUnicode: Send message content as Unicode (supports Vietnamese characters and special symbols).
- Sandbox: Send message in sandbox mode (for testing, no cost).
- Partner Source: Numeric ID for partner source routing if required by EsmsVN.
- Logging Request: Enable logging of each API request for debugging purposes.

Output

The node outputs an array of JSON objects representing the result of the SMS sending operation(s). Each output item includes fields such as:

  • executionId: Unique identifier for the execution run.
  • resource: The resource used ("sms_message").
  • operation: The operation performed ("sendSmsMessage").
  • status: Status of the operation, typically "completed".
  • timestamp: ISO timestamp of when the operation was executed.
  • Other response data returned by the EsmsVN API related to the SMS sending result.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the EsmsVN API.
  • Uses the EsmsVN API endpoints to send SMS messages.
  • The node depends on internal libraries (nqdev-libraries/esmsvn) for handling API communication and resource operations.
  • No additional external services are required beyond the EsmsVN API.

Troubleshooting

  • Invalid phone number format: The phone number must match the regex pattern for Vietnamese numbers. Errors will occur if the format is incorrect. Ensure numbers start with +84 or 0 followed by valid prefixes.
  • Missing or invalid brandname: When using Brandname QC or Brandname CSKH SMS types, a valid brandname must be provided. Selecting from the list or entering a valid string is necessary.
  • API authentication errors: Ensure the API key credential is correctly configured and has permissions to send SMS.
  • Sandbox mode confusion: If messages are sent in sandbox mode, they will not be delivered but only simulated. Disable sandbox mode for real sending.
  • Unicode issues: If the message contains special characters or Vietnamese text, enable the Unicode option to avoid garbled text.
  • Logging enabled: Enabling logging can help debug failed requests by providing detailed API call information.

Links and References

  • EsmsVN API Documentation
  • Vietnamese phone number format reference: +84 country code and local prefixes
  • General SMS sending best practices and regulations in Vietnam

Discussion