Send organization SMS

The built-in sendSms action sends a text message to a consented, verified phone number owned by the project’s organization, or to every verified organization number. Use automate org phone add to record consent and complete OTP verification first.

Example

automations/notify-organization.automation.ts

import { automation, onHttpRequest, sendSms, t } from "automate.ax"

export default automation("Text the organization", () => {
  const request = onHttpRequest({ scope: "automation" })

  sendSms({
    text: t`Received ${request.method} at ${request.path}.`,
  })
})

Inputs

Input	Type	Required	Description
`to`	`string \| "*"`	No	Verified E.164 organization phone number. Defaults to `"*"` for all verified numbers.
`text`	`string`	Yes	Message body, up to 1,000 characters.

Every input accepts a compatible signal. Sending to an unverified number fails. Automate.ax adds its identity and a STOP disclosure to every message. Platform SMS uses the organization’s monthly segment allowance. GSM characters normally fit 160 characters in one segment, while Unicode and concatenated messages have smaller segment sizes. Each recipient consumes the complete formatted message’s segment count; verification messages consume segments too.

Output

Returns { ids: string[] } with one provider message ID per recipient.

Get started

Concepts

Reference

Send organization SMS

Example

Inputs

Output

​Example

​Inputs

​Output

Example

Inputs

Output