ثبت‌نام رایگان

ورود

API docs by Redocly

Nimchat (1.0.0)

Download OpenAPI specification:Download

E-mail: hi@nim.chat

مستند وب‌سرویس‌های نیمچت

Accounts

Create an Account

Create an Account

Authorizations:
platformAppApiKey
Request Body schema: application/json; charset=utf-8
name
string

Name of the account

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string"
}

Get an account details

Get the details of an account

Authorizations:
platformAppApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string"
}

Update an account

Update an account's attributes

Authorizations:
platformAppApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
name
string

Name of the account

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string"
}

Delete an Account

Delete an Account

Authorizations:
platformAppApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Account Users

List all Account Users

List all account users

Authorizations:
platformAppApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create an Account User

Create an Account User

Authorizations:
platformAppApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
user_id
required
integer

The ID of the user

role
required
string

whether user is an administrator or agent

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "user_id": 0,
  • "role": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "account_id": 0,
  • "user_id": 0,
  • "role": "string"
}

Delete an Account User

Delete an Account User

Authorizations:
platformAppApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
user_id
required
integer

The ID of the user

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "user_id": 0
}

AgentBots

List all AgentBots

List all agent bots available

Authorizations:
platformAppApiKey

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create an Agent Bot

Create an agent bot

Authorizations:
platformAppApiKey
Request Body schema: application/json; charset=utf-8
name
string

The name of the agent bot

description
string

The description about the agent bot

outgoing_url
string

The webhook URL for the bot

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string",
  • "outgoing_url": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Get an agent bot details

Get the details of an agent bot

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The ID of the agentbot to be updated

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Update an agent bot

Update an agent bot's attributes

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The ID of the agentbot to be updated

Request Body schema: application/json; charset=utf-8
name
string

The name of the agent bot

description
string

The description about the agent bot

outgoing_url
string

The webhook URL for the bot

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string",
  • "outgoing_url": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Delete an AgentBot

Delete an AgentBot

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The ID of the agentbot to be updated

Responses

Users

Create a User

Create a User

Authorizations:
platformAppApiKey
Request Body schema: application/json; charset=utf-8
name
string

Name of the user

email
string

Email of the user

password
string

Password must contain uppercase, lowercase letters, number and a special character

custom_attributes
object

Custom attributes you want to associate with the user

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "email": "string",
  • "password": "string",
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "custom_attributes": { },
  • "accounts": [
    ]
}

Get an user details

Get the details of an user

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The numeric ID of the user on the platform

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "custom_attributes": { },
  • "accounts": [
    ]
}

Update a user

Update a user's attributes

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The numeric ID of the user on the platform

Request Body schema: application/json; charset=utf-8
name
string

Name of the user

email
string

Email of the user

password
string

Password must contain uppercase, lowercase letters, number and a special character

custom_attributes
object

Custom attributes you want to associate with the user

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "email": "string",
  • "password": "string",
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "custom_attributes": { },
  • "accounts": [
    ]
}

Delete a User

Delete a User

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The numeric ID of the user on the platform

Responses

Get User SSO Link

Get the sso link of a user

Authorizations:
platformAppApiKey
path Parameters
id
required
integer

The numeric ID of the user on the platform

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "url": "string"
}

Account AgentBots

List all AgentBots

List all agent bots available for the current account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create an Agent Bot

Create an agent bot in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
name
string

The name of the agent bot

description
string

The description about the agent bot

outgoing_url
string

The webhook URL for the bot

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string",
  • "outgoing_url": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Get an agent bot details

Get the details of an agent bot in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the agentbot to be updated

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Update an agent bot

Update an agent bot's attributes

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the agentbot to be updated

Request Body schema: application/json; charset=utf-8
name
string

The name of the agent bot

description
string

The description about the agent bot

outgoing_url
string

The webhook URL for the bot

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string",
  • "outgoing_url": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Delete an AgentBot

Delete an AgentBot from the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the agentbot to be updated

Responses

Agents

List Agents in Account

Get Details of Agents in an Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a New Agent

Add a new Agent to Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
name
required
string

Full Name of the agent

email
required
string

Email of the Agent

role
required
string
Enum: "agent" "administrator"

Whether its administrator or agent

availability_status
string
Enum: "available" "busy" "offline"

The availability setting of the agent.

auto_offline
boolean

Whether the availability status of agent is configured to go offline automatically when away.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "email": "string",
  • "role": "agent",
  • "availability_status": "available",
  • "auto_offline": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "availability_status": "available",
  • "auto_offline": true,
  • "custom_attributes": { }
}

