{"componentChunkName":"component---src-templates-docs-js","path":"/api-externa/sms/api-http/http","result":{"data":{"site":{"siteMetadata":{"title":"broadcaster","docsLocation":"https://github.com","docsLocationType":"github","editable":false}},"mdx":{"fields":{"id":"3a96a15c-8c8b-59f4-9609-1110ce0fcd6f","title":"Step 2 - Send an SMS","slug":"/api-externa/sms/api-http/http"},"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\": \"Step 2 - Send an SMS\",\n  \"order\": 2\n};\n\nvar makeShortcode = function makeShortcode(name) {\n  return function MDXDefaultShortcode(props) {\n    console.warn(\"Component \" + name + \" was not imported, exported, or provided by MDXProvider as global scope\");\n    return mdx(\"div\", props);\n  };\n};\n\nvar Warning = makeShortcode(\"Warning\");\nvar Info = makeShortcode(\"Info\");\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(\"p\", null, \"With the token obtained in the previous step, make a \", mdx(\"b\", null, \"POST\"), \" to the messaging endpoint, including the Bearer token in the \", mdx(\"code\", null, \"Authorization\"), \" header.\"), mdx(\"br\", null), mdx(\"table\", null, mdx(\"thead\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"thead\"\n  }, mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"URL\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"https://gateway.broadcastermobile.com/services/messaging\"))), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"METHOD\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"POST\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"HEADERS\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Content-Type: application/json \", mdx(\"br\", null), \" Authorization: Bearer \", \"[\", mdx(\"strong\", {\n    parentName: \"td\"\n  }, \"access_token\"), \"]\")))), mdx(\"br\", null), mdx(\"section\", {\n    \"id\": \"body\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Body\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"msisdn\\\": [numeric][required],\\n    \\\"dial\\\": [string][required],\\n    \\\"message\\\": [String][required],\\n    \\\"country\\\": [string][recommended],\\n    \\\"carrier\\\": [String][optional],\\n    \\\"mask\\\": [String][optional],\\n    \\\"dataCoding\\\": [String][optional],\\n    \\\"dlr\\\": [Boolean][optional],\\n    \\\"schedule\\\": [String][optional][format: ISO-8601],\\n    \\\"tag\\\": [String][optional],\\n    \\\"msgClass\\\": [numeric][optional],\\n    \\\"optionals\\\": [String][optional]\\n}\\n\")), mdx(\"br\", null), 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  }, \"Parameters\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Required\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"msisdn\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Destination phone number in international format, without the \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"+\"), \" sign. E.g.: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"5215512345678\"), \".\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Yes\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"dial\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Shortcode or source number. Digits only. E.g.: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"\\\"5217000\\\"\"), \".\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Yes\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"message\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Text of the SMS to send.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Yes\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"country\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"ISO 3166-1 alpha-2 country code. E.g.: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"\\\"MX\\\"\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"\\\"CO\\\"\"), \", \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"\\\"PE\\\"\"), \". Send it whenever you can: it speeds up carrier resolution and reduces \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"-40\"), \" errors.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Recommended\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"carrier\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Name of the destination carrier. If omitted, the system detects it automatically.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"mask\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Alphanumeric sender mask. Requires the capability to be enabled on your account.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"dataCoding\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Message encoding. Omit this field for automatic Unicode detection.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"dlr\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"true\"), \" to request a delivery report. Default: \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"false\"), \". See \", mdx(\"a\", {\n    parentName: \"td\",\n    \"href\": \"#h-deliveryreport(dlr)\"\n  }, \"Delivery report (DLR)\"), \".\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"schedule\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Scheduled send date/time in ISO 8601 format. Must be a future date.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"tag\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Free-form label to identify the send in your reports.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"msgClass\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Message class. Advanced use case.\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"optionals\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"JSON as a string for advanced options (DLR type, RCS fallback, etc.).\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"No\")))), mdx(\"br\", null), mdx(Warning, {\n    mdxType: \"Warning\"\n  }, mdx(\"p\", {\n    parentName: \"section\"\n  }, \"Do not send \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"apiKey\"), \" in the body. The system ignores it and takes it from the token automatically \\u2014 you do not need to include it.\")), mdx(\"br\", null)), mdx(\"section\", {\n    \"id\": \"example\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Example\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"msisdn\\\": 5215512345678,\\n    \\\"dial\\\": \\\"5217000\\\",\\n    \\\"message\\\": \\\"Your verification code is: 948271\\\",\\n    \\\"country\\\": \\\"MX\\\"\\n}\\n\")), mdx(\"br\", null)), mdx(\"section\", {\n    \"id\": \"successfulresponse\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Successful response\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"code\\\": 0,\\n    \\\"mailingId\\\": 4823910,\\n    \\\"result\\\": \\\"Applied\\\",\\n    \\\"scheduledAt\\\": null\\n}\\n\")), mdx(\"br\", null), 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  }, \"Field\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Type\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Description\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"code\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"number\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"0\"), \" = successful. Negative value = error.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"mailingId\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"number\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Unique ID of the accepted message. Use it to track the send.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"result\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"\\\"Applied\\\"\"), \" when the message was accepted.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"scheduledAt\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Scheduled date (if you used \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"schedule\"), \"). \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"null\"), \" for immediate sends.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"message\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Error description (present when \", mdx(\"inlineCode\", {\n    parentName: \"td\"\n  }, \"code\"), \" \\u2260 0).\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"hint\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"string\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Additional error detail to help with troubleshooting.\")))), mdx(Info, {\n    mdxType: \"Info\"\n  }, mdx(\"p\", {\n    parentName: \"section\"\n  }, \"All endpoints return HTTP 200 OK. The actual result of the send is indicated in the body by the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"code\"), \" field.\")), mdx(\"br\", null)), mdx(\"section\", {\n    \"id\": \"deliveryreport(dlr)\"\n  }, mdx(\"h2\", {\n    parentName: \"section\"\n  }, \"Delivery report (DLR)\"), mdx(\"p\", {\n    parentName: \"section\"\n  }, \"If you want to know whether the SMS reached the recipient, enable the delivery report by adding \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"dlr: true\"), \" and the \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"optionals\"), \" field with \", mdx(\"inlineCode\", {\n    parentName: \"p\"\n  }, \"registeredDelivery\"), \":\"), mdx(\"pre\", {\n    parentName: \"section\"\n  }, mdx(\"code\", {\n    parentName: \"pre\",\n    \"className\": \"language-json\"\n  }, \"{\\n    \\\"msisdn\\\": 5215512345678,\\n    \\\"dial\\\": \\\"5217000\\\",\\n    \\\"message\\\": \\\"Hi, your order has been shipped\\\",\\n    \\\"country\\\": \\\"MX\\\",\\n    \\\"dlr\\\": true,\\n    \\\"optionals\\\": \\\"{\\\\\\\"registeredDelivery\\\\\\\":1}\\\"\\n}\\n\")), mdx(\"br\", null)), mdx(\"section\", {\n    \"id\": \"deliveryreport(dlr)--dlrrules\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"DLR rules\"), mdx(\"ul\", null, mdx(\"li\", null, \"If you send \", mdx(\"code\", null, \"dlr: true\"), \", the \", mdx(\"code\", null, \"optionals\"), \" field must include \", mdx(\"code\", null, \"registeredDelivery\"), \" with a valid value.\"), mdx(\"li\", null, \"If you include \", mdx(\"code\", null, \"registeredDelivery\"), \" in \", mdx(\"code\", null, \"optionals\"), \", \", mdx(\"code\", null, \"dlr\"), \" must be \", mdx(\"code\", null, \"true\"), \".\")), mdx(\"br\", null)), mdx(\"section\", {\n    \"id\": \"deliveryreport(dlr)--validregistereddeliveryvalues\"\n  }, mdx(\"h3\", {\n    parentName: \"section\"\n  }, \"Valid \", mdx(\"inlineCode\", {\n    parentName: \"h3\"\n  }, \"registeredDelivery\"), \" values\"), 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\": \"center\"\n  }, \"Value\"), mdx(\"th\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Meaning\"))), mdx(\"tbody\", {\n    parentName: \"table\"\n  }, mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": \"center\"\n  }, \"1\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Notifies only on successful delivery.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": \"center\"\n  }, \"5\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Notifies on delivery or on failure.\")), mdx(\"tr\", {\n    parentName: \"tbody\"\n  }, mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": \"center\"\n  }, \"11\"), mdx(\"td\", {\n    parentName: \"tr\",\n    \"align\": null\n  }, \"Notifies on any status change.\"))))));\n}\n;\nMDXContent.isMDXComponent = true;","tableOfContents":{"items":[{"items":[{"url":"#body","title":"Body"},{"url":"#example","title":"Example"},{"url":"#successful-response","title":"Successful response"}]},{"url":"#delivery-report-dlr","title":"Delivery report (DLR)","items":[{"url":"#dlr-rules","title":"DLR rules"},{"url":"#valid-registereddelivery-values","title":"Valid registeredDelivery values"}]}]},"timeToRead":1,"parent":{"__typename":"File","relativePath":"api-externa/sms/api-http/http.md","fields":{"gitLogLatestAuthorName":"Irais Aguirre","gitLogLatestAuthorEmail":"irais.aguirre@conceptomovil.com","gitLogLatestDate":"7 days 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":"3a96a15c-8c8b-59f4-9609-1110ce0fcd6f"}},"staticQueryHashes":["12478684","12478684","2882937274","2882937274","353167761","353167761"]}