Interactive Messages

You can send text messages only if the service conversation is open. Check the conversation guides.

Check our guides for learn how to use interactive message

Interactive Messages

Sending Interactive Messages

Interactive messages include List Messages and Reply Buttons.

Endpoint

POST: https://api.pingup.ai/ext/v2/{businessname}}messages

List Messages sample request:

{
  "message_type": "interactive",
  "client": "client_id or client_phone are required ",
  "client_phone": "39321123213",
  "client_name": "Jon Doe",
  "interactive": {
    "type": "list",
    "header": {
      "type": "text",
      "text": "HEADER_TEXT"
    },
    "body": {
      "text": "BODY_TEXT"
    },
    "footer": {
      "text": "FOOTER_TEXT"
    },
    "action": {
      "button": "BUTTON_TEXT",
      "sections": [
        {
          "title": "SECTION_1_TITLE",
          "rows": [
            {
              "id": "SECTION_1_ROW_1_ID",
              "title": "SECTION_1_ROW_1_TITLE",
              "description": "SECTION_1_ROW_1_DESCRIPTION"
            },
            {
              "id": "SECTION_1_ROW_2_ID",
              "title": "SECTION_1_ROW_2_TITLE",
              "description": "SECTION_1_ROW_2_DESCRIPTION"
            }
          ]
        },
        {
          "title": "SECTION_2_TITLE",
          "rows": [
            {
              "id": "SECTION_2_ROW_1_ID",
              "title": "SECTION_2_ROW_1_TITLE",
              "description": "SECTION_2_ROW_1_DESCRIPTION"
            },
            {
              "id": "SECTION_2_ROW_2_ID",
              "title": "SECTION_2_ROW_2_TITLE",
              "description": "SECTION_2_ROW_2_DESCRIPTION"
            }
          ]
        }
      ]
    }
  }
}

Reply Button sample request:

{
  "message_type": "interactive",
  "client": "client_id or client_phone are required ",
  "client_phone": "39321123213",
  "client_name": "Jon Doe",
  "interactive": {
    "type": "button",
    "body": {
      "text": "BUTTON_TEXT"
    },
    "action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "UNIQUE_BUTTON_ID_1",
            "title": "BUTTON_TITLE_1"
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "UNIQUE_BUTTON_ID_2",
            "title": "BUTTON_TITLE_2"
          }
        }
      ]
    }
  }

A successful response includes an object with an success true.

{
  "success": true,
  "data": {
      "message_id": "message_id"
  }
}

Header types

"header": {
      "type": "text" | "image" | "video" | "document",
      "text": "your text" // if type=text
      # OR (if type document)
      "document": {
        "link": "the-provider-name/protocol://the-url",
        "filename": "some-file-name",
        "caption" : "Description of media"
      },
      # OR (if type video)
      "video": {
        "link": "the-provider-name/protocol://the-url",
      }
      # OR (if type image)
      "image": {
        "link": "http(s)://the-url",
        "caption" : "Description of media"
      }
    }

Action Types

Interactive messages with lists buttons

"action": {
      "button": "cta-button-content-here",
      "sections":[
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        {
          "title":"your-section-title-content-here",
          "rows": [
            {
              "id":"unique-row-identifier-here",
              "title": "row-title-content-here",
              "description": "row-description-content-here",           
            }
          ]
        },
        ...
      ]
    }

Interactive messages with quick reply

"action": {
      "buttons": [
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "First Button’s Title" 
          }
        },
        {
          "type": "reply",
          "reply": {
            "id": "unique-postback-id",
            "title": "Second Button’s Title" 
          }
        }
      ] 
    }

Interactive messages with flows

"action": {
      "name": "flow",
      "parameters": {
        "flow_message_version": "3",
        "flow_token": "AQAAAAACS5FpgQ_cAAAAAD0QI3s",
        "flow_id": "<FLOW_ID>",
        "flow_cta": "Book!",
        "flow_action": "navigate",
        "flow_action_payload": {
          "screen": "<SCREEN_ID>",
          "data": { # optional
            "user_name": "name",
            "user_age": 25
          }
        }
      }
    }