Update Agent in Account

Update an Agent in Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the agent to be updated.

Request Body schema: application/json; charset=utf-8
role
required
string
Enum: "agent" "administrator"

Whether its administrator or agent

availability
string
Enum: "available" "busy" "offline"

The availability setting of the agent.

auto_offline
boolean

Whether the availability status of agent is configured to go offline automatically when away.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "role": "agent",
  • "availability": "available",
  • "auto_offline": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "availability_status": "available",
  • "auto_offline": true,
  • "custom_attributes": { }
}

Remove an Agent from Account

Remove an Agent from Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the agent to be deleted

Responses

Canned Responses

List all Canned Responses in an Account

Get Details of Canned Responses in an Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a New Canned Response

Add a new Canned Response to Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
content
string

Message content for canned response

short_code
string

Short Code for quick access of the canned response

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "content": "string",
  • "short_code": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "content": "string",
  • "short_code": "string",
  • "account_id": 0
}

Remove a Canned Response from Account

Remove a Canned Response from Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the canned response to be deleted

Responses

Contacts

List Contacts

Listing all the resolved contacts with pagination (Page size = 15) . Resolved contacts are the ones with a value for identifier, email or phone number

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
sort
string
Enum: "name" "email" "phone_number" "last_activity_at" "-name" "-email" "-phone_number" "-last_activity_at"

The attribute by which list should be sorted

page
integer
Default: 1

The page parameter

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create Contact

Create a new Contact

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
inbox_id
required
number
name
string

name of the contact

email
string

email of the contact

phone_number
string

phone number of the contact

avatar
string <binary>

Send the form data with the avatar image binary or use the avatar_url

avatar_url
string

The url to a jpeg, png file for the contact avatar

identifier
string

A unique identifier for the contact in external system

custom_attributes
object

An object where you can store custom attributes for contact. example {"type":"customer", "age":30}

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "inbox_id": 0,
  • "name": "string",
  • "email": "string",
  • "phone_number": "string",
  • "avatar": "string",
  • "avatar_url": "string",
  • "identifier": "string",
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "payload": {
    },
  • "id": 0,
  • "availability_status": "online"
}

Show Contact

Get a contact belonging to the account using ID

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the contact

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "payload": {
    },
  • "id": 0,
  • "availability_status": "online"
}

Update Contact

Update a contact belonging to the account using ID

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the contact

Request Body schema: application/json; charset=utf-8
name
string

name of the contact

email
string

email of the contact

phone_number
string

phone number of the contact

avatar
string <binary>

Send the form data with the avatar image binary or use the avatar_url

avatar_url
string

The url to a jpeg, png file for the contact avatar

identifier
string

A unique identifier for the contact in external system

custom_attributes
object

An object where you can store custom attributes for contact. example {"type":"customer", "age":30}

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "email": "string",
  • "phone_number": "string",
  • "avatar": "string",
  • "avatar_url": "string",
  • "identifier": "string",
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "payload": {
    }
}

Delete Contact

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the contact

Responses

Contact Conversations

Get conversations associated to that contact

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the contact

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Search Contacts

Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
q
string

Search using contact name, identifier, email or phone number

sort
string
Enum: "name" "email" "phone_number" "last_activity_at" "-name" "-email" "-phone_number" "-last_activity_at"

The attribute by which list should be sorted

page
integer
Default: 1

The page parameter

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "payload": [
    ]
}

Contact Filter

Filter contacts with custom filter options and pagination

Authorizations:
userApiKeyagentBotApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
page
integer
Request Body schema: application/json; charset=utf-8
Array of objects

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "payload": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Conversation Assignment

Assign Conversation

Assign a conversation to an agent or a team

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Request Body schema: application/json; charset=utf-8
assignee_id
number

Id of the assignee user

team_id
number

Id of the team. If the assignee_id is present, this param would be ignored

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "assignee_id": 0,
  • "team_id": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "custom_attributes": { },
  • "accounts": [
    ]
}

Conversation Labels

List Labels

Lists all the labels of a conversation

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "payload": [
    ]
}

Add Labels

Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Request Body schema: application/json; charset=utf-8
labels
Array of strings

Array of labels (comma-separated strings)

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "labels": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "payload": [
    ]
}

Conversations

Get Conversation Counts

Get open, unassigned and all Conversation counts

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
status
string
Default: "open"
Enum: "open" "resolved" "pending" "snoozed"

Filter by conversation status.

q
string

