Skip to main content

Properties

string
required
The HTTP middleware address: host[:port] or a full http(s):// URL (e.g. "imessage.example.com" or "http://localhost:8080").
boolean
When true, adds an x-idempotency-key header to mutating calls.
boolean | RetryOptions
Type: RetryOptionsRetries calls the server explicitly marked retryable.
string
Dedicated iMessage instance id (sent as x-photon-server): the middleware routes every call to that instance instead of the shared proxy. Requires a dedicated-mode token the instance accepts. Omit to stay on the shared proxy.
number
Default per-call timeout in milliseconds.
boolean
Use HTTPS for bare addresses. Defaults to true; set false for local development.
string | () => Promise<string>
required
Bearer token, or async function that returns a fresh bearer token per call.