Message - Example of Sending Request Body

Notification > Notification Hub > API v1.0 User Guide > Message - Example of Sending Request Body

SMS

SMS (Short)

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "senderPhoneNumber": "01012341234"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "SMS",
    "body": "Hi, this is NHN Cloud Notification Hub.",
  }
}
Name Type Required Description
sender Object Y Sender
sender.senderPhoneNumber String Y Sender Number
content Object Y Message Content
content.messageType String Y SMS
content.body String Y Content

LMS (Long)

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "senderPhoneNumber": "01012341234"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "LMS",
    "title": "[NHN Cloud Notification Hub] Notice",
    "body": "Hi, this is NHN Cloud Notification Hub."
  }
}
Name Type Required Description
sender Object Y Sender
sender.senderPhoneNumber String Y Sender Number
content Object Y Message Content
content.messageType String Y LMS
content.title String Y Title
content.body String Y Content

MMS (Long Media)

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "senderPhoneNumber": "01012341234"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "MMS",
    "title": "[NHN Cloud Notification Hub] Notice",
    "body": "Hi, this is NHN Cloud Notification Hub.",
    "attachmentIds": [
      "Attachment_ID"
    ]
  }
}
Name Type Required Description
sender Object Y Sender
sender.senderPhoneNumber String Y Sender Number
content Object Y Message Content
content.messageType String Y MMS
content.body String Y Content
content.attachmentIds String Array Y Attachment File ID
Attached Image Restrictions.
Supported Codecs: .jpg, .jpeg
Number of Attached Images: 3 or less.
Attached Image Size: 300KB or less per image. However, if there are 3 attached images, the total size of the images must be 800KB or less.
Attached Image Resolution: 1,000×1,000 or less.

RCS

SMS

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "SMS",
    "unsubscribePhoneNumber": "08012341234",
    "smsType": "STANDALONE",
    "cards": [
        {
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.smsType String Y SMS type, required if the message type is SMS, STANDALONE (standard), UNIFIED_STANDALONE (Integrated SMS card)
content.cards Object Array Y Card
content.cards[].title String N Title
content.cards[].description String Y Content
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)
content.cards[].buttons[].buttonJson Object Y Button JSON, check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting value (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration

LMS Standard

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "LMS",
    "unsubscribePhoneNumber": "08012341234",
    "lmsType": "STANDALONE",
    "cards": [
        {
          "title":"[NHN Cloud] Notice",
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.lmsType String Y LMS type, required if the message type is LMS, STANDALONE (Standard), FORMAT_BASIC (Basic format), FORMAT_TITLE_HIGHLIGHT (Highlighted title format), FORMAT_PARAGRAPH (Paragraph format), UNIFIED_STANDALONE (Integrated LMS card)
content.cards Object Array Y Card
content.cards[].title String N Title
content.cards[].description String Y Content
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)
content.cards[].buttons[].buttonJson Object Y Button JSON, Check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration

LMS Format Basic and Format Title Emphasis

  • List of mTitleMedia Icon File IDs
  • Promotion: LT-messagebase.common-jFBCKu
  • Coupon: LT-messagebase.common-LbshOv
  • Event: LT-messagebase.common-aWdsJX
  • Reservation: LT-messagebase.common-5eFcIF
  • Receipt: LT-messagebase.common-rJQ22U
  • Notification: LT-messagebase.common-j11Gtf
{
  "statsKeyId": "Statistics+Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "LMS",
    "unsubscribePhoneNumber": "08012341234",
    "lmsType": "FORMAT_BASIC",
    "cards": [
        {
          "mTitle":"[NHN Cloud] Notice",
          "mTitleMedia":"LT-messagebase.common-DdWk6s",
          "title":"Notice 1",
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.lmsType String Y LMS type, required if the message type is LMS, STANDALONE (Standard), FORMAT_BASIC (Basic format), FORMAT_TITLE_HIGHLIGHT (Highlighted title format), FORMAT_PARAGRAPH (Paragraph format), UNIFIED_STANDALONE (Integrated LMS Card)
content.cards Object Array Y Card
content.cards[].mTitle String Y Main Title
content.cards[].mTitleMedia String N Main Title Icon
content.cards[].title String N Title
content.cards[].description String Y Content
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat Room), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)
content.cards[].buttons[].buttonJson Object Y Button JSON, check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration

LMS Format Paragraph Type

  • List of mTitleMedia Icon File IDs
  • Promotion: LT-messagebase.common-jFBCKu
  • Coupon: LT-messagebase.common-LbshOv
  • Event: LT-messagebase.common-aWdsJX
  • Reservation: LT-messagebase.common-5eFcIF
  • Receipt: LT-messagebase.common-rJQ22U
  • Notification: LT-messagebase.common-j11Gtf
{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "LMS",
    "unsubscribePhoneNumber": "08012341234",
    "lmsType": "FORMAT_PARAGRAPH",
    "cards": [
        {
          "mTitle":"[NHN Cloud] Notice",
          "mTitleMedia":"LT-messagebase.common-DdWk6s",
          "title1":"Notice 1",
          "description1":"Hi, this is NHN Cloud Notification Hub.",
          "title2":"Notice 2",
          "description2":"Hi, this is NHN Cloud Notification Hub.",
          "title3":"Notice 3",
          "description3":"Hi, this is NHN Cloud Notification Hub.",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Notice1 Button"
                }
              }
            },
            {},
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Notice2 Button"
                }
              }
            },
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Notice2 Button"
                }
              }
            },
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Notice3 Button"
                }
              }
            },
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.lmsType String Y LMS type, required if the message type is LMS, STANDALONE (Standard), FORMAT_BASIC (Basic format), FORMAT_TITLE_HIGHLIGHT (Highlighted title format), FORMAT_PARAGRAPH (Paragraph format), UNIFIED_STANDALONE (Integrated LMS card)
content.cards Object Array Y Card
content.cards[].mTitle String Y Main Title
content.cards[].mTitleMedia String N Main Title Icon
content.cards[].title1 String N Title (Paragraph 1)
content.cards[].description1 String Y Content (Paragraph 1)
content.cards[].title2 String N Title (Paragraph 2)
content.cards[].description2 String Y Content (Paragraph 2)
content.cards[].title3 String N Title (Paragraph 3)
content.cards[].description3 String Y Content (Paragraph 3)
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat Room), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)
content.cards[].buttons[].buttonJson Object Y Button JSON, check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS Message Reception Wait Expiration Period Setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter Statistics Integration

