Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notification Message

Send Single Notification Message

post

Function Description

      * Sends a notification message.
      ---
      ## Detailed Description
      * The dto containing the variables of the message template to be sent must inherit the MessageCommonDto class to include the required information.
      * If langCd is not sent, the template is retrieved based on the langCd value in the cookie.
      * If no template matching the template ID exists, sending is not possible.
      * Variables of templates included in common code ST010 are automatically filled in.
      * For messages of 90 bytes or more, SMS is sent as LMS.
      * Required parameters by notification message type
         * Alimtalk: Template ID (tmplId), Recipient Number (rcvgTlphNo)
         * SMS: Template ID (tmplId), Recipient Number (rcvgTlphNo)
         * Notification Box: Template ID (tmplId), Member No. (mbrNo)
      ## Revision History
      * ```Release v1.01_231010```: Changed SMS to LMS for messages of 90 bytes or more
      * ```Release v2.00_240425```: Added site condition when retrieving templates, due to multi-site expansion
Header parameters
AuthorizationanyOptional

Access Token

Body
objectOptional
Responses
200

Success

No content
post/v1/common/sendMessage
POST /api/common/v1/common/sendMessage HTTP/1.1
Host: api-common.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2

{}
No content

Send Multiple Notification Messages

post

Function Description

  • Sends notification messages in bulk.

Detailed Description

  • The dto containing the variables of the message template to be sent must inherit the MessageCommonDto class to include the required information.

  • If langCd is not sent, the template is retrieved based on the langCd value in the cookie.

  • If no template matching the template ID exists, sending is not possible.

  • Variables of templates included in common code ST010 are automatically filled in.

  • For messages of 90 bytes or more, SMS is sent as LMS.

  • Required parameters by notification message type

    • Alimtalk: Template ID (tmplId), Recipient Number (rcvgTlphNo)

    • SMS: Template ID (tmplId), Recipient Number (rcvgTlphNo)

    • Notification Box: Template ID (tmplId), Member No. (mbrNo)

Revision History

  • Release v1.01_231010: Changed SMS to LMS for messages of 90 bytes or more

  • Release v2.00_240425: Added site condition when retrieving templates, due to multi-site expansion

Header parameters
AuthorizationanyOptional

Access Token

Bodyany[]
itemsanyOptional
Responses
200

Success

No content
post/v1/common/sendMessageList
POST /api/common/v1/common/sendMessageList HTTP/1.1
Host: api-common.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 2

[]
No content
PreviousCommon API
NextCommon

Last updated