Freshchat
App · 20 actions
Manage Freshchat users and conversations, send messages, discover agents and channels, and watch user conversations.
Actions
| Action | What it does |
|---|---|
| Create conversation | Create conversation. |
| Create user | Create user. |
| Delete user | Delete user. |
| Get account | Get account. |
| Get agent | Get agent. |
| Get conversation | Get conversation. |
| Get user | Get user. |
| List agent statuses | List agent statuses. |
| List agents | List agents. |
| List channels | List channels. |
| List conversation fields | List conversation fields. |
| List groups | List groups. |
| List messages | List messages. |
| List roles | List roles. |
| List user conversations | List user conversations. |
| List users | List users. |
| Send message | Send message. |
| Update agent | Update agent. |
| Update conversation | Update conversation. |
| Update user | Update user. |
Create conversation
Create conversation.
Inputs
- Channel
channel_idtextRequired - Channel ID.
- Status
statustext - Status.One of:
new,assigned,resolved,reopened. - Assigned agent
assigned_agent_idtext - Assigned agent ID.
- Assigned group
assigned_group_idtext - Assigned group ID.
- Properties
propertiesobject - Properties.
- Contact
contact_idtextRequired - The user starting the conversation.
- Message
texttextRequired - The first message in the conversation.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"conversation_id": "conversation-1"
}
}Create user
Create user.
Inputs
- Email
emailtext - Email.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Phone
phonetext - Phone.
- Reference ID
reference_idtext - Reference ID.
- Avatar
avatarobject - Avatar.
- Properties
propertieslist - Properties.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": "contact-1"
}
}Delete user
Delete user.
Inputs
- Contact
contact_idtextRequired - Contact ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Get account
Get account.
Inputs
None.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Get agent
Get agent.
Inputs
- Agent
agent_idtextRequired - Agent ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": "agent-1"
}
}Get conversation
Get conversation.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"conversation_id": "conversation-1",
"status": "new"
}
}Get user
Get user.
Inputs
- Contact
contact_idtextRequired - Contact ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"email": "qa@example.com",
"id": "contact-1"
}
}List agent statuses
List agent statuses.
Inputs
None.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}List agents
List agents.
Inputs
- Page
pagenumber - Page.At least 1.
- Items per page
items_per_pagenumber - Items per page.From 1 to 100.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"agents": [],
"pagination": {
"total_items": 0
}
}
}List channels
List channels.
Inputs
- Page
pagenumber - Page.At least 1.
- Items per page
items_per_pagenumber - Items per page.From 1 to 100.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"channels": [],
"pagination": {
"total_items": 0
}
}
}List conversation fields
List conversation fields.
Inputs
None.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}List groups
List groups.
Inputs
- Page
pagenumber - Page.At least 1.
- Items per page
items_per_pagenumber - Items per page.From 1 to 100.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"groups": [],
"pagination": {
"total_items": 0
}
}
}List messages
List messages.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Page
pagenumber - Page.At least 1.
- Items per page
items_per_pagenumber - Items per page.From 1 to 100.
- From time
from_timedate and time - From time.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"messages": [],
"pagination": {
"total_items": 0
}
}
}List roles
List roles.
Inputs
- Page
pagenumber - Page.At least 1.
- Items per page
items_per_pagenumber - Items per page.From 1 to 100.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"pagination": {
"total_items": 0
},
"roles": []
}
}List user conversations
List user conversations.
Inputs
- Contact
contact_idtextRequired - Contact ID.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"conversations": []
}
}List users
List users.
Inputs
- Page
pagenumber - Page.At least 1.
- Items per page
items_per_pagenumber - Items per page.From 1 to 100.
- Email
emailtext - Email.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Phone
phonetext - Phone.
- Sort order
sort_ordertext - Sort order.One of:
asc,desc. - Sort by
sort_bytext - Sort by.One of:
email.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"pagination": {
"total_items": 0
},
"users": []
}
}Send message
Send message.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Actor type
actor_typetextRequired - Actor type.One of:
agent,user. - Actor ID
actor_idtextRequired - Actor ID.
- Message type
message_typetextRequired - Message type.One of:
normal,private. - Message
texttextRequired - The message text.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {
"id": "message-1"
}
}Update agent
Update agent.
Inputs
- Agent
agent_idtextRequired - Agent ID.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Phone
phonetext - Phone.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Update conversation
Update conversation.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Status
statustext - Status.One of:
new,assigned,resolved,reopened. - Assigned agent
assigned_agent_idtext - Assigned agent ID.
- Assigned group
assigned_group_idtext - Assigned group ID.
- Properties
propertiesobject - Properties.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}Update user
Update user.
Inputs
- Contact
contact_idtextRequired - Contact ID.
- Email
emailtext - Email.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Phone
phonetext - Phone.
Outputs
responseobject- The complete service response, including resource data and pagination fields.
Example output
{
"response": {}
}