Filters conversations with messages containing the search term

inbox_id
integer
team_id
integer
labels
Array of strings

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "meta": {
    }
}

Conversations List

List all the conversations with pagination

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
assignee_type
string
Default: "all"
Enum: "me" "unassigned" "all" "assigned"

Filter conversations by assignee type.

status
string
Default: "open"
Enum: "open" "resolved" "pending" "snoozed"

Filter by conversation status.

q
string

Filters conversations with messages containing the search term

inbox_id
integer
team_id
integer
labels
Array of strings
page
integer
Default: 1

paginate through conversations

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "data": {
    }
}

Create New Conversation

Creating a conversation in nimchat requires a source id.

Authorizations:
userApiKeyagentBotApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
source_id
required
string

Conversation source id

inbox_id
required
string

Id of inbox in which the conversation is created
Allowed Inbox Types: Website, Phone, Api, Email

contact_id
string

Contact Id for which conversation is created

additional_attributes
object

Lets you specify attributes like browser information

custom_attributes
object

The object to save custom attributes for conversation, accepts custom attributes key and value

status
string
Enum: "open" "resolved" "pending"

Specify the conversation whether it's pending, open, closed

assignee_id
string

Agent Id for assigning a conversation to an agent

team_id
string

Team Id for assigning a conversation to a team

object

The initial message to be sent to the conversation

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "source_id": "string",
  • "inbox_id": "string",
  • "contact_id": "string",
  • "additional_attributes": { },
  • "custom_attributes": {
    },
  • "status": "open",
  • "assignee_id": "string",
  • "team_id": "string",
  • "message": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "account_id": 0,
  • "inbox_id": 0
}

Conversations Filter

Filter conversations with custom filter options and pagination

Authorizations:
userApiKeyagentBotApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
page
integer
Request Body schema: application/json; charset=utf-8
Array of objects

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "payload": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "data": {
    }
}

Conversation Details

Get all details regarding a conversation with all messages in the conversation

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "messages": [
    ],
  • "account_id": 0,
  • "inbox_id": 0,
  • "status": "open",
  • "timestamp": "string",
  • "contact_last_seen_at": "string",
  • "agent_last_seen_at": "string",
  • "unread_count": 0,
  • "additional_attributes": { },
  • "custom_attributes": {
    },
  • "meta": {
    }
}

Toggle Status

Toggles the status of the conversation between open and resolved

Authorizations:
userApiKeyagentBotApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Request Body schema: application/json; charset=utf-8
status
required
string
Enum: "open" "resolved" "pending"

The status of the conversation

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "status": "open"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "meta": { },
  • "payload": {
    }
}

Toggle Priority

Toggles the priority of conversation

Authorizations:
userApiKeyagentBotApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Request Body schema: application/json; charset=utf-8
priority
required
string
Enum: "urgent" "high" "medium" "low" "none"

The priority of the conversation

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "priority": "urgent"
}

Custom Attributes

List all custom attributes in an account

Get details of custom attributes in an Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
attribute_model
required
string
Enum: "0" "1"

conversation_attribute(0)/contact_attribute(1)

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a new custom attribute

Add a new custom attribute to account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
attribute_display_name
string

Attribute display name

attribute_display_type
integer

Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)

attribute_description
string

Attribute description

attribute_key
string

Attribute unique key value

attribute_values
Array of strings

Attribute values

attribute_model
integer

Attribute type(conversation_attribute- 0, contact_attribute- 1)

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "attribute_display_name": "string",
  • "attribute_display_type": 0,
  • "attribute_description": "string",
  • "attribute_key": "string",
  • "attribute_values": [
    ],
  • "attribute_model": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "attribute_display_name": "string",
  • "attribute_display_type": "string",
  • "attribute_description": "string",
  • "attribute_key": "string",
  • "attribute_values": "string",
  • "default_value": "string",
  • "attribute_model": "string",
  • "account_id": 0
}

Get a custom attribute details

Get the details of a custom attribute in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the custom attribute to be updated.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "attribute_display_name": "string",
  • "attribute_display_type": "string",
  • "attribute_description": "string",
  • "attribute_key": "string",
  • "attribute_values": "string",
  • "default_value": "string",
  • "attribute_model": "string",
  • "account_id": 0
}

Update custom attribute in Account

Update a custom attribute in account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the custom attribute to be updated.

Request Body schema: application/json; charset=utf-8
attribute_display_name
string

Attribute display name

attribute_display_type
integer

