Sms

2 actions. Each is callable by the agent as a tool, over HTTP via /api/invoke, and (usually) from a UI page.

sms.send

POST · mutating

Send an SMS. from is one of the workspace's phone numbers; to is an E.164 number or a platform actor id. The SMS is recorded as a message inside an SMS conversation so the thread stays visible in the platform.

When the agent calls it: Prefer this over messages.send when the target is a phone number or an actor who has phoneNumber set + smsRoutingPreference != direct-only.

  • AI tool: sms_send
  • API: POST /api/invoke/sms.send

Input

Field Type Required Description
fromPhoneNumberId string yes
toNumber string
toActorId string
body string yes
conversationId string
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "fromPhoneNumberId": {
      "type": "string",
      "minLength": 1
    },
    "toNumber": {
      "type": "string"
    },
    "toActorId": {
      "type": "string",
      "minLength": 1
    },
    "body": {
      "type": "string",
      "minLength": 1
    },
    "conversationId": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "fromPhoneNumberId",
    "body"
  ]
}

sms.send_in_conversation

POST · mutating

Send an SMS reply inside an existing SMS conversation. The platform infers the sending phone number from the conversation's externalRef.

  • AI tool: sms_send_in_conversation
  • API: POST /api/invoke/sms.send_in_conversation

Input

Field Type Required Description
conversationId string yes
body string yes
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "conversationId": {
      "type": "string",
      "minLength": 1
    },
    "body": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "conversationId",
    "body"
  ]
}