QR Code API

Server-rendered QR code images. Useful for print collateral, in-store posters, kiosk touchpoints, and “scan to start chatting” prompts. Base path: /api/v1/qr Authentication: API key (X-API-Key) or session JWT. Limits: Image size (size) must be between 50 × 50 and 1024 × 1024 pixels. Defaults to 300 × 300 if omitted.

Method	Path	Purpose
`GET`	`/api/v1/qr/generate`	Generate a QR for arbitrary data (URL or text)
`GET`	`/api/v1/qr/whatsapp`	Generate a “click to chat” WhatsApp QR
`GET`	`/api/v1/qr/sms`	Generate a pre-filled SMS QR

Using the SDKs

The QRs above arrive as image/png bytes, so there is no typed orbit.qr.* resource for them yet — call these routes through the generic orbit.request() helper until one lands:

import { Orbit } from "@devotel-orbit/node";

const orbit = new Orbit({ apiKey: process.env.ORBIT_API_KEY! });

const res = await orbit.request(
  "GET",
  "/qr/whatsapp?phone=14155552671&format=json",
);

Python (same call via the SDK’s escape hatch):

from orbit_sdk import OrbitClient

client = OrbitClient.from_env()  # reads ORBIT_API_KEY

res = client.request("GET", "/qr/whatsapp?phone=14155552671&format=json")

The Python SDK is core-scope — it wraps the 8 core resources (messaging, voice, contacts, campaigns, verify, numbers) and reaches everything else through the generic client.request() escape hatch above. See the Python SDK. Returns the qr_data_url envelope shown below. See the SDK index at SDK quickstart.

Shared parameters

Every route accepts the same two rendering parameters:

Parameter	Type	Default	Description
`size`	integer (50–1024)	`300`	Width and height of the QR image, in pixels.
`format`	`png` \| `json`	`png`	Response format — see Response formats.

Response formats

By default every route returns raw image/png bytes (Content-Type: image/png), ready to embed in a print template or <img> tag. Pass ?format=json to receive a base64 data URL inside the standard JSON envelope instead — useful when you want to render the QR client-side or store the image alongside its source values.

{
  "data": {
    "qr_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "data": "https://orb.li/spring-sale",
    "size": 400
  }
}

The qr_data_url field is a ready-to-use data: URL you can drop straight into an <img src="...">. The /whatsapp and /sms routes additionally return the encoded deep link (whatsapp_link / sms_link) and the normalized phone.

Generate — arbitrary URL or text

GET /api/v1/qr/generate encodes any URL or plain-text string you provide.

Parameter	Type	Default	Description
`data`	string (1–2048 chars)	— (required)	The URL or text to encode. Script-execution URL schemes (`javascript:`, `data:`, `vbscript:`, and similar) are rejected with a `400`.

curl "https://api.orbit.devotel.io/api/v1/qr/generate?data=https%3A%2F%2Forb.li%2Fspring-sale&size=400" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -o generate-qr.png

Request the JSON envelope instead of the raw image:

curl "https://api.orbit.devotel.io/api/v1/qr/generate?data=https%3A%2F%2Forb.li%2Fspring-sale&size=400&format=json" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Response 200 with format=json:

{
  "data": {
    "qr_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "data": "https://orb.li/spring-sale",
    "size": 400
  }
}

Script-execution URL schemes are rejected with 400:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "QR data must not use script-execution URL schemes."
  }
}

WhatsApp click-to-chat poster

GET /api/v1/qr/whatsapp encodes a https://wa.me/{phone} deep link that opens a pre-filled WhatsApp chat.

Parameter	Type	Default	Description
`phone`	string	— (required)	Destination number in international format (e.g. `14155552671`).
`message`	string (≤ 1024 chars)	`""`	Pre-filled chat text.

curl "https://api.orbit.devotel.io/api/v1/qr/whatsapp?phone=14155552671&message=Hi%20there&size=400" \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -o whatsapp-qr.png

Returns a PNG. Embed directly in a print template or <img> tag. Response 200 with ?format=json:

{
  "data": {
    "qr_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "whatsapp_link": "https://wa.me/14155552671?text=Hi%20there",
    "phone": "14155552671",
    "size": 400
  }
}

whatsapp_link is the exact deep link encoded into the QR; phone is the normalized digits.

SMS deep link

GET /api/v1/qr/sms encodes an sms:{phone}?body={message} URI that opens the native SMS composer.

Parameter	Type	Default	Description
`phone`	string	— (required)	Destination number in international format.
`message`	string (≤ 1024 chars)	`""`	Pre-filled SMS body.

curl "https://api.orbit.devotel.io/api/v1/qr/sms?phone=14155552671&message=Quote%20SAVE10&size=400&format=json" \
  -H "X-API-Key: dv_live_sk_your_key_here"

Response 200 with ?format=json:

{
  "data": {
    "qr_data_url": "data:image/png;base64,iVBORw0KGgoAAAANSU...",
    "sms_link": "sms:+14155552671?body=Quote%20SAVE10",
    "phone": "+14155552671",
    "size": 400
  }
}

API Reference

All Endpoints

QR Code API: generate codes for URLs and deep links

QR Code API

Using the SDKs

Shared parameters

Response formats

Generate — arbitrary URL or text

WhatsApp click-to-chat poster

SMS deep link

​QR Code API

​Using the SDKs

​Shared parameters

​Response formats

​Generate — arbitrary URL or text

​WhatsApp click-to-chat poster

​SMS deep link

QR Code API

Using the SDKs

Shared parameters

Response formats

Generate — arbitrary URL or text

WhatsApp click-to-chat poster

SMS deep link