{"componentChunkName":"component---src-templates-docs-js","path":"/whatsapp/messaging/interactive/lists","result":{"data":{"site":{"siteMetadata":{"title":"broadcaster","docsLocation":"https://github.com","docsLocationType":"github","editable":false}},"mdx":{"fields":{"id":"f81af71d-a0f5-5dee-a0de-a4679dab2121","title":"List messages","slug":"/whatsapp/messaging/interactive/lists"},"body":"function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }\n\nfunction _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }\n\nfunction _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }\n\n/* @jsx mdx */\nvar _frontmatter = {\n  \"title\": \"List messages\",\n  \"order\": 1\n};\nvar layoutProps = {\n  _frontmatter: _frontmatter\n};\nvar MDXLayout = \"wrapper\";\nreturn function MDXContent(_ref) {\n  var components = _ref.components,\n      props = _objectWithoutProperties(_ref, [\"components\"]);\n\n  return mdx(MDXLayout, _extends({}, layoutProps, props, {\n    components: components,\n    mdxType: \"MDXLayout\"\n  }), mdx(\"blockquote\", null, mdx(\"p\", {\n    parentName: \"blockquote\"\n  }, mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"Integration summary\")), mdx(\"ul\", {\n    parentName: \"blockquote\"\n  }, mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Endpoint:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging\")), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Token:\"), \" messaging token, in the \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"Authorization: Bearer {{wa-msg-api-token}}\"), \" header (\", mdx(\"a\", {\n    href: \"/whatsapp/authentication_token\"\n  }, \"how to generate it\"), \")\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Common fields:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"from\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"to\"), \" (phone number or BSUID) and \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"type\"), \" (\", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http#h-commonfields\"\n  }, \"details\"), \")\"), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, mdx(\"inlineCode\", {\n    parentName: \"strong\"\n  }, \"type\"), \" values on this page:\"), \" \", mdx(\"inlineCode\", {\n    parentName: \"li\"\n  }, \"\\\"interactive\\\"\")), mdx(\"li\", {\n    parentName: \"ul\"\n  }, mdx(\"strong\", {\n    parentName: \"li\"\n  }, \"Response:\"), \" the same for every message (\", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http#h-response\"\n  }, \"see response\"), \")\"))), mdx(\"p\", null, \"Messages that include a menu of up to 10 options. This message type gives users a simpler, more consistent way to make a selection when interacting with a business. They are sent with \", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http\"\n  }, \"POST /v1/messaging\"), \"; headers, common fields and the response are in \", mdx(\"a\", {\n    href: \"/whatsapp/messaging/http\"\n  }, \"HTTP connection\"), \".\"), mdx(\"section\", {\n    \"id\": \"listmessages\"\n  }, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"List messages\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"The \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"type\"), \" field must be \\\"interactive\\\" and the message content is sent in the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"listMessages\"), \" object. See the \", mdx(\"a\", {\n    href: \"/whatsapp/messaging/interactive#h-generalstructure\"\n  }, \"general structure\"), \" of interactive messages.\")), mdx(\"section\", {\n    \"id\": \"listmessages--body\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Body\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Fields for \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"List messages\"), \":\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/messaging/interactive/lists#h-listmessagesobject\"\n  }, \"listMessages\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object with the list message. Send only one: listMessages, replyButtons or flow (or another interactive message type).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Object\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Conditional\"))))), mdx(\"section\", {\n    \"id\": \"listmessages--body--listmessagesobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"ListMessages object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"headerText\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Header text (max 60 characters).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Optional\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"body\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The message text, which can include formatting and URLs (max 1024 characters).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"footer\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"The message footer (max 60 characters). Supports emojis and Markdown.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Optional\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"buttonText\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Button content (max 20 characters). Can't be an empty string and must be unique within the message. Doesn't support emojis or Markdown.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"a\", {\n    href: \"/whatsapp/messaging/interactive/lists#h-sectionsobject\"\n  }, \"sections\")), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of message sections.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of objects\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"listmessages--body--sectionsobject\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Sections object\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"title\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Section title (max 24 characters).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required if the message has more than one section.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"messages\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of rows (up to 10 per section).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"List of objects\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))))), mdx(\"section\", {\n    \"id\": \"listmessages--body--messagesobject(rows)\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"Messages object (rows)\"), mdx(\"table\", {\n    parentName: \"section\"\n  }, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Requirements\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"id\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Unique identifier of the row.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"title\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Row title.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"description\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Optional description (max 72 characters).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"String\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Optional\"))))), mdx(\"section\", {\n    \"id\": \"listmessages--example\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Example\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Complete \", mdx(\"strong\", {\n    parentName: \"p\"\n  }, \"List messages\"), \" example (HTTP request and JSON body):\")), mdx(\"section\", {\n    \"id\": \"listmessages--example--listmessageshttprequest\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"List messages HTTP request\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-bash\"\n  }, \"curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \\\\\\n-H 'Authorization: Bearer {{wa-msg-api-token}}' \\\\\\n-H 'Content-Type: application/json' \\\\\\n-d '{\\n    \\\"from\\\": \\\"5215500000001\\\",\\n    \\\"to\\\": \\\"5215500000002\\\",\\n    \\\"type\\\": \\\"interactive\\\",\\n    \\\"listMessages\\\": {\\n        \\\"headerText\\\": \\\"Header test\\\", \\n        \\\"body\\\": \\\"Body test\\\", \\n        \\\"footer\\\": \\\"Footer test\\\", \\n        \\\"buttonText\\\": \\\"English\\\", \\n        \\\"sections\\\": [\\n            {\\n                \\\"title\\\": \\\"Online courses\\\", \\n                \\\"messages\\\": [\\n                    {\\n                        \\\"id\\\": \\\"1\\\",\\n                        \\\"title\\\": \\\"Intensive\\\",\\n                        \\\"description\\\": \\\"One-hour live classes, Monday through Friday\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"2\\\",\\n                        \\\"title\\\": \\\"Saturday\\\",\\n                        \\\"description\\\": \\\"3-hour live class on Saturdays\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"3\\\",\\n                        \\\"title\\\": \\\"Alpha 12\\\",\\n                        \\\"description\\\": \\\"Live classes, 12 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"4\\\",\\n                        \\\"title\\\": \\\"Alpha 20\\\",\\n                        \\\"description\\\": \\\"Live classes, 20 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"5\\\",\\n                        \\\"title\\\": \\\"Alpha 40\\\",\\n                        \\\"description\\\": \\\"Live classes, 40 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"6\\\",\\n                        \\\"title\\\": \\\"Intensive\\\",\\n                        \\\"description\\\": \\\"One-hour live classes, Monday through Friday\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"7\\\",\\n                        \\\"title\\\": \\\"Saturday\\\",\\n                        \\\"description\\\": \\\"3-hour live class on Saturdays\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"8\\\",\\n                        \\\"title\\\": \\\"Alpha 12\\\",\\n                        \\\"description\\\": \\\"Live classes, 12 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"9\\\",\\n                        \\\"title\\\": \\\"Alpha 20\\\",\\n                        \\\"description\\\": \\\"Live classes, 20 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"10\\\",\\n                        \\\"title\\\": \\\"Alpha 40\\\",\\n                        \\\"description\\\": \\\"Live classes, 40 hours over 4 weeks\\\"\\n                    }\\n                ]\\n            } \\n        ]\\n    }\\n}'\\n\"))), mdx(\"section\", {\n    \"id\": \"listmessages--example--listmessagesbody\"\n  }, mdx(\"h4\", {\n    parentName: \"section\"\n  }, \"List messages body\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"from\\\": \\\"5215500000001\\\",\\n    \\\"to\\\": \\\"5215500000002\\\",\\n    \\\"type\\\": \\\"interactive\\\",\\n    \\\"listMessages\\\": {\\n        \\\"headerText\\\": \\\"Header test\\\", \\n        \\\"body\\\": \\\"Body test\\\", \\n        \\\"footer\\\": \\\"Footer test\\\", \\n        \\\"buttonText\\\": \\\"English\\\", \\n        \\\"sections\\\": [\\n            {\\n                \\\"title\\\": \\\"Online courses\\\", \\n                \\\"messages\\\": [\\n                    {\\n                        \\\"id\\\": \\\"1\\\",\\n                        \\\"title\\\": \\\"Intensive\\\",\\n                        \\\"description\\\": \\\"One-hour live classes, Monday through Friday\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"2\\\",\\n                        \\\"title\\\": \\\"Saturday\\\",\\n                        \\\"description\\\": \\\"3-hour live class on Saturdays\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"3\\\",\\n                        \\\"title\\\": \\\"Alpha 12\\\",\\n                        \\\"description\\\": \\\"Live classes, 12 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"4\\\",\\n                        \\\"title\\\": \\\"Alpha 20\\\",\\n                        \\\"description\\\": \\\"Live classes, 20 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"5\\\",\\n                        \\\"title\\\": \\\"Alpha 40\\\",\\n                        \\\"description\\\": \\\"Live classes, 40 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"6\\\",\\n                        \\\"title\\\": \\\"Intensive\\\",\\n                        \\\"description\\\": \\\"One-hour live classes, Monday through Friday\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"7\\\",\\n                        \\\"title\\\": \\\"Saturday\\\",\\n                        \\\"description\\\": \\\"3-hour live class on Saturdays\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"8\\\",\\n                        \\\"title\\\": \\\"Alpha 12\\\",\\n                        \\\"description\\\": \\\"Live classes, 12 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"9\\\",\\n                        \\\"title\\\": \\\"Alpha 20\\\",\\n                        \\\"description\\\": \\\"Live classes, 20 hours over 4 weeks\\\"\\n                    },\\n                    {\\n                        \\\"id\\\": \\\"10\\\",\\n                        \\\"title\\\": \\\"Alpha 40\\\",\\n                        \\\"description\\\": \\\"Live classes, 40 hours over 4 weeks\\\"\\n                    }\\n                ]\\n            } \\n        ]\\n    }\\n}\\n\")), mdx(\"br\", null), mdx(\"hr\", {\n    parentName: \"section\"\n  })));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"url":"#list-messages","title":"List messages","items":[{"url":"#body","title":"Body","items":[{"url":"#listmessages-object","title":"ListMessages object"},{"url":"#sections-object","title":"Sections object"},{"url":"#messages-object-rows","title":"Messages object (rows)"}]},{"url":"#example","title":"Example","items":[{"url":"#list-messages-http-request","title":"List messages HTTP request"},{"url":"#list-messages-body","title":"List messages body"}]}]}]},"timeToRead":1,"parent":{"__typename":"File","relativePath":"whatsapp/messaging/interactive/lists.md","fields":{"gitLogLatestAuthorName":"Irais Aguirre","gitLogLatestAuthorEmail":"irais.aguirre@conceptomovil.com","gitLogLatestDate":"6 hours ago"}},"frontmatter":{"metaTitle":null,"showMetadata":null,"editable":null,"showPreviousNext":null,"showToc":null}},"gitBranch":{"name":"20211019-2FACTOR_AUTH"},"gitCommit":{"hash":"9713e1925aeb8cad930f91b6bf05d0b5937b2bb5","date":"2026-11-13 06:39"}},"pageContext":{"id":"f81af71d-a0f5-5dee-a0de-a4679dab2121"}},"staticQueryHashes":["12478684","12478684","2882937274","2882937274","353167761","353167761"]}