akadmin/chatwoot
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

fix developer docs request data

Browse Source
This commit is contained in:
Tanmay Deep Sharma
2025-05-15 12:39:48 +07:00
parent c738b3cfaa
commit 9181a57df2
8 changed files with 422 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files
swagger/definitions/resource/agent.yml
+22 -18
View File
@@ -2,23 +2,8 @@ type: object
properties:
id:
type: integer
uid:
type: string
name:
type: string
available_name:
type: string
display_name:
type: string
email:
type: string
account_id:
type: integer
role:
type: string
enum: ['agent', 'administrator']
confirmed:
type: boolean
availability_status:
type: string
enum: ['available', 'busy', 'offline']
@@ -26,6 +11,25 @@ properties:
auto_offline:
type: boolean
description: Whether the availability status of agent is configured to go offline automatically when away.
custom_attributes:
type: object
description: Available for users who are created through platform APIs and has custom attributes associated.
confirmed:
type: boolean
description: Whether the agent has confirmed their email address.
email:
type: string
description: The email of the agent
available_name:
type: string
description: The available name of the agent
name:
type: string
description: The name of the agent
role:
type: string
enum: ['agent', 'administrator']
description: The role of the agent
thumbnail:
type: string
description: The thumbnail of the agent
custom_role_id:
type: integer
description: The custom role id of the agent
swagger/definitions/resource/agent_bot.yml
+18 -3
View File
@@ -9,9 +9,24 @@ properties:
description:
type: string
description: The description about the agent bot
account_id:
type: number
description: Account ID if it's an account specific bot
thumbnail:
type: string
description: The thumbnail of the agent bot
outgoing_url:
type: string
description: The webhook URL for the bot
bot_type:
type: string
description: The type of the bot
bot_config:
type: object
description: The configuration of the bot
account_id:
type: number
description: Account ID if it's an account specific bot
access_token:
type: string
description: The access token for the bot
system_bot:
type: boolean
description: Whether the bot is a system bot
swagger/definitions/resource/automation_rule.yml
+48 -40
View File
@@ -1,45 +1,53 @@
type: object
properties:
event_name:
type: string
description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)
enum:
- conversation_created
- conversation_updated
- message_created
example: message_created
name:
type: string
description: The name of the rule
example: Add label on message create event
description:
type: string
description: Description to give more context about the rule
example: Add label support and sales on message create event if incoming message content contains text help
active:
type: boolean
description: Enable/disable automation rule
actions:
payload:
type: array
description: Array of actions which we perform when condition matches
items:
type: object
example:
action_name: add_label
action_params:
- support
- sales
conditions:
type: array
description: Array of conditions on which conversation/message filter would work
items:
type: object
example:
attribute_key: content
filter_operator: contains
values:
- help
query_operator: nil
account_id:
type: integer
description: Account Id
properties:
id:
type: integer
description: The ID of the automation rule
event_name:
type: string
description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)
enum:
- conversation_created
- conversation_updated
- message_created
example: message_created
name:
type: string
description: The name of the rule
example: Add label on message create event
description:
type: string
description: Description to give more context about the rule
example: Add label support and sales on message create event if incoming message content contains text help
active:
type: boolean
description: Enable/disable automation rule
actions:
type: array
description: Array of actions which we perform when condition matches
items:
type: object
example:
action_name: add_label
action_params:
- support
- sales
conditions:
type: array
description: Array of conditions on which conversation/message filter would work
items:
type: object
example:
attribute_key: content
filter_operator: contains
values:
- help
query_operator: nil
account_id:
type: integer
description: Account Id
swagger/definitions/resource/canned_response.yml
+12 -6
View File
@@ -3,12 +3,18 @@ properties:
id:
type: integer
description: ID of the canned response
content:
type: string
description: Message content for canned response
short_code:
type: string
description: Short Code for quick access of the canned response
account_id:
type: integer
description: Account Id
short_code:
type: string
description: Short Code for quick access of the canned response
content:
type: string
description: Message content for canned response
created_at:
type: string
description: The date and time when the canned response was created
updated_at:
type: string
description: The date and time when the canned response was updated
swagger/definitions/resource/contact.yml
+46 -29
View File
@@ -1,32 +1,49 @@
type: object
properties:
payload:
type: object
properties:
contact:
type: object
properties:
email:
type: string
description: Email address of the contact
name:
type: string
description: The name of the contact
phone_number:
type: string
description: Phone number of the contact
thumbnail:
type: string
description: Avatar URL of the contact
additional_attributes:
type: object
description: The object containing additional attributes related to the contact
custom_attributes:
type: object
description: The object to save custom attributes for contact, accepts custom attributes key and value
example:
{ attribute_key: attribute_value, signed_up_at: dd/mm/yyyy }
contact_inboxes:
type: array
items:
$ref: '#/components/schemas/contact_inboxes'
type: array
items:
type: object
properties:
additional_attributes:
type: object
description: The object containing additional attributes related to the contact
availability_status:
type: string
description: The availability status of the contact
email:
type: string
description: The email address of the contact
id:
type: integer
description: The ID of the contact
name:
type: string
description: The name of the contact
phone_number:
type: string
description: The phone number of the contact
blocked:
type: boolean
description: Whether the contact is blocked
identifier:
type: string
description: The identifier of the contact
thumbnail:
type: string
description: The thumbnail of the contact
custom_attributes:
type: object
description: The custom attributes of the contact
example:
{ attribute_key: attribute_value, signed_up_at: dd/mm/yyyy }
last_activity_at:
type: integer
description: The last activity at of the contact
created_at:
type: integer
description: The created at of the contact
contact_inboxes:
type: array
items:
$ref: '#/components/schemas/contact_inboxes'
swagger/definitions/resource/custom_attribute.yml
+15 -6
View File
@@ -15,15 +15,24 @@ properties:
attribute_key:
type: string
description: Attribute unique key value
regex_pattern:
type: string
description: Regex pattern
regex_cue:
type: string
description: Regex cue
attribute_values:
type: string
description: Attribute values
default_value:
type: string
description: Attribute default value
attribute_model:
type: string
description: Attribute type(conversation_attribute/contact_attribute)
account_id:
type: integer
description: Account Id
default_value:
type: string
description: Attribute default value
created_at:
type: string
description: The date and time when the custom attribute was created
updated_at:
type: string
description: The date and time when the custom attribute was updated
swagger/definitions/resource/message.yml
+51 -10
View File
@@ -1,15 +1,20 @@
type: object
properties:
id:
type: number
description: The ID of the message
content:
type: string
description: The text content of the message
content_type:
type: string
enum: ["text", "input_select", "cards", "form"]
description: The type of the template message
content_attributes:
type: object
description: The content attributes for each content_type
account_id:
type: number
description: The ID of the account
inbox_id:
type: number
description: The ID of the inbox
conversation_id:
type: number
description: The ID of the conversation
message_type:
type: string
enum: ["incoming", "outgoing", "activity", "template"]
@@ -17,15 +22,51 @@ properties:
created_at:
type: integer
description: The time at which message was created
updated_at:
type: integer
description: The time at which message was updated
private:
type: boolean
description: The flags which shows whether the message is private or not
status:
type: string
enum: ["sent", "delivered", "read", "failed"]
description: The status of the message
source_id:
type: string
description: The source ID of the message
content_type:
type: string
enum: ["text", "input_select", "cards", "form"]
description: The type of the template message
content_attributes:
type: object
description: The content attributes for each content_type
sender_type:
type: string
enum: ["contact", "agent", "agent_bot"]
description: The type of the sender
sender_id:
type: number
description: The ID of the sender
external_source_ids:
type: object
description: The external source IDs of the message
additional_attributes:
type: object
description: The additional attributes of the message
processed_message_content:
type: string
description: The processed message content
sentiment:
type: object
description: The sentiment of the message
conversation:
type: object
description: The conversation object
attachment:
type: object
description: The file object attached to the image
sender:
type: object
description: User/Agent/AgentBot object
conversation_id:
type: number
description: ID of the conversation
swagger/swagger.json
+210 -158
View File
@@ -7489,17 +7489,25 @@
"type": "integer",
"description": "ID of the canned response"
},
"content": {
"type": "string",
"description": "Message content for canned response"
"account_id": {
"type": "integer",
"description": "Account Id"
},
"short_code": {
"type": "string",
"description": "Short Code for quick access of the canned response"
},
"account_id": {
"type": "integer",
"description": "Account Id"
"content": {
"type": "string",
"description": "Message content for canned response"
},
"created_at": {
"type": "string",
"description": "The date and time when the canned response was created"
},
"updated_at": {
"type": "string",
"description": "The date and time when the canned response was updated"
}
}
},
@@ -7526,83 +7534,107 @@
"type": "string",
"description": "Attribute unique key value"
},
"regex_pattern": {
"type": "string",
"description": "Regex pattern"
},
"regex_cue": {
"type": "string",
"description": "Regex cue"
},
"attribute_values": {
"type": "string",
"description": "Attribute values"
},
"default_value": {
"type": "string",
"description": "Attribute default value"
},
"attribute_model": {
"type": "string",
"description": "Attribute type(conversation_attribute/contact_attribute)"
},
"account_id": {
"type": "integer",
"description": "Account Id"
"default_value": {
"type": "string",
"description": "Attribute default value"
},
"created_at": {
"type": "string",
"description": "The date and time when the custom attribute was created"
},
"updated_at": {
"type": "string",
"description": "The date and time when the custom attribute was updated"
}
}
},
"automation_rule": {
"type": "object",
"properties": {
"event_name": {
"type": "string",
"description": "Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)",
"enum": [
"conversation_created",
"conversation_updated",
"message_created"
],
"example": "message_created"
},
"name": {
"type": "string",
"description": "The name of the rule",
"example": "Add label on message create event"
},
"description": {
"type": "string",
"description": "Description to give more context about the rule",
"example": "Add label support and sales on message create event if incoming message content contains text help"
},
"active": {
"type": "boolean",
"description": "Enable/disable automation rule"
},
"actions": {
"payload": {
"type": "array",
"description": "Array of actions which we perform when condition matches",
"items": {
"type": "object",
"example": {
"action_name": "add_label",
"action_params": [
"support",
"sales"
]
"properties": {
"id": {
"type": "integer",
"description": "The ID of the automation rule"
},
"event_name": {
"type": "string",
"description": "Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)",
"enum": [
"conversation_created",
"conversation_updated",
"message_created"
],
"example": "message_created"
},
"name": {
"type": "string",
"description": "The name of the rule",
"example": "Add label on message create event"
},
"description": {
"type": "string",
"description": "Description to give more context about the rule",
"example": "Add label support and sales on message create event if incoming message content contains text help"
},
"active": {
"type": "boolean",
"description": "Enable/disable automation rule"
},
"actions": {
"type": "array",
"description": "Array of actions which we perform when condition matches",
"items": {
"type": "object",
"example": {
"action_name": "add_label",
"action_params": [
"support",
"sales"
]
}
}
},
"conditions": {
"type": "array",
"description": "Array of conditions on which conversation/message filter would work",
"items": {
"type": "object",
"example": {
"attribute_key": "content",
"filter_operator": "contains",
"values": [
"help"
],
"query_operator": "nil"
}
}
},
"account_id": {
"type": "integer",
"description": "Account Id"
}
}
}
},
"conditions": {
"type": "array",
"description": "Array of conditions on which conversation/message filter would work",
"items": {
"type": "object",
"example": {
"attribute_key": "content",
"filter_operator": "contains",
"values": [
"help"
],
"query_operator": "nil"
}
}
},
"account_id": {
"type": "integer",
"description": "Account Id"
}
}
},
@@ -7754,44 +7786,66 @@
"type": "object",
"properties": {
"payload": {
"type": "object",
"properties": {
"contact": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email address of the contact"
},
"name": {
"type": "string",
"description": "The name of the contact"
},
"phone_number": {
"type": "string",
"description": "Phone number of the contact"
},
"thumbnail": {
"type": "string",
"description": "Avatar URL of the contact"
},
"additional_attributes": {
"type": "object",
"description": "The object containing additional attributes related to the contact"
},
"custom_attributes": {
"type": "object",
"description": "The object to save custom attributes for contact, accepts custom attributes key and value",
"example": {
"attribute_key": "attribute_value",
"signed_up_at": "dd/mm/yyyy"
}
},
"contact_inboxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact_inboxes"
}
"type": "array",
"items": {
"type": "object",
"properties": {
"additional_attributes": {
"type": "object",
"description": "The object containing additional attributes related to the contact"
},
"availability_status": {
"type": "string",
"description": "The availability status of the contact"
},
"email": {
"type": "string",
"description": "The email address of the contact"
},
"id": {
"type": "integer",
"description": "The ID of the contact"
},
"name": {
"type": "string",
"description": "The name of the contact"
},
"phone_number": {
"type": "string",
"description": "The phone number of the contact"
},
"blocked": {
"type": "boolean",
"description": "Whether the contact is blocked"
},
"identifier": {
"type": "string",
"description": "The identifier of the contact"
},
"thumbnail": {
"type": "string",
"description": "The thumbnail of the contact"
},
"custom_attributes": {
"type": "object",
"description": "The custom attributes of the contact",
"example": {
"attribute_key": "attribute_value",
"signed_up_at": "dd/mm/yyyy"
}
},
"last_activity_at": {
"type": "integer",
"description": "The last activity at of the contact"
},
"created_at": {
"type": "integer",
"description": "The created at of the contact"
},
"contact_inboxes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/contact_inboxes"
}
}
}
@@ -7962,34 +8016,9 @@
"id": {
"type": "integer"
},
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"available_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"email": {
"type": "string"
},
"account_id": {
"type": "integer"
},
"role": {
"type": "string",
"enum": [
"agent",
"administrator"
]
},
"confirmed": {
"type": "boolean"
},
"availability_status": {
"type": "string",
"enum": [
@@ -8003,9 +8032,37 @@
"type": "boolean",
"description": "Whether the availability status of agent is configured to go offline automatically when away."
},
"custom_attributes": {
"type": "object",
"description": "Available for users who are created through platform APIs and has custom attributes associated."
"confirmed": {
"type": "boolean",
"description": "Whether the agent has confirmed their email address."
},
"email": {
"type": "string",
"description": "The email of the agent"
},
"available_name": {
"type": "string",
"description": "The available name of the agent"
},
"name": {
"type": "string",
"description": "The name of the agent"
},
"role": {
"type": "string",
"enum": [
"agent",
"administrator"
],
"description": "The role of the agent"
},
"thumbnail": {
"type": "string",
"description": "The thumbnail of the agent"
},
"custom_role_id": {
"type": "integer",
"description": "The custom role id of the agent"
}
}
},
@@ -8081,13 +8138,33 @@
"type": "string",
"description": "The description about the agent bot"
},
"account_id": {
"type": "number",
"description": "Account ID if it's an account specific bot"
"thumbnail": {
"type": "string",
"description": "The thumbnail of the agent bot"
},
"outgoing_url": {
"type": "string",
"description": "The webhook URL for the bot"
},
"bot_type": {
"type": "string",
"description": "The type of the bot"
},
"bot_config": {
"type": "object",
"description": "The configuration of the bot"
},
"account_id": {
"type": "number",
"description": "Account ID if it's an account specific bot"
},
"access_token": {
"type": "string",
"description": "The access token for the bot"
},
"system_bot": {
"type": "boolean",
"description": "Whether the bot is a system bot"
}
}
},
@@ -10370,31 +10447,6 @@
}
}
},
"tags": [
"Accounts",
"Account Users",
"AgentBots",
"Users",
"Account AgentBots",
"Agents",
"Canned Responses",
"Contacts",
"Conversations",
"Custom Attributes",
"Custom Filters",
"Inboxes",
"Integrations",
"Messages",
"Profile",
"Reports",
"Teams",
"Webhooks",
"Automation Rule",
"Help Center",
"Contacts API",
"Conversations API",
"Messages API"
],
"x-tagGroups": [
{
"name": "Platform",