MMS Horizontal, Vertical

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "MMS",
    "unsubscribePhoneNumber": "08012341234",
    "mmsType": "HORIZONTAL",
    "cards": [
        {
          "title":"[NHN Cloud] Notice",
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "attachmentId":"Attachment ID",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.mmsType String Y MMS type, required if the message type is MMS, HORIZONTAL, VERTICAL, CAROUSEL_MEDIUM, CAROUSEL_SMALL, UNIFIED_HORIZONTAL (Integrated MMS card horizontal), UNIFIED_VERTICAL (Integrated MMS card vertical)
content.cards Object Array Y Cards
content.cards[].title String N Title
content.cards[].description String Y Content
content.cards[].attachmentId String Y Attachment ID
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)
content.cards[].buttons[].buttonJson Object Y Button JSON, Check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration 
{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "MMS",
    "unsubscribePhoneNumber": "08012341234",
    "mmsType": "CAROUSEL_MEDIUM",
    "cards": [
        {
          "title":"[NHN Cloud] Notice",
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "attachmentId":"Attachment ID",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        },
        {
          "title":"[NHN Cloud] Notice",
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "attachmentId":"Attachment ID",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        },
        {
          "title":"[NHN Cloud] Notice",
          "description":"Hi, this is NHN Cloud Notification Hub.",
          "attachmentId":"Attachment ID",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.mmsType String Y MMS type, required if the message type is MMS, HORIZONTAL, VERTICAL, CAROUSEL_MEDIUM, CAROUSEL_SMALL, UNIFIED_HORIZONTAL (Integrated MMS card horizontal), UNIFIED_VERTICAL (Integrated MMS card vertical)
content.cards Object Array Y Cards
content.cards[].title String N Title
content.cards[].description String Y Content
content.cards[].attachmentId String Y Attachment ID
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)
content.cards[].buttons[].buttonJson Object Y Button Json, Check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration Guide (up to 20 bytes)

Integrated SMS Card

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "SMS",
    "unsubscribePhoneNumber": "08012341234",
    "smsType": "UNIFIED_STANDALONE",
    "cards": [
        {
          "description":"(Advertisement) Hi, this is NHN Cloud Notification Hub. Opt-out: 08012341234",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.smsType String Y SMS type, required if the message type is SMS, STANDALONE (Standard), UNIFIED_STANDALONE (Integrated SMS Card)
content.cards Object Array Y Card
content.cards[].description String Y Content
As the Integrated SMS Card has no subject line, the "(Advertisement)" label must be included at the beginning of the body, and opt-out instructions and an 080 number must be included at the end of the body when sending for advertising purposes.
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)

※ If a CLIPBOARD (Copy) button is used in integrated message types, the message cannot be received on iOS devices.
content.cards[].buttons[].buttonJson Object Y Button JSON, check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration Guide (up to 20 bytes)

Integrated LMS Card

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "LMS",
    "unsubscribePhoneNumber": "08012341234",
    "lmsType": "UNIFIED_STANDALONE",
    "cards": [
        {
          "title":"(Advertisement) NHN Cloud Notice",
          "description":"Hi, this is NHN Cloud Notification Hub. Opt-out: 08012341234",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.lmsType String Y LMS type, required if the message type is LMS, STANDALONE (Standard), FORMAT_BASIC (Basic format), FORMAT_TITLE_HIGHLIGHT (Highlighted title format), FORMAT_PARAGRAPH (Paragraph format), UNIFIED_STANDALONE (Integrated LMS Card)
content.cards Object Array Y Card
content.cards[].title String N Title
When sending for advertising purposes, the "(Advertisement)" label must be included at the beginning of the subject line.
content.cards[].description String Y Content
When sending for advertising purposes, opt-out instructions and an 080 number must be included at the end of the body.
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)

※ If a CLIPBOARD (Copy) button is used in integrated message types, the message cannot be received on iOS devices.
content.cards[].buttons[].buttonJson Object Y Button JSON, check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration Guide (up to 20 bytes)

Integrated MMS Card Horizontal, Vertical

{
  "statsKeyId": "Statistics_Key_ID",
  "scheduledDateTime": "2024-10-24T06:29:00+09:00",
  "confirmBeforeSend": false,
  "sender": {
    "brandId": "Brand_ID",
    "chatbotId": "Chatbot_ID"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "PHONE_NUMBER",
          "contact": "01012345678",
          "clientReference": "Client_Reference"
        }
      ]
    }
  ],
  "content": {
    "messageType": "MMS",
    "unsubscribePhoneNumber": "08012341234",
    "mmsType": "UNIFIED_HORIZONTAL",
    "cards": [
        {
          "title":"(Advertisement) NHN Cloud Notice",
          "description":"Hi, this is NHN Cloud Notification Hub. Opt-out: 08012341234",
          "attachmentId":"Attachment_ID",
          "buttons" : [
            {
              "buttonType" : "URL",
              "buttonJson" : {
                "action": {
                  "urlAction": { "openUrl": { "url": "http://www.test.com" } },
                  "displayText": "Go to Homepage"
                }
              }
            }
          ]
        }
    ]
  },
  "options": {
    "expiryOption": 1,
    "groupId":"groupId"
  }
}
Name Type Required Description
sender Object Y Sender
sender.brandId String Y Brand ID
sender.chatbotId String Y Chat room ID
content Object Y Message content
content.messageType String Y Message type in RCS, SMS, LMS, MMS, RBC_TEMPLATE
content.unsubscribePhoneNumber String N 080 opt-out number, required if the sending purpose is advertising
content.mmsType String Y MMS type, required if the message type is MMS, HORIZONTAL, VERTICAL, CAROUSEL_MEDIUM, CAROUSEL_SMALL, UNIFIED_HORIZONTAL (Integrated MMS Card Horizontal), UNIFIED_VERTICAL (Integrated MMS Card Vertical)
content.cards Object Array Y Card
content.cards[].title String N Title
When sending for advertising purposes, the "(Advertisement)" label must be included at the beginning of the subject line.
content.cards[].description String Y Content
When sending for advertising purposes, opt-out instructions and an 080 number must be included at the end of the body.
content.cards[].attachmentId String Y Attachment ID
※ If a GIF image is attached, the message cannot be received on iOS devices.
content.cards[].buttons Object Array N Button
content.cards[].buttons[].buttonType String Y Button Type
COMPOSE (Open Chat), CLIPBOARD (Copy), DIALER (Make a Call), MAP_SHOW (Show Map), MAP_QUERY (Search Map), MAP_SHARE (Share Current Location), URL (Connect URL), CALENDAR (Register Schedule)

※ If a CLIPBOARD (Copy) button is used in integrated message types, the message cannot be received on iOS devices.
content.cards[].buttons[].buttonJson Object Y Button JSON, check the format for the button type
options Object N Sending Options
options.expiryOption Integer N RCS message reception wait expiration period setting (1: 1 day, 2: 40 seconds, 3: 3 minutes, 4: 1 hour)
options.groupId String N Group ID for RCS BizCenter statistics integration Guide (up to 20 bytes)

Email

{
  "sender": {
    "senderMailAddress": "sender@example.com"
  },
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "EMAIL_ADDRESS",
          "contact": "recipient@example.com"
        }
      ]
    }
  ],
  "content": {
    "title": "[NHN Cloud Notification Hub] Notice",
    "body": "Hi, this is NHN Cloud Notification Hub.",
    "attachmentIds": [
      "Attachment_ID"
    ]
  }
}
Name Type Required Description
sender Object N Sender, required for message channels other than push
sender.senderMailAddress String N Sender email address
content Object Y Message content
content.title String Y Title
content.body String Content
content.attachmentIds String Array N Attachment ID
  • The domain of the sender's email address must be verified.
  • Up to 10 attachments can be uploaded, each with a maximum size of 30MB.
  • The total size of attachments cannot exceed 30MB. * You can attach up to 30MB, but depending on the attachment limit policy of the receiving email system (e.g., gmail.com, naver.com), it may be rejected as 'exceeding the limit' or may increase the spam rating, so we recommend keeping attachments under 10MB.
  • Only EMAIL_ADDRESS can be used in the recipients[].contacts[].contactType field.
  • Enter the recipient's email address in the recipients[].contacts[].contact field.