Attribute display type (text- 0, number- 1, currency- 2, percent- 3, link- 4, date- 5, list- 6, checkbox- 7)

attribute_description
string

Attribute description

attribute_key
string

Attribute unique key value

attribute_values
Array of strings

Attribute values

attribute_model
integer

Attribute type(conversation_attribute- 0, contact_attribute- 1)

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "attribute_display_name": "string",
  • "attribute_display_type": 0,
  • "attribute_description": "string",
  • "attribute_key": "string",
  • "attribute_values": [
    ],
  • "attribute_model": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "attribute_display_name": "string",
  • "attribute_display_type": "string",
  • "attribute_description": "string",
  • "attribute_key": "string",
  • "attribute_values": "string",
  • "default_value": "string",
  • "attribute_model": "string",
  • "account_id": 0
}

Remove a custom attribute from account

Remove a custom attribute from account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the custom attribute to be deleted

Responses

Custom Filters

List all custom filters

List all custom filters in a category of a user

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
filter_type
string
Enum: "conversation" "contact" "report"

The type of custom filter

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create a custom filter

Create a custom filter in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
filter_type
string
Enum: "conversation" "contact" "report"

The type of custom filter

Request Body schema: application/json; charset=utf-8
name
string

The name of the custom filter

type
string
Enum: "conversation" "contact" "report"

The description about the custom filter

query
object

A query that needs to be saved as a custom filter

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "type": "conversation",
  • "query": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "type": "conversation",
  • "query": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get a custom filter details

Get the details of a custom filter in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

custom_filter_id
required
integer

The numeric ID of the custom filter

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "type": "conversation",
  • "query": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update a custom filter

Update a custom filter's attributes

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

custom_filter_id
required
integer

The numeric ID of the custom filter

Request Body schema: application/json; charset=utf-8
name
string

The name of the custom filter

type
string
Enum: "conversation" "contact" "report"

The description about the custom filter

query
object

A query that needs to be saved as a custom filter

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "type": "conversation",
  • "query": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "type": "conversation",
  • "query": { },
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete a custom filter

Delete a custom filter from the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

custom_filter_id
required
integer

The numeric ID of the custom filter

Responses

Inboxes

List all inboxes

List all inboxes available in the current account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Get an inbox

Get an inbox available in the current account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the inbox

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "website_url": "string",
  • "channel_type": "string",
  • "avatar_url": "string",
  • "widget_color": "string",
  • "website_token": "string",
  • "enable_auto_assignment": true,
  • "web_widget_script": "string",
  • "welcome_title": "string",
  • "welcome_tagline": "string",
  • "greeting_enabled": true,
  • "greeting_message": "string"
}

Create an inbox

You can create more than one website inbox in each account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
name
string

The name of the inbox

avatar
string <binary>

File for avatar image

object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "avatar": "string",
  • "channel": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "website_url": "string",
  • "channel_type": "string",
  • "avatar_url": "string",
  • "widget_color": "string",
  • "website_token": "string",
  • "enable_auto_assignment": true,
  • "web_widget_script": "string",
  • "welcome_title": "string",
  • "welcome_tagline": "string",
  • "greeting_enabled": true,
  • "greeting_message": "string"
}

Update Inbox

Add avatar and disable auto assignment for an inbox

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the inbox

Request Body schema: application/json; charset=utf-8
name
string

The name of the inbox

enable_auto_assignment
required
boolean

Enable Auto Assignment

avatar
string <binary>

Image file for avatar

object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "enable_auto_assignment": true,
  • "avatar": "string",
  • "channel": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "website_url": "string",
  • "channel_type": "string",
  • "avatar_url": "string",
  • "widget_color": "string",
  • "website_token": "string",
  • "enable_auto_assignment": true,
  • "web_widget_script": "string",
  • "welcome_title": "string",
  • "welcome_tagline": "string",
  • "greeting_enabled": true,
  • "greeting_message": "string"
}

Show Inbox Agent Bot

See if an agent bot is associated to the Inbox

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the inbox

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "account_id": 0,
  • "outgoing_url": "string"
}

Add or remove agent bot

To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
number

ID of the inbox

Request Body schema: application/json; charset=utf-8
agent_bot
required
number

Agent bot ID

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "agent_bot": 0
}

List Agents in Inbox

Get Details of Agents in an Inbox

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

inbox_id
required
integer

The ID of the Inbox

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a New Agent

Add a new Agent to Inbox

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
inbox_id
required
string

The ID of the inbox

user_ids
required
Array of integers

