# Agent Inbox

> Read and organize messages from your Agent Inbox and manage interactions and contacts.

App · 15 actions. Web page: https://docs.lodol.com/docs/integrations/agent-inbox

## Actions

### Ask a question

Send a question and return the interaction ID for its answer.

**Inputs**

- Contact (`contact_id`, text, required): Choose a contact or enter their email address.
- Message (`title`, text, required): Enter the message or question to send.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}
```

### Cancel interaction

Cancel interaction in Agent Inbox.

**Inputs**

- Interaction ID (`interaction_id`, text, required): Interaction ID.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example"
    }
  }
}
```

### Check inbox address

Check inbox address in Agent Inbox.

**Inputs**

- Mailbox handle (`handle`, text): Mailbox handle.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Get contact

Get contact in Agent Inbox.

**Inputs**

- Contact (`contact_id`, text, required): Contact.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "email": "example",
      "firstName": "example",
      "lastName": "example",
      "subscriberId": "example"
    }
  }
}
```

### Get conversation

Get conversation in Agent Inbox.

**Inputs**

- Conversation (`conversation_id`, text, required): Conversation.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.
- Limit (`limit`, number): Limit. From 1 to 100.
- Older messages cursor (`before`, text): Older messages cursor.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "messages": [],
      "thread": {
        "channel": "example",
        "id": "example",
        "lastActivityAt": "example",
        "lastMessage": {
          "at": "example",
          "id": "example",
          "text": "example"
        },
        "status": "example"
      }
    }
  }
}
```

### Get default agent

Get default agent in Agent Inbox.

**Inputs**

- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {}
  }
}
```

### Get inbox owner

Get the owner of this Agent Inbox account.

**Inputs**: None.

**Outputs**

- `data` (object): The inbox owner response.

**Example output**

```json
{
  "data": {
    "data": {
      "subscriberId": "example"
    }
  }
}
```

### Get interaction

Get interaction in Agent Inbox.

**Inputs**

- Interaction ID (`interaction_id`, text, required): Interaction ID.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}
```

### List contacts

List contacts in Agent Inbox.

**Inputs**

- Limit (`limit`, number): Limit. From 1 to 100.
- Next page cursor (`after`, text): Next page cursor.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": [],
    "next": "example"
  }
}
```

### List conversations

List conversations in Agent Inbox.

**Inputs**

- Read status (`filter`, text): Read status. One of: `all`, `unread`, `read`.
- Status (`status`, text): Status. One of: `all`, `open`, `resolved`.
- Senders (`senders`, text): Senders. One of: `contacts`, `all`.
- Limit (`limit`, number): Limit. From 1 to 100.
- Next page cursor (`after`, text): Next page cursor.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": [],
    "next": "example"
  }
}
```

### Mark conversation read

Mark conversation read in Agent Inbox.

**Inputs**

- Conversation (`conversation_id`, text, required): Conversation.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The updated conversation.

**Example output**

```json
{
  "data": {
    "data": {
      "channel": "example",
      "id": "example",
      "lastActivityAt": "example",
      "lastMessage": {
        "at": "example",
        "id": "example",
        "text": "example"
      },
      "status": "example"
    }
  }
}
```

### Reply to a conversation

Send a message in an existing Agent Inbox conversation.

**Inputs**

- Conversation (`conversation_id`, text, required): Choose the conversation to reply to.
- Message (`title`, text, required): Enter the message or question to send.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}
```

### Request approval

Send an approval request and return the interaction ID for its outcome.

**Inputs**

- Contact (`contact_id`, text, required): Choose a contact or enter their email address.
- Message (`title`, text, required): Enter the message or question to send.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}
```

### Resolve conversation

Resolve conversation in Agent Inbox.

**Inputs**

- Conversation (`conversation_id`, text, required): Conversation.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The updated conversation.

**Example output**

```json
{
  "data": {
    "data": {
      "channel": "example",
      "id": "example",
      "lastActivityAt": "example",
      "lastMessage": {
        "at": "example",
        "id": "example",
        "text": "example"
      },
      "status": "example"
    }
  }
}
```

### Send message

Send a message to one contact in Agent Inbox.

**Inputs**

- Contact (`contact_id`, text, required): Choose a contact or enter their email address.
- Message (`title`, text, required): Enter the message or question to send.
- Agent identifier (`agent_identifier`, text): Leave empty to use your default agent.

**Outputs**

- `data` (object): The Agent Inbox response.

**Example output**

```json
{
  "data": {
    "data": {
      "id": "example",
      "kind": "example",
      "status": "example",
      "threads": []
    }
  }
}
```