Push

{
  "statsId": "Statistics_ID",
  "scheduledDateTime": "2024-10-29T06:29:00+09:00",
  "confirmBeforeSend": false,
  "recipients": [
    {
      "contacts": [
        {
          "contactType": "TOKEN_FCM",
          "contact": "Token"
        }
      ]
    }
  ],
  "content": {
    "unsubscribePhoneNumber": "1234-1234",
    "unsubscribeGuide": "Settings > Menu",
    "style": {
      "useHtmlStyle": true
    },
    "title" : "<b>NHN Cloud </b> Notification",
    "body" : "<b>Launch Event</b> <i>Check Notices</i>",
    "richMessage" : {
      "buttons" : [{
        "name" : "Button Name",
        "submitName": "Name of Send Button",
        "buttonType" : "REPLY",
        "link" : "myapp://product_detail?product_id=1234",
        "hint" : "Hint for Button"
      }
      ],
      "media" : {
        "source" : "URL",
        "mediaType" : "IMAGE",
        "expandable" : true
      },
      "androidMedia": {
        "source" : "URL",
        "mediaType" : "IMAGE",
        "expandable" : true
      },
      "iosMedia": {
        "source" : "URL",
        "mediaType" : "IMAGE",
        "expandable" : true
      },
      "largeIcon" : {
        "source" : "URL"
      },
      "group" : {
        "key" : "Group Key",
        "description" : "Description for Group"
      }
    },
    "customKey" : "customValue"
  }
}
Name Type Required Description
content Object Y Message content
content.unsubscribePhoneNumber String N Representative number for unsubscribing from push messages
content.unsubscribeGuide String N Guide for unsubscribing from push messages
content.title String Y Title
content.body String Y Content
content.style.useHtmlStyle Boolean Y Use HTML style (Android only)
content.richMessage Object N Required when using rich messages
content.richMessage.buttons Object Array N Buttons added to rich messages, up to 3 allowed
content.richMessage.buttons.name String N Button name
content.richMessage.buttons.buttonType String N Button types: REPLY, DEEP_LINK, OPEN_APP, OPEN_URL, DISMISS
content.richMessage.buttons.link String N Link to link to when the button is clicked
content.richMessage.buttons.hint String N Hint for the button
content.richMessage.media Object N Media added to the rich message
content.richMessage.media.source String N Address of the media (can be URL or LOCAL_RESOURCE)
content.richMessage.media.mediaType String N Media types: IMAGE, GIF, VIDEO, AUDIO. Android only supports IMAGE
content.richMessage.media.expandable Boolean N Whether to use the expand function when clicking the media on Android
content.richMessage.androidMedia Object N Media for Android devices only. Same as the media type
content.richMessage.iosMedia Object N Media for iOS devices only. Same as the media format
content.richMessage.largeIcon Object N Large icon added to a rich message, supported only by Android
content.richMessage.largeIcon.source String Y Icon address
content.richMessage.group Object N Ability to group multiple messages, supported only by Android
content.richMessage.group.key String Y Group key
content.richMessage.group.description String Y Group description
content.customKey Object Array or String Array N Custom key and value
  • Push does not require a sender field.
  • Push can create a content field by adding user-defined keys and values. * The recipients[].contacts[].contactType field must be one of TOKEN_FCM, TOKEN_APNS, TOKEN_ADM, TOKEN_APNS_SANDBOX, TOKEN_APNS_VOIP, or TOKEN_APNS_VOIP_SANDBOX.
  • Enter push token in the recipients[].contacts[].contact field.
Table of Contents
TOP