Send Message

post

https://api.delivyr.net/general/message

Sends a message using an approved template. url is optional; include it only when you want a click-tracking link appended to the SMS.

Request body must be valid, stringified JSON. Send a JSON object as the HTTP body (for example, JSON.stringify({...}) in JavaScript). Do not send an unstringified object, a JavaScript object literal, or any other non-JSON payload. Unparseable JSON is completely discarded: it is not processed and is not recorded in rejected messages.

No rate limit. This endpoint is asynchronous. API Gateway is a passthrough to SQS, so there is no application rate limiter. It is designed to accept any burst of traffic.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Delivyr message sending system is asynchronous. The response given is the raw Amazon SQS response. Leverage the request_id to track the outcome of the message.

Body Params

template_id

string

required

Template UUID

phone_number

string

required

Recipient phone number. Accepts 10-digit numbers (country code 1 is prepended), 11-digit numbers starting with 1, or formatted numbers with dashes/spaces/plus signs (non-numeric characters are stripped).

url

string

Optional destination URL. When provided, a tracking link (https://{sending_domain}/{message_id}) is appended to the message body and stored on the message log. When omitted, no tracking link is added and the message is still sent.

variables

object

Template variable values. Keys must match placeholders in the template body (for example {{first_name}}). Unreplaced placeholders cause the message to be rejected.

domain

string

Optional sending domain hostname. If omitted, the account's sending_domain is used.

request_id

string

An optional tracking identifier stored on the message log

testing

boolean

Defaults to false

When true, the message is processed normally except it is not sent to the carriers.

Response

200OK