Skip to main content

Feature Overview｜SMS+ API (Supports Event Tracking)

  • Updated

    Feature Overview

    SMS+ API provides brands with an integrated message delivery solution. By integrating a single API, brands can automatically select the most appropriate communication channel based on the user's phone number. It also supports event-level attribution (Event ID) and custom identifiers (Customized ID) to help brands:

    • Reach users at the lowest possible cost
    • Simplify sending mechanisms and reduce development costs
    • Build a foundation for cross-channel marketing performance analysis
    • Enable event attribution and extend automated workflows
    • Support billing queries, appointment reminders, and event notification record matching

    This feature is especially useful for:

    • Marketing campaigns that require ROI tracking across multiple channels
    • Brands that need to integrate CRM/reservation system fields for message record queries
    • Inviting potential users who have not yet added the LINE Official Account
    Channel Priority Description
    LINE Push Only available if the user is a LINE friend and can be matched to a MAAC contact via phone number
    LINE Notification Message Delivered as long as the user has not blocked the brand
    SMS Used only if both LINE Push and LINE Notification Message fail

    📄 For detailed rules on Notification Messages, please refer to: Help Center｜Feature Overview｜LINE Notification Message Description

    Setup Guide

    Step 1: Feature Activation

    Please contact your CSM to enable the following:

    Step 2: Obtain Sending Token

    1. Request an OpenAPI Token from MAAC with Notification messages permission
    2. Once the token is issued, you can start integrating with SMS+ API

    📄 API Documentation:
    https://cresclab.docs.apiary.io/#reference/+/1/(push)

    Xnip2025-04-10_16-42-36.png

    Step 3: API Integration & Field Reference

    Depending on your use case, SMS+ API integration can be divided into the following scenarios:

    Scenario 1: Campaign Performance Tracking (Recommended for marketing messages)

    If you need to track delivery rate and conversion performance for a specific campaign (e.g., registration, member acquisition, survey invitations), you can use the event_id feature for attribution and reporting.

    Integration flow:

    1. Create Campaign Event
      Use MAAC OpenAPI to create the event and obtain the event_id
      API Doc: https://cresclab.docs.apiary.io/#reference/3/1/(push)
    2. Send via SMS+ API
      Add event_id to your API request. The system will attribute the message to the event for later reporting.
      API Doc: https://cresclab.docs.apiary.io/#reference/+/1
    3. View Performance Report
      In MAAC, filter by event_name to view delivery status and analyze campaign performance

    The report supports:

    • View all messages under the same event_name
    • View delivery status and breakdown by channel (e.g., LINE Push, Notification Message, SMS)
    • Aggregate total sends and results per event
    Note: Event List Sorting
    Events in the MAAC backend are sorted by event_id creation time (latest first)

    Additional Notes:

    • event_name supports up to 100,000 characters
    • If event_id is not provided, the message will appear under “SMS+ API” in the performance report (unattributed)
    • event_name automatically aggregates all template data sent via that event ID
    • You can use the dropdown to view per-template delivery counts and success rates, including channel-specific stats

    Scenario 2: Message Sending Only (No Attribution)

    If you only need to send messages (e.g., notification messages, billing reminders, system alerts), you can call SMS+ API directly without creating an event or specifying event_id.

    Integration flow:

    1. Call SMS+ API
      Include the designated template & parameters in the request.
      API Doc: https://cresclab.docs.apiary.io/#reference/+/1

    These messages will not be attributed but can still be viewed in the MAAC backend.

    Scenario 3: Query by Custom Field (customized_id)

    If you want to match SMS records in the backend or your system, include customized_id (e.g., billing number, appointment code) in the request and use it for querying status or matching.

    Use cases:

    • Billing: Query delivery status based on bill number
    • Customer Support: Track whether an individual user notification was delivered
    • System Integration: Link SMS with CRM, ERP, or reservation system events

    Important Notes:

    • customized_id is optional
    • Max length: 32 characters
    • Supports alphanumeric only (avoid special characters)

    After sending, you can query by customized_id in the “SMS+ API Logs” page, or retrieve it from webhook status notifications.

    How to Query Delivery Results

    You can check the following in the MAAC backend:

    • Message delivery records and statuses
    • Failure reasons (e.g., format error, UID not bound, SMS contains sensitive words)

    Related articles