Agent Inbox
App · 15 actions
Read and organize messages from your Agent Inbox and manage interactions and contacts.
Actions
| Action | What it does |
|---|---|
| Ask a question | Send a question and return the interaction ID for its answer. |
| Cancel interaction | Cancel interaction in Agent Inbox. |
| Check inbox address | Check inbox address in Agent Inbox. |
| Get contact | Get contact in Agent Inbox. |
| Get conversation | Get conversation in Agent Inbox. |
| Get default agent | Get default agent in Agent Inbox. |
| Get inbox owner | Get the owner of this Agent Inbox account. |
| Get interaction | Get interaction in Agent Inbox. |
| List contacts | List contacts in Agent Inbox. |
| List conversations | List conversations in Agent Inbox. |
| Mark conversation read | Mark conversation read in Agent Inbox. |
| Reply to a conversation | Send a message in an existing Agent Inbox conversation. |
| Request approval | Send an approval request and return the interaction ID for its outcome. |
| Resolve conversation | Resolve conversation in Agent Inbox. |
| Send message | Send a message to one contact in Agent Inbox. |
Ask a question
Send a question and return the interaction ID for its answer.
Inputs
- Contact
contact_idtextRequired - Choose a contact or enter their email address.
- Message
titletextRequired - Enter the message or question to send.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {
"id": "example",
"kind": "example",
"status": "example",
"threads": []
}
}
}Cancel interaction
Cancel interaction in Agent Inbox.
Inputs
- Interaction ID
interaction_idtextRequired - Interaction ID.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {
"id": "example",
"kind": "example",
"status": "example"
}
}
}Check inbox address
Check inbox address in Agent Inbox.
Inputs
- Mailbox handle
handletext - Mailbox handle.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {}
}
}Get contact
Get contact in Agent Inbox.
Inputs
- Contact
contact_idtextRequired - Contact.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {
"email": "example",
"firstName": "example",
"lastName": "example",
"subscriberId": "example"
}
}
}Get conversation
Get conversation in Agent Inbox.
Inputs
- Conversation
conversation_idtextRequired - Conversation.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
- Limit
limitnumber - Limit.From 1 to 100.
- Older messages cursor
beforetext - Older messages cursor.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"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_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {}
}
}Get inbox owner
Get the owner of this Agent Inbox account.
Inputs
None.
Outputs
dataobject- The inbox owner response.
Example output
{
"data": {
"data": {
"subscriberId": "example"
}
}
}Get interaction
Get interaction in Agent Inbox.
Inputs
- Interaction ID
interaction_idtextRequired - Interaction ID.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {
"id": "example",
"kind": "example",
"status": "example",
"threads": []
}
}
}List contacts
List contacts in Agent Inbox.
Inputs
- Limit
limitnumber - Limit.From 1 to 100.
- Next page cursor
aftertext - Next page cursor.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": [],
"next": "example"
}
}List conversations
List conversations in Agent Inbox.
Inputs
- Read status
filtertext - Read status.One of:
all,unread,read. - Status
statustext - Status.One of:
all,open,resolved. - Senders
senderstext - Senders.One of:
contacts,all. - Limit
limitnumber - Limit.From 1 to 100.
- Next page cursor
aftertext - Next page cursor.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": [],
"next": "example"
}
}Mark conversation read
Mark conversation read in Agent Inbox.
Inputs
- Conversation
conversation_idtextRequired - Conversation.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The updated conversation.
Example output
{
"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_idtextRequired - Choose the conversation to reply to.
- Message
titletextRequired - Enter the message or question to send.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"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_idtextRequired - Choose a contact or enter their email address.
- Message
titletextRequired - Enter the message or question to send.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {
"id": "example",
"kind": "example",
"status": "example",
"threads": []
}
}
}Resolve conversation
Resolve conversation in Agent Inbox.
Inputs
- Conversation
conversation_idtextRequired - Conversation.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The updated conversation.
Example output
{
"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_idtextRequired - Choose a contact or enter their email address.
- Message
titletextRequired - Enter the message or question to send.
- Agent identifier
agent_identifiertext - Leave empty to use your default agent.
Outputs
dataobject- The Agent Inbox response.
Example output
{
"data": {
"data": {
"id": "example",
"kind": "example",
"status": "example",
"threads": []
}
}
}