Skip to main content
Server path: /freshchat | Type: Application | PCID required: Yes

Tools

ToolDescription
freshchat_create_conversationCreate a conversation
freshchat_create_userCreate a user
freshchat_get_agentView an agent
freshchat_get_channelView a channel
freshchat_get_conversationView a conversation
freshchat_get_groupView a group
freshchat_get_userView a user
freshchat_list_agentsList all agents
freshchat_list_channelsList all channels
freshchat_list_conversation_messagesList messages in a conversation
freshchat_list_conversationsList all conversations
freshchat_list_groupsList all groups
freshchat_list_usersList all users
freshchat_send_messageSend a message in a conversation
freshchat_update_conversationUpdate a conversation
freshchat_update_userUpdate a user

freshchat_create_conversation

Create a conversation Parameters:
ParameterTypeRequiredDefaultDescription
app_idstringYesID of the Freshchat application.
channel_idstringYesID of the channel.
messagesobject[]YesInitial messages for the conversation.
usersobject[]NoUsers to involve in the conversation.

freshchat_create_user

Create a user Parameters:
ParameterTypeRequiredDefaultDescription
emailstringNoEmail address.
first_namestringNoFirst name.
last_namestringNoLast name.
phonestringNoPhone number.
propertiesobject[]NoCustom user properties.

freshchat_get_agent

View an agent Parameters:
ParameterTypeRequiredDefaultDescription
agent_idstringYesThe ID of the agent.

freshchat_get_channel

View a channel Parameters:
ParameterTypeRequiredDefaultDescription
channel_idstringYesThe ID of the channel.

freshchat_get_conversation

View a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe ID of the conversation.

freshchat_get_group

View a group Parameters:
ParameterTypeRequiredDefaultDescription
group_idstringYesThe ID of the group.

freshchat_get_user

View a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe ID of the user.

freshchat_list_agents

List all agents Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination.
items_per_pageintegerNoNumber of items per page.

freshchat_list_channels

List all channels

freshchat_list_conversation_messages

List messages in a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe ID of the conversation.
pageintegerNoPage number for pagination.
items_per_pageintegerNoNumber of items per page.

freshchat_list_conversations

List all conversations Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination.
items_per_pageintegerNoNumber of items per page.
statusstringNoFilter conversations by status (new, assigned, resolved, reopened).
assigned_agent_idstringNoFilter by assigned agent ID.
assigned_group_idstringNoFilter by assigned group ID.

freshchat_list_groups

List all groups

freshchat_list_users

List all users Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number for pagination.
items_per_pageintegerNoNumber of items per page.

freshchat_send_message

Send a message in a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe ID of the conversation.
actor_idstringYesID of the actor sending the message.
actor_typestringYesType of actor sending the message.
message_partsobject[]YesParts composing the message content.
message_typestringNoType of message.

freshchat_update_conversation

Update a conversation Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringYesThe ID of the conversation.
assigned_agent_idstringNoID of the agent to assign.
assigned_group_idstringNoID of the group to assign.
statusstringNoNew status for the conversation.

freshchat_update_user

Update a user Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe ID of the user.
emailstringNoEmail address.
first_namestringNoFirst name.
last_namestringNoLast name.
phonestringNoPhone number.
propertiesobject[]NoCustom user properties.