@line/bot-sdk/lib/messaging-api/model/multicastRequest.ts

Node.js SDK for LINE Messaging API

/**
 * LINE Messaging API
 * This document describes LINE Messaging API.
 *
 * The version of the OpenAPI document: 0.0.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { Message } from "./message.js";

export type MulticastRequest = {
  /**
   * Messages to send
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-multicast-message">messages Documentation</a>
   */
  messages: Array<Message> /**/;
  /**
   * Array of user IDs. Use userId values which are returned in webhook event objects. Do not use LINE IDs found on LINE.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-multicast-message">to Documentation</a>
   */
  to: Array<string> /**/;
  /**
   * `true`: The user doesn’t receive a push notification when a message is sent. `false`: The user receives a push notification when the message is sent (unless they have disabled push notifications in LINE and/or their device). The default value is false.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-multicast-message">notificationDisabled Documentation</a>
   */
  notificationDisabled?: boolean /* = false*/;
  /**
   * Name of aggregation unit. Case-sensitive.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-multicast-message">customAggregationUnits Documentation</a>
   */
  customAggregationUnits?: Array<string> /**/;
};