Get Conversation | AgentPhone

const url = 'https://api.agentphone.ai/v1/conversations/conversation_id';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "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",
      "status": "string",
      "failureReason": "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": {},
  "capabilities": {
    "canSendMessages": true,
    "media": true,
    "reactions": true,
    "emojiReactions": true,
    "sendDisabledReason": "string",
    "sendChannel": "string"
  }
}

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 nullOptional

isGroupbooleanOptionalDefaults to false

groupIdstring or nullOptional

groupNamestring or nullOptional

groupIconUrlstring or nullOptional

participantslist of objects or nullOptional

metadataobject or nullOptional

capabilitiesobject or nullOptional

What the caller can do in this conversation, derived from its number’s provider and compliance state. Drives the dashboard composer/reaction UI.

Errors

422

Unprocessable Entity Error