Chats and text messages

Resia runs text conversations in two ways:

  • A chat is a two-way conversation between a Chat Agent and one person, over SMS or in your own web page.
  • A text message is a one-way message, such as a reminder. Send many at once with a text message batch.

Chat Agents

A Chat Agent is the text version of a Call Agent. It has the same required fields (name, instructions, input_schema, analysis_prompt, analysis_schema), the same $name variables, and the same review process.

Optional fields:

Field What it does
description One line that says what the agent is for.
inbound_input_webhook_url Supplies inputs when a person texts your number, and decides who may chat. See Run a text-message chat.
chat_ended_webhook_url Receives a chat.ended event when each chat ends.
milestones Named stages that the chat can report.

Do not add STOP, HELP, or other opt-out wording to the instructions. On SMS, Resia adds the required notice itself. A web chat does not need it.

Channels

Channel How it starts Needs a phone number?
sms, outbound You call POST /v1/chats with the person's phone number as participant_handle. Yes, on an active 10DLC campaign.
sms, inbound A person texts a number that has an inbound_chat_agent_id. Yes, on an active 10DLC campaign.
web You call POST /v1/chats with your own ID for the person. Your server relays messages. No

Chat status

Status Meaning
pending The chat started. The agent is writing its first message.
active The conversation is open.
completed The agent finished its task and ended the chat.
failed The chat could not continue.
cancelled You cancelled it with POST /v1/chats/{chat_id}/cancel.

Read a chat and its transcript with GET /v1/chats/{chat_id}. List chats with GET /v1/chats, filtered by chat_agent_id.

Text messages

Use a text message batch to send the same text to up to 1,000 recipients from one of your numbers. Each recipient gets its own text_message_id. See Send text messages in bulk.

Text message status: accepted, queued, sent, delivered, delivery_unconfirmed, failed, or canceled.

Resia sends texts to numbers in the United States only. POST /v1/text-messages still works for one text, but it is deprecated. Use a batch instead.

Guides

API reference

Chat Agents · Chats · Text Messages · Text Message Batches