Stella Platform Documentation

Stella Platform Documentation

  • Docs
  • Procedures
  • Reference
  • FAQ
  • Bot API
  • API
  • Languages iconEnglish
    • 中文

›Instagram

Overview

  • Documentation Guide

Get Started

  • Introduction
  • Recent Updates
  • Best Practices
  • Chatbot Template

Bot Builder

  • Workspace
  • Node
  • Attachment ID

Node Inspector

  • Tree ID & Composite ID
  • Basic Information
  • Triggers
  • Responses
  • Actions
  • Redirect
  • Member Tagging
  • Analytics
  • NLP
  • Advance

Facebook

  • Message Types
  • Button Types
  • Persistent Menu
  • Access Token
  • One-Time Notification
  • N-Time Notification (Beta)

Instagram

  • Message Types

WhatsApp

  • Overview
  • Setup Procedure
  • Message Types

Web Chat

  • Overview
  • Message Types
  • Button Types

WeChat

  • Message Types

Slack

  • Message Types

Telegram

  • Message Types

Integrations

  • Dialogflow
  • Stripe
  • LUIS
  • Custom Inbox Integration

Data Source

  • Data Source

Media Library

  • Media Library

Channels

  • Overview
  • Webhooks
  • Channel-wide Metadata
  • Business Availability
  • Facebook
  • Instagram
  • Web Chat
  • WhatsApp
  • WeChat
  • Slack (Public App)
  • Slack (Custom App)
  • Teamwork
  • Zendesk
  • Custom Platform

Analytics

  • Members
  • Dashboard
  • PSID

Settings

  • Overview
  • Locale
  • Pairing Channels
  • Role-based Access Control
  • Access Token
  • Audit Trail

Push Panel

  • Push Content
  • Audience
  • Analytics

Log

  • Log

Instagram Message Types

There are various types of message content that can be sent to your users:

  • Text
  • Image
  • Sticker
  • Quick Reply
  • Button
  • Carousel
  • React
  • Unreact
  • Media Share
  • Ice Breakers

Text

{
  "type": "TEXT",
  "text": "Hello World!"
}
PropertyDescriptionRequired
typeTEXTY
textString; Limited to 2,000 charactersY

Image

{
  "type": "IMAGE",
  "url": "http://image.png",
  "attachment_id": "SomeStringID"
}
PropertyDescriptionRequired
typeIMAGEY
urlURL of the image fileY
attachment_idString; ID of your uploaded imageN

Tips:

  • Image must be a valid image file format, including .jpg, .png, .ico and .bmp
  • Maximum file size is 8MB

Sticker

{
  "type": "STICKER",
  "sticker": "like_heart"
}
PropertyDescriptionRequired
typeSTICKERY
stickerlike_heartY

Quick Reply

Quick Reply is currently not available on desktop, it is only supported in Instagram mobile app.

{
  "type": "TEXT",
  "quickReplies": [
    {
      "id": "6fTdrR8Y",
      "content_type": "text",
      "title": "test",
      "payload": "payload1"
    }
  ],
  "text": "quick replies test"
}

Response Object

PropertyDescriptionRequired
typeTEXTY
textString; Limited to 2,000 charactersY
quickRepliesArray of quick reply buttons; Maximum of 13 buttonsY

quickReplies Object

PropertyDescriptionRequired
idAuto-generated by StellaY
content_typeSet "text"Y
titleString; caption of button; Limited to 20 charactersOnly if content_type is text
payloadCustom defined payload trigger; Limited to 1,000 charactersOnly if content_type is text

Button

Button is currently not available on desktop, it is only supported in Instagram mobile app.

{
  "type": "BUTTON",
  "buttons": [
    {
      "type": "postback",
      "payload": "TALK",
      "id": "CzLgZeSP",
      "title": "Talk to us"
    },
    {
      "type": "web_url",
      "url": "https://sanuker.com",
      "title": "Our Website",
      "id": "bsFbqfRG"
    }
  ],
  "text": "Welcome to our store!"
}

Response Object

PropertyDescriptionRequired
typeBUTTONY
textString; Limited to 2,000 charactersY
buttonsArray of buttons; Maximum of 3 buttons that appear as call-to-actionY

For different types of button objects, please see Button Types.

Carousel

Quick Reply is currently not available on desktop, it is only supported in Instagram mobile app.

{
  "type": "CAROUSEL",
  "carousel": [
    {
      "buttons": [
        {
          "type": "web_url",
          "url": "https://sanuker.com/",
          "title": "Shop Now",
          "id": "SUf68rVl"
        },
        {
          "type": "postback",
          "payload": "SHARE",
          "title": "Share to Friends",
          "id": "QFCJCJHt"
        }
      ],
      "image_url": "http://image.png",
      "subtitle": "$119",
      "title": "Wireless Mouse",
      "id": "xc3Qogj3"
    },
    {
      "buttons": [
        {
          "type": "web_url",
          "url": "https://sanuker.com/",
          "title": "Shop Now",
          "id": "CdycIaKj"
        },
        {
          "type": "postback",
          "payload": "SHARE",
          "id": "Fr2GKFpW",
          "title": "Share to Friends"
        }
      ],
      "image_url": "http://image.png",
      "subtitle": "$299",
      "title": "Wireless Keyboard",
      "id": "i2HQB9Ki"
    }
  ]
}

Response Object

PropertyDescriptionRequired
typeCAROUSELY
carouselArray of carousel items; Maximum of 10 elementsY

carousel Object

PropertyDescriptionRequired
titleString; Limited to 80 charactersY
subtitleString; Limited to 80 charactersN
image_urlURL of the image displayedN
buttonsArray of buttons; Maximum of 3 buttons that appear as call-to-actionN

React

return new Promise((resolve) => {
  resolve({
    "type": "REACT",
    "message_id": this.messageEvent.messageId,
    "reaction": "love"
  })
})
PropertyDescriptionRequired
typeREACTY
message_idString; ID of the messageY
reactioinloveY

Unreact

{
  "type": "UNREACT",
  "message_id": "aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDQ5MDM4NzIzNTgzOjM0MDI4MjM2Njg0MTcxMDMwMDk0OTEyODE4NjAzMzE4NDEyNjI3MzozMDAxMzAxODAxNTM4MTQ3NjkxMTEwMzkyOTg5NjQwMjk0NAZDZD"
}
PropertyDescriptionRequired
typeUNREACTY
message_idString; ID of the messageY

Media Share

{
  "type": "MEDIA_SHARE",
  "attachment_id": "17906680357995984"
}
PropertyDescriptionRequired
typeMEDIA_SHAREY
attachment_idString; ID of postY

Ice Breakers

Ice Breaker is currently not available on desktop, it is only supported in Instagram mobile app.

{
  "ice_breakers": [
    {
      "question": "Talk to me",
      "payload": "TALK"
    },
    {
      "question": "Ask a question",
      "payload": "ASK"
    }
  ]
}
PropertyDescriptionRequired
questionTEXTY
payloadStringY
← N-Time Notification (Beta)Overview →
  • Text
  • Image
  • Sticker
  • Quick Reply
  • Button
  • Carousel
  • React
  • Unreact
  • Media Share
  • Ice Breakers
Stella Platform Documentation
Docs
Get StartedBot API ReferenceAPI ReferenceStandard Procedures
Community
FAQUser ShowcaseChat with Us
Copyright © 2023 Sanuker Inc. Limited