IDs of users to be added to the inbox

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "inbox_id": "string",
  • "user_ids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Update Agents in Inbox

All agents except the one passed in params will be removed

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
inbox_id
required
string

The ID of the inbox

user_ids
required
Array of integers

IDs of users to be added to the inbox

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "inbox_id": "string",
  • "user_ids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Remove an Agent from Inbox

Remove an Agent from Inbox

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
inbox_id
required
string

The ID of the inbox

user_ids
required
Array of integers

IDs of users to be deleted from the inbox

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "inbox_id": "string",
  • "user_ids": [
    ]
}

Integrations

List all the Integrations

Get the details of all Integrations available for the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create an integration hook

Create an integration hook

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
app_id
string

The ID of app for which integration hook is being created

inbox_id
string

The inbox ID, if the hook is an inbox hook

settings
object

The settings required by the integration

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "app_id": "string",
  • "inbox_id": "string",
  • "settings": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "app_id": "string",
  • "inbox_id": "string",
  • "account_id": "string",
  • "status": true,
  • "hook_type": true,
  • "settings": { }
}

Update an Integration Hook

Update an Integration Hook

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

hook_id
required
integer

The numeric ID of the integration hook

Request Body schema: application/json; charset=utf-8
settings
object

The settings required by the integration

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "settings": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "app_id": "string",
  • "inbox_id": "string",
  • "account_id": "string",
  • "status": true,
  • "hook_type": true,
  • "settings": { }
}

Delete an Integration Hook

Delete an Integration Hook

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

hook_id
required
integer

The numeric ID of the integration hook

Responses

Messages

Get messages

List all messages of a conversation

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create New Message

Create a new message in the conversation

Authorizations:
userApiKeyagentBotApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

Request Body schema: application/json; charset=utf-8
content
required
string

The content of the message

message_type
string
Enum: "outgoing" "incoming"
private
boolean

Flag to identify if it is a private note

content_type
string
Enum: "input_email" "cards" "input_select" "form" "article"

if you want to create custom message types

content_attributes
object

attributes based on your content type

object

The template params for the message in case of whatsapp Channel

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "content": "string",
  • "message_type": "outgoing",
  • "private": true,
  • "content_type": "cards",
  • "content_attributes": { },
  • "template_params": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "content": "string",
  • "content_type": "text",
  • "content_attributes": { },
  • "message_type": "incoming",
  • "created_at": 0,
  • "private": true,
  • "attachment": { },
  • "sender": { },
  • "conversation_id": 0
}

Delete a message

Delete a message and it's attachments from the conversation.

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

conversation_id
required
integer

The numeric ID of the conversation

message_id
required
integer

The numeric ID of the message

Responses

Profile

Fetch user profile

Get the user profile details

Authorizations:
userApiKey

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "uid": "string",
  • "name": "string",
  • "available_name": "string",
  • "display_name": "string",
  • "email": "string",
  • "account_id": 0,
  • "role": "agent",
  • "confirmed": true,
  • "custom_attributes": { },
  • "accounts": [
    ]
}

Reports

Get Account reports

Get Account reports for a specific type, metric and date range

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
metric
required
string
Enum: "conversations_count" "incoming_messages_count" "outgoing_messages_count" "avg_first_response_time" "avg_resolution_time" "resolutions_count"

The type of metric

type
required
string
Enum: "account" "agent" "inbox" "label" "team"

Type of report

id
string

The Id of specific object in case of agent/inbox/label

since
string

The timestamp from where report should start.

until
string

The timestamp from where report should stop.

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Get Account reports summary

Get Account reports summary for a specific type and date range

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
type
required
string
Enum: "account" "agent" "inbox" "label" "team"

Type of report

id
string

The Id of specific object in case of agent/inbox/label

since
string

The timestamp from where report should start.

until
string

The timestamp from where report should stop.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "avg_first_response_time": "string",
  • "avg_resolution_time": "string",
  • "conversations_count": 0,
  • "incoming_messages_count": 0,
  • "outgoing_messages_count": 0,
  • "resolutions_count": 0,
  • "previous": {
    }
}

Account Conversation Metrics

Get conversation metrics for Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
type
required
string
Value: "account"

Type of report

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "open": 0,
  • "unattended": 0,
  • "unassigned": 0
}

Agent Conversation Metrics

Get conversation metrics for Agent

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
type
required
string
Value: "agent"

Type of report

user_id
string

The numeric ID of the user

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Teams

List all teams

List all teams available in the current account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Create a team

Create a team in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
name
string

