Freshchat

App · 20 actions

Manage Freshchat users and conversations, send messages, discover agents and channels, and watch user conversations.

Actions

ActionWhat it does
Create conversationCreate conversation.
Create userCreate user.
Delete userDelete user.
Get accountGet account.
Get agentGet agent.
Get conversationGet conversation.
Get userGet user.
List agent statusesList agent statuses.
List agentsList agents.
List channelsList channels.
List conversation fieldsList conversation fields.
List groupsList groups.
List messagesList messages.
List rolesList roles.
List user conversationsList user conversations.
List usersList users.
Send messageSend message.
Update agentUpdate agent.
Update conversationUpdate conversation.
Update userUpdate user.

Create conversation

Create conversation.

Inputs

Channelchannel_idtextRequired
Channel ID.
Statusstatustext
Status.One of: new, assigned, resolved, reopened.
Assigned agentassigned_agent_idtext
Assigned agent ID.
Assigned groupassigned_group_idtext
Assigned group ID.
Propertiespropertiesobject
Properties.
Contactcontact_idtextRequired
The user starting the conversation.
MessagetexttextRequired
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

Emailemailtext
Email.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Phonephonetext
Phone.
Reference IDreference_idtext
Reference ID.
Avataravatarobject
Avatar.
Propertiespropertieslist
Properties.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "id": "contact-1"
  }
}

Delete user

Delete user.

Inputs

Contactcontact_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

Agentagent_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 IDconversation_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

Contactcontact_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

Pagepagenumber
Page.At least 1.
Items per pageitems_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

Pagepagenumber
Page.At least 1.
Items per pageitems_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

Pagepagenumber
Page.At least 1.
Items per pageitems_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 IDconversation_idtextRequired
Conversation ID.
Pagepagenumber
Page.At least 1.
Items per pageitems_per_pagenumber
Items per page.From 1 to 100.
From timefrom_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

Pagepagenumber
Page.At least 1.
Items per pageitems_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

Contactcontact_idtextRequired
Contact ID.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {
    "conversations": []
  }
}

List users

List users.

Inputs

Pagepagenumber
Page.At least 1.
Items per pageitems_per_pagenumber
Items per page.From 1 to 100.
Emailemailtext
Email.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Phonephonetext
Phone.
Sort ordersort_ordertext
Sort order.One of: asc, desc.
Sort bysort_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 IDconversation_idtextRequired
Conversation ID.
Actor typeactor_typetextRequired
Actor type.One of: agent, user.
Actor IDactor_idtextRequired
Actor ID.
Message typemessage_typetextRequired
Message type.One of: normal, private.
MessagetexttextRequired
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

Agentagent_idtextRequired
Agent ID.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Phonephonetext
Phone.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update conversation

Update conversation.

Inputs

Conversation IDconversation_idtextRequired
Conversation ID.
Statusstatustext
Status.One of: new, assigned, resolved, reopened.
Assigned agentassigned_agent_idtext
Assigned agent ID.
Assigned groupassigned_group_idtext
Assigned group ID.
Propertiespropertiesobject
Properties.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update user

Update user.

Inputs

Contactcontact_idtextRequired
Contact ID.
Emailemailtext
Email.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Phonephonetext
Phone.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

On this page