Message methods: create, get, list

Reference for Message, one group of Message methods.

Message.create

Creates a Message. Verb page.

TypeScript

interface MessageVerbs {
  create(input: MessageCreateInput, options?: SB.CallOptions): SB.Call<Message>
}

Emits Message.created.

Inputs

Input	Type	Required	Description
`medium`	`string`	required	One of `email`, `sms`, `voice`, or `chat`.
`direction`	`string`	required	One of `inbound` or `outbound`.
`body`	`text`	required	What it says.
`from`	`string`		The sender: an address, a number, or a Channel id.
`to`	`string`		The recipient: an address, a number, or a Person id.
`subject`	`string`		The subject line, for email.
`purpose`	`string`		Why it goes out, such as onboarding; consent and suppression rules read it.
`sequence`	Sequence		A Sequence sends Messages, each at its own step and wait.
`channel`	Channel		Every Message flows through one Channel.
`thread`	Thread		A Thread groups Messages that reply to one another.

Returns

Output	Type	Required	Description
`message`	Message	required	The Message.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const message = await $.Message.create({ medium: 'email', direction: 'inbound', body: 'Example body' })

Returns one Message by id. Verb page.

TypeScript

interface MessageVerbs {
  get(input: MessageGetInput, options?: SB.CallOptions): SB.Call<Message>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Message.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`message`	Message	required	The Message.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const message = await $.Message.get({ id: 'message_3Dg8ysSOyQ' })

Returns Messages, newest first, one page at a time. Verb page.

TypeScript

interface MessageVerbs {
  list(input?: MessageListInput, options?: SB.CallOptions): SB.ListCall<Message>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`messages`	list of Message	required	One page of Messages.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const messages = await $.Message.list({ limit: 20 })