The name of the team

description
string

The description of the team

allow_auto_assign
boolean

If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string",
  • "allow_auto_assign": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "allow_auto_assign": true,
  • "account_id": 0,
  • "is_member": true
}

Get a team details

Get the details of a team in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "allow_auto_assign": true,
  • "account_id": 0,
  • "is_member": true
}

Update a team

Update a team's attributes

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Request Body schema: application/json; charset=utf-8
name
string

The name of the team

description
string

The description of the team

allow_auto_assign
boolean

If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "string",
  • "description": "string",
  • "allow_auto_assign": true
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "allow_auto_assign": true,
  • "account_id": 0,
  • "is_member": true
}

Delete a team

Delete a team from the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Responses

List Agents in Team

Get Details of Agents in an Team

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a New Agent

Add a new Agent to Team

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Request Body schema: application/json; charset=utf-8
user_ids
required
Array of integers

IDs of users to be added to the team

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Update Agents in Team

All agents except the one passed in params will be removed

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Request Body schema: application/json; charset=utf-8
user_ids
required
Array of integers

IDs of users to be added to the team

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Remove an Agent from Team

Remove an Agent from Team

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

team_id
required
integer

The ID of the team to be updated

Request Body schema: application/json; charset=utf-8
user_ids
required
Array of integers

IDs of users to be deleted from the team

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "user_ids": [
    ]
}

Webhooks

List all webhooks

List all webhooks in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a webhook

Add a webhook subscription to the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
url
string

The url where the events should be sent

subscriptions
Array of strings
Items Enum: "conversation_created" "conversation_status_changed" "conversation_updated" "message_created" "message_updated" "webwidget_triggered"

The events you want to subscribe to.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "url": "string",
  • "subscriptions": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "url": "string",
  • "subscriptions": [
    ],
  • "account_id": 0
}

Update a webhook object

Update a webhook object in the account

Authorizations:
userApiKey
path Parameters
webhook_id
required
integer

The numeric ID of the webhook

account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
url
string

The url where the events should be sent

subscriptions
Array of strings
Items Enum: "conversation_created" "conversation_status_changed" "conversation_updated" "message_created" "message_updated" "webwidget_triggered"

The events you want to subscribe to.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "url": "string",
  • "subscriptions": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "url": "string",
  • "subscriptions": [
    ],
  • "account_id": 0
}

Delete a webhook

Delete a webhook from the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

webhook_id
required
integer

The numeric ID of the webhook

Responses

Automation Rule

List all automation rules in an account

Get details of automation rules in an Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

query Parameters
page
integer
Default: 1

The page parameter

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Add a new automation rule

Add a new automation rule to account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
name
string

Rule name

description
string

The description about the automation and actions

event_name
string
Enum: "conversation_created" "conversation_updated" "message_created"

The event when you want to execute the automation actions

active
boolean

Enable/disable automation rule

actions
Array of objects

Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.

conditions
Array of objects

Array of conditions on which conversation filter would work, e.g message content contains text help.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "Add label on message create event",
  • "description": "Add label support and sales on message create event if incoming message content contains text help",
  • "event_name": "message_created",
  • "active": true,
  • "actions": [
    ],
  • "conditions": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "event_name": "message_created",
  • "name": "Add label on message create event",
  • "description": "Add label support and sales on message create event if incoming message content contains text help",
  • "active": true,
  • "actions": [
    ],
  • "conditions": [
    ],
  • "account_id": 0
}

Get a automation rule details

Get the details of a automation rule in the account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the automation rule to be updated.

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "event_name": "message_created",
  • "name": "Add label on message create event",
  • "description": "Add label support and sales on message create event if incoming message content contains text help",
  • "active": true,
  • "actions": [
    ],
  • "conditions": [
    ],
  • "account_id": 0
}

Update automation rule in Account

Update a automation rule in account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the automation rule to be updated.

Request Body schema: application/json; charset=utf-8
name
string

Rule name

description
string

The description about the automation and actions

event_name
string
Enum: "conversation_created" "conversation_updated" "message_created"

The event when you want to execute the automation actions

active
boolean

Enable/disable automation rule

actions
Array of objects

Array of actions which you want to perform when condition matches, e.g add label support if message contains content help.

conditions
Array of objects

Array of conditions on which conversation filter would work, e.g message content contains text help.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "name": "Add label on message create event",
  • "description": "Add label support and sales on message create event if incoming message content contains text help",
  • "event_name": "message_created",
  • "active": true,
  • "actions": [
    ],
  • "conditions": [
    ]
}

