On this page

Conversation History

This API returns the Conversation History for a given session. Conversation History contains a list of all Messages (both user and Assistant-generated) as well as Tool and Knowledge calls from the provided session.

The API returns Tool and Knowledge calls as Messages, where the role property is either tool or knowledge, respectively.

Message Properties

Property nameTypeRequiredDescriptionChild properties

idstring

Optional

Not PII

The message ID.

Pattern: ^aia_msg_*$

account_sidSID<AC>

Optional

Not PII

The SID of the Account that created the Message resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

assistant_idstring

Optional

Not PII

The Assistant ID.

Pattern: ^aia_asst_*$

session_idstring

Optional

Not PII

The Session ID.

identitystring

Optional

Not PII

The identity of the user.

rolestring

Optional

Not PII

The role of the user associated with the message.

contentobject

Optional

Not PII

The content of the message.

metaobject

Optional

Not PII

The metadata of the message.

date_createdstring<date-time>

Optional

Not PII

The date and time in GMT when the Message was created specified in ISO 8601 format.

date_updatedstring<date-time>

Optional

Not PII

The date and time in GMT when the Message was last updated specified in ISO 8601 format.

Get Conversation History

GET https://assistants.twilio.com/v1/Sessions/{sessionId}/Messages

Path parameters

Property nameTypeRequiredPIIDescription

sessionIdstringrequired

Not PII

Session id or name

Query parameters

Property nameTypeRequiredPIIDescription

Pageinteger

Optional

Not PII

The page index. This value is simply for client state.

Minimum: 0

PageSizeinteger

Optional

Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

Get Conversation History

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listMessages() {
11  const messages = await client.assistants.v1
12    .sessions("your-session-id")
13    .messages.list({ limit: 20 });
14
15  messages.forEach((m) => console.log(m.id));
16}
17
18listMessages();

Output

1{
2  "messages": [
3    {
4      "id": "aia_msg",
5      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "assistant_id": "aia_asst",
7      "session_id": "session_id",
8      "identity": "identity",
9      "role": "role",
10      "content": {},
11      "meta": {},
12      "date_created": "2009-07-06T20:30:00Z",
13      "date_updated": "2009-07-06T20:30:00Z"
14    }
15  ],
16  "meta": {
17    "first_page_url": "https://www.example.com",
18    "key": "key",
19    "next_page_url": "https://www.example.com",
20    "page": 42,
21    "page_size": 42,
22    "previous_page_url": "https://www.example.com",
23    "url": "https://www.example.com"
24  }
25}