Get Conversation | AgentPhone

import { AgentPhoneClient } from "agentphone";
async function main() {
    const client = new AgentPhoneClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.conversations.getConversation("conversation_id", {});
}
main();

{
  "id": "string",
  "phoneNumberId": "string",
  "phoneNumber": "string",
  "participant": "string",
  "lastMessageAt": "2024-01-15T09:30:00Z",
  "messageCount": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "messages": [
    {
      "id": "string",
      "body": "string",
      "fromNumber": "string",
      "toNumber": "string",
      "direction": "string",
      "receivedAt": "2024-01-15T09:30:00Z",
      "senderIdentifier": "string",
      "channel": "string",
      "mediaUrl": "string",
      "mediaUrls": [
        "string"
      ],
      "reactions": [
        {
          "id": "string",
          "reactionType": "string",
          "fromNumber": "string",
          "direction": "string",
          "createdAt": "2024-01-15T09:30:00Z"
        }
      ],
      "replyTo": {
        "messageId": "string",
        "message": "string",
        "mediaUrls": [
          "string"
        ]
      }
    }
  ],
  "agentId": "string",
  "isGroup": false,
  "groupId": "string",
  "groupName": "string",
  "groupIconUrl": "string",
  "participants": [
    {
      "identifier": "string",
      "name": "string"
    }
  ],
  "metadata": {}
}

Get a conversation with its recent messages.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

conversation_idstringRequired

Query parameters

message_limitintegerOptional<=100Defaults to 50

Response

Successful Response

idstring

phoneNumberIdstring

phoneNumberstring

participantstring

lastMessageAtdatetime

messageCountinteger

createdAtdatetime

messageslist of objects

agentIdstring or null

isGroupbooleanDefaults to false

groupIdstring or null

groupNamestring or null

groupIconUrlstring or null

participantslist of objects or null

metadataobject or null

Errors

422

Unprocessable Entity Error