imessage

Send an iMessage from Agency code via the macOS Messages app. Works on macOS only, with Messages.app signed in to iMessage. No API key required.

import { sendIMessage } from "std::messaging/imessage"

node main() {
  const result = sendIMessage("+15551234567", "Hello from my agent!")
  print(result)
}

Effects

std::sendIMessage

@always(to)
effect std::sendIMessage {
  to: string
}

(source)

Functions

sendIMessage

sendIMessage(
  to: string,
  message: string,
  allowList: string[] = [],
  blockList: string[] = [],
): Result

Send an iMessage via the macOS Messages app.

@param to - Phone number or email of the recipient @param message - The text to send @param allowList - Only allow sending to these addresses/numbers @param blockList - Block sending to these addresses/numbers

Only works on macOS with Messages.app signed in to iMessage. No API key required.

Parameters:

Name	Type	Default
to	string
message	string
allowList	string[]	[]
blockList	string[]	[]

Returns: Result

Throws: std::sendIMessage

(source)