Response samples

Content type
application/json; charset=utf-8
{
  • "event_name": "message_created",
  • "name": "Add label on message create event",
  • "description": "Add label support and sales on message create event if incoming message content contains text help",
  • "active": true,
  • "actions": [
    ],
  • "conditions": [
    ],
  • "account_id": 0
}

Remove a automation rule from account

Remove a automation rule from account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

id
required
integer

The ID of the automation rule to be deleted

Responses

Help Center

Add a new portal

Add a new portal to account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
archived
boolean

Status to check if portal is live

color
string

Header color for help-center

config
object

Configuration about supporting locales

custom_domain
string

Custom domain to display help center.

header_text
string

Help center header

homepage_link
string

link to main dashboard

name
string

Name for the portal

slug
string

Slug for the portal to display in link

page_title
string

Page title for the portal

account_id
integer

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "archived": true,
  • "color": "add color HEX string, \"#fffff\"",
  • "config": {
    },
  • "custom_domain": "https://www.nim.chat/fa",
  • "header_text": "Handbook",
  • "homepage_link": "https://www.nim.chat/fa",
  • "name": "string",
  • "slug": "string",
  • "page_title": "string",
  • "account_id": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "archived": true,
  • "color": "string",
  • "config": { },
  • "custom_domain": "string",
  • "header_text": "string",
  • "homepage_link": "string",
  • "name": "string",
  • "slug": "string",
  • "page_title": "string",
  • "account_id": 0,
  • "categories": [
    ],
  • "articles": [
    ]
}

List all portals in an account

Get details of portals in an Account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

update a new portal

update a new portal to account

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
archived
boolean

Status to check if portal is live

color
string

Header color for help-center

config
object

Configuration about supporting locales

custom_domain
string

Custom domain to display help center.

header_text
string

Help center header

homepage_link
string

link to main dashboard

name
string

Name for the portal

slug
string

Slug for the portal to display in link

page_title
string

Page title for the portal

account_id
integer

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "archived": true,
  • "color": "add color HEX string, \"#fffff\"",
  • "config": {
    },
  • "custom_domain": "https://www.nim.chat/fa",
  • "header_text": "Handbook",
  • "homepage_link": "https://www.nim.chat/fa",
  • "name": "string",
  • "slug": "string",
  • "page_title": "string",
  • "account_id": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "archived": true,
  • "color": "string",
  • "config": { },
  • "custom_domain": "string",
  • "header_text": "string",
  • "homepage_link": "string",
  • "name": "string",
  • "slug": "string",
  • "page_title": "string",
  • "account_id": 0,
  • "categories": [
    ],
  • "articles": [
    ]
}

Add a new category

Add a new category to portal

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
description
string

Category description

locale
string

Category locale

name
string

Category name

slug
string

Category slug

position
integer

Category position in the portal list to sort

portal_id
integer
account_id
integer
associated_category_id
integer

To associate similar categories to each other, e.g same category of product documentation in different languages

parent_category_id
integer

To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "description": "string",
  • "locale": "en/es",
  • "name": "string",
  • "slug": "string",
  • "position": 0,
  • "portal_id": 0,
  • "account_id": 0,
  • "associated_category_id": 0,
  • "parent_category_id": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "description": "string",
  • "locale": "string",
  • "name": "string",
  • "slug": "string",
  • "position": 0,
  • "portal_id": 0,
  • "account_id": 0,
  • "associated_category_id": 0,
  • "parent_category_id": 0
}

Add a new article

Add a new article to portal

Authorizations:
userApiKey
path Parameters
account_id
required
integer

The numeric ID of the account

Request Body schema: application/json; charset=utf-8
content
string

The text content.

meta
object

Use for search

position
integer

article position in category

status
integer
title
string
slug
string
views
integer
portal_id
integer
account_id
integer
author_id
integer
category_id
integer
folder_id
integer
associated_article_id
integer

To associate similar articles to each other, e.g to provide the link for the reference.

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "content": "string",
  • "meta": {
    },
  • "position": 0,
  • "status": [
    ],
  • "title": "string",
  • "slug": "string",
  • "views": 0,
  • "portal_id": 0,
  • "account_id": 0,
  • "author_id": 0,
  • "category_id": 0,
  • "folder_id": 0,
  • "associated_article_id": 0
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "content": "string",
  • "meta": { },
  • "position": 0,
  • "status": "draft",
  • "title": "string",
  • "slug": "string",
  • "views": 0,
  • "portal_id": 0,
  • "account_id": 0,
  • "author_id": 0,
  • "category_id": 0,
  • "folder_id": 0,
  • "associated_article_id": 0
}

