SMS QR Code

v1.0.0

This endpoint allows you to create a QR Code that allows user to quickly send SMS. The code contains appropriately encoded recipient number and message template. After scanning the code, device message application is invoked with prefilled phone number and text, ready to be sent. To send a SMS, the user only needs to press Send button.

Input

{
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "description": "`data` property allows you to specify SMS template.",
      "type": "object"
    },
    "image": {
      "description": "`image` property allows you to set parameters of a custom image (e.g. your company logo, icon etc.) placed in the center of the generated QR Code.",
      "type": "object"
    },
    "output": {
      "description": "`output` property allows you to specify the name and extension (type) of the file returned by the API",
      "type": "object"
    },
    "size": {
      "description": "`size` property allows you to set the values that define the sizes of the generated QR Code.",
      "type": "object"
    },
    "style": {
      "description": "`style` property allows you to select the appearance parameters of the modules and eyes of the generated QR Code.\n\nAll color specifications can be defined via:\n* CSS3 name: `Black`, `azure`, ...\n* hex value: `0x000`, `#FFFFFF`, `7fffd4`, ...\n* RGB/RGBA strings: `rgb(255, 255, 255)`, `rgba(255, 255, 255, 0.5)`, ...\n* HSL strings: `hsl(270, 60%, 70%)`, `hsl(270, 60%, 70%, .5)`, ...\n\nColor values can be obtained from any online color picker like <a href=\"https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Colors/Color_picker_tool\" rel=\"noopener noreferrer\" target=\"_blank\" >developer.mozilla.org</a>.",
      "type": "object"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}