Conversation Namespace

The Conversation namespace includes methods that give you access to Conversation and ConversationMessage objects.

The Conversation Object

Conversation objects represent interaction pairs between Subscribers and Addresses. Each Conversation object has the following properties:

Here is an example of a Conversation object:

1
{
2
  "id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
3
  "name": "conversation-office",
4
  "metadata": {},
5
  "created_at": 1708192187729,
6
  "last_message_at": 1708192187823
7
}

The ConversationMessage object

ConversationMessage objects represent the specific interactions that have taken place in the Conversation:

• id: A unique identifier for the conversation message.
• conversation_id: A unique identifier of the parent conversation.
• user_id: A unique identifier for the subscriber.
• ts: The timestamp, in Unix Epoch, when the message was created.
• details: Additional metadata associated with the conversation.
• type: The type of the conversation message.
• subtype: The subtype of the conversation message.
• kind: The kind of the conversation message.

Here is an example of a ConversationMessage object:

1
{
2
  "id": "3c114417-5cc0-4d03-a30f-c90659028d73",
3
  "conversation_id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
4
  "user_id": "cecbe021-ff86-4ac6-bdf3-399ca477ad6f",
5
  "ts": 1708192187.6779745,
6
  "details": {},
7
  "type": "message",
8
  "subtype": "log",
9
  "kind": "call_started"
10
}

Methods

getConversations

• getConversations(): Promise<{ data: Conversation[], hasNext, hasPrev }> -

Returns a list of Conversation objects.

Returns

Promise<{ data: Conversation[], hasNext, hasPrev }>

Example

1
await client.conversation.getConversations();

1
{
2
  "data": [
3
    {
4
      "id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
5
      "name": "conversation-office",
6
      "metadata": {},
7
      "created_at": 1708192187729,
8
      "last_message_at": 1708192187823
9
    }
10
  ],
11
  "hasNext": false,
12
  "hasPrev": false
13
}

getConversationMessages

• getConversationMessages(options): Promise<{ data: ConversationMessage[], hasNext, hasPrev }>

Returns a list of ConversationMessage objects inside a Conversation with an Address ID.

Parameters

Returns

Promise<{ data: ConversationMessage[], hasNext, hasPrev }>

Example

1
await client.conversation.getConversationMessages({
2
  addressId: "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
3
});

1
{
2
  "data": [
3
    {
4
      "id": "3c114417-5cc0-4d03-a30f-c90659028d73",
5
      "conversation_id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
6
      "user_id": "cecbe021-ff86-4ac6-bdf3-399ca477ad6f",
7
      "ts": 1708192187.6779745,
8
      "details": {},
9
      "type": "message",
10
      "subtype": "log",
11
      "kind": "call_started"
12
    }
13
  ],
14
  "hasNext": false,
15
  "hasPrev": false
16
}

getMessages

• getMessages(options): Promise<{ data: ConversationMessage[], hasNext, hasPrev }>

Returns a list of ConversationMessage objects without filtering by Address ID.

Parameters

Returns

Promise<{ data: ConversationMessage[], hasNext, hasPrev }>

Example

1
await client.conversation.getMessages();

1
{
2
  "data": [
3
    {
4
      "id": "3c114417-5cc0-4d03-a30f-c90659028d73",
5
      "conversation_id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
6
      "user_id": "cecbe021-ff86-4ac6-bdf3-399ca477ad6f",
7
      "ts": 1708192187.6779745,
8
      "details": {},
9
      "type": "message",
10
      "subtype": "log",
11
      "kind": "call_started"
12
    }
13
  ],
14
  "hasNext": false,
15
  "hasPrev": false
16
}

subscribe

• subscribe(): Promise<void>

Subscribe to receive new ConversationMessage objects as they happen.

Returns

Promise<void>

Example

1
client.conversation.subscribe((conversationMessage) => {
2
  console.log("New message received!", conversationMessage);
3
  // Add conversationMessage to the UI
4
});

1
{
2
  "id": "916ea1c0-3381-42a3-8ca1-1095f13b4af0",
3
  "type": "message",
4
  "subtype": "log",
5
  "kind": "call_started",
6
  "hidden": "false",
7
  "address_id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
8
  "conversation_id": "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
9
  "user_id": "cecbe021-ff86-4ac6-bdf3-399ca477ad6f",
10
  "ts": 1708621363.211084,
11
  "metadata": {},
12
  "details": {},
13
  "text": null,
14
  "conversation_name": "conversation-office",
15
  "user_name": "Jim Carrey"
16
}

sendMessage

• sendMessage(options): Promise<Conversation>

Sends a Chat Message to the Conversation. This is the same function as chat.sendMessage.

Parameters

Example

1
await conversation.sendMessage({
2
  text: "Hello from SignalWire!",
3
});

join

• join(options): Promise<JoinConversationResponse>

Joins a conversation given an address, without having to send a message. Does nothing if you were already joined to the conversation. This is the same function as chat.join.

You automatically join a conversation when you send the first message to an address. The join method allows you to join a conversation without sending a message.

Parameters

Example

1
await conversation.join({
2
  addressId: "9dbe9e94-c797-461e-b5a3-af6d095deaf4",
3
});