Contacts API

Create a contact

Create a contact

path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

Request Body schema: application/json; charset=utf-8
identifier
string

External identifier of the contact

identifier_hash
string

Identifier hash prepared for HMAC authentication

email
string

Email of the contact

name
string

Name of the contact

phone_number
string

Phone number of the contact

avatar_url
string

The url to a jpeg, png file for the user avatar

custom_attributes
object

Custom attributes of the customer

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "identifier": "string",
  • "identifier_hash": "string",
  • "email": "string",
  • "name": "string",
  • "phone_number": "string",
  • "avatar_url": "string",
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "source_id": "string",
  • "name": "string",
  • "email": "string",
  • "pubsub_token": "string"
}

Get a contact

Get the details of a contact

path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

Responses

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "source_id": "string",
  • "name": "string",
  • "email": "string",
  • "pubsub_token": "string"
}

Update a contact

Update a contact's attributes

path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

Request Body schema: application/json; charset=utf-8
identifier
string

External identifier of the contact

identifier_hash
string

Identifier hash prepared for HMAC authentication

email
string

Email of the contact

name
string

Name of the contact

phone_number
string

Phone number of the contact

avatar_url
string

The url to a jpeg, png file for the user avatar

custom_attributes
object

Custom attributes of the customer

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "identifier": "string",
  • "identifier_hash": "string",
  • "email": "string",
  • "name": "string",
  • "phone_number": "string",
  • "avatar_url": "string",
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "source_id": "string",
  • "name": "string",
  • "email": "string",
  • "pubsub_token": "string"
}

Conversations API

Create a conversation

Create a conversation

path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

Request Body schema: application/json; charset=utf-8
custom_attributes
object

Custom attributes of the conversation

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "custom_attributes": { }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": 0,
  • "inbox_id": "string",
  • "messages": [
    ],
  • "contact": { }
}

List all conversations

List all conversations for the contact

Authorizations:
userApiKey
path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Messages API

Create a message

Create a message

path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

conversation_id
required
integer

The numeric ID of the conversation

Request Body schema: application/json; charset=utf-8
content
string

Content for the message

echo_id
string

Temporary identifier which will be passed back via websockets

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "content": "string",
  • "echo_id": "string"
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "content": "string",
  • "message_type": "string",
  • "content_type": "string",
  • "content_attributes": "string",
  • "created_at": "string",
  • "conversation_id": "string",
  • "attachments": [
    ],
  • "sender": { }
}

List all messages

List all messages in the conversation

Authorizations:
userApiKey
path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

conversation_id
required
integer

The numeric ID of the conversation

Responses

Response samples

Content type
application/json; charset=utf-8
[
  • {
    }
]

Update a message

Update a message

path Parameters
inbox_identifier
required
string

The identifier obtained from API inbox channel

contact_identifier
required
string

The source id of contact obtained on contact create

conversation_id
required
integer

The numeric ID of the conversation

message_id
required
integer

The numeric ID of the message

Request Body schema: application/json; charset=utf-8
object

Responses

Request samples

Content type
application/json; charset=utf-8
{
  • "submitted_values": {
    }
}

Response samples

Content type
application/json; charset=utf-8
{
  • "id": "string",
  • "content": "string",
  • "message_type": "string",
  • "content_type": "string",
  • "content_attributes": "string",
  • "created_at": "string",
  • "conversation_id": "string",
  • "attachments": [
    ],
  • "sender": { }
}

CSAT Survey Page

Get CSAT survey page

You can redirect the client to this URL, instead of implementing the CSAT survey component yourself.

path Parameters
conversation_uuid
required
integer

The uuid of the conversation

Responses

نیمچت یک راهکار ساده برای یکپارچه سازی تمام کانال های ارتباطی از قبیل بله، تلگرام، دایرکت اینستاگرام و وب سایت و… درون یک سامانه و مدیریت تمام ارتباطات با مشتری ها(crm) است.

  • تلفن: ۰۲۱۵۴۴۰۶۰۸۸
  • تلفن: ۰۹۳۶۷۴۶۶۳۰۴
  • ایمیل: info@nim.chat

راه های ارتباطی با ما در شبکه های اجتماعی

تمامی حقوق مادی و معنوی این سامانه متعلق به تیم نیمچت می‌باشد و کپی برداری از آن پیگرد قانونی دارد.