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: properties:
id: id:
type: integer type: integer
uid:
type: string
name:
type: string
available_name:
type: string
display_name:
type: string
email:
type: string
account_id: account_id:
type: integer type: integer
role:
type: string
enum: ['agent', 'administrator']
confirmed:
type: boolean
availability_status: availability_status:
type: string type: string
enum: ['available', 'busy', 'offline'] enum: ['available', 'busy', 'offline']
@@ -26,6 +11,25 @@ properties:
auto_offline: auto_offline:
type: boolean type: boolean
description: Whether the availability status of agent is configured to go offline automatically when away. description: Whether the availability status of agent is configured to go offline automatically when away.
custom_attributes: confirmed:
type: object type: boolean
description: Available for users who are created through platform APIs and has custom attributes associated. 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: description:
type: string type: string
description: The description about the agent bot description: The description about the agent bot
account_id: thumbnail:
type: number type: string
description: Account ID if it's an account specific bot description: The thumbnail of the agent bot
outgoing_url: outgoing_url:
type: string type: string
description: The webhook URL for the bot 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 type: object
properties: properties:
event_name: payload:
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 type: array
description: Array of actions which we perform when condition matches
items: items:
type: object type: object
example: properties:
action_name: add_label id:
action_params: type: integer
- support description: The ID of the automation rule
- sales event_name:
conditions: type: string
type: array description: Automation Rule event, on which we call the actions(conversation_created, conversation_updated, message_created)
description: Array of conditions on which conversation/message filter would work enum:
items: - conversation_created
type: object - conversation_updated
example: - message_created
attribute_key: content example: message_created
filter_operator: contains name:
values: type: string
- help description: The name of the rule
query_operator: nil example: Add label on message create event
account_id: description:
type: integer type: string
description: Account Id 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: id:
type: integer type: integer
description: ID of the canned response 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: account_id:
type: integer type: integer
description: Account Id 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 type: object
properties: properties:
payload: payload:
type: object type: array
properties: items:
contact: type: object
type: object properties:
properties: additional_attributes:
email: type: object
type: string description: The object containing additional attributes related to the contact
description: Email address of the contact availability_status:
name: type: string
type: string description: The availability status of the contact
description: The name of the contact email:
phone_number: type: string
type: string description: The email address of the contact
description: Phone number of the contact id:
thumbnail: type: integer
type: string description: The ID of the contact
description: Avatar URL of the contact name:
additional_attributes: type: string
type: object description: The name of the contact
description: The object containing additional attributes related to the contact phone_number:
custom_attributes: type: string
type: object description: The phone number of the contact
description: The object to save custom attributes for contact, accepts custom attributes key and value blocked:
example: type: boolean
{ attribute_key: attribute_value, signed_up_at: dd/mm/yyyy } description: Whether the contact is blocked
contact_inboxes: identifier:
type: array type: string
items: description: The identifier of the contact
$ref: '#/components/schemas/contact_inboxes' 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: attribute_key:
type: string type: string
description: Attribute unique key value description: Attribute unique key value
regex_pattern:
type: string
description: Regex pattern
regex_cue:
type: string
description: Regex cue
attribute_values: attribute_values:
type: string type: string
description: Attribute values description: Attribute values
default_value:
type: string
description: Attribute default value
attribute_model: attribute_model:
type: string type: string
description: Attribute type(conversation_attribute/contact_attribute) description: Attribute type(conversation_attribute/contact_attribute)
account_id: default_value:
type: integer type: string
description: Account Id 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 type: object
properties: properties:
id:
type: number
description: The ID of the message
content: content:
type: string type: string
description: The text content of the message description: The text content of the message
content_type: account_id:
type: string type: number
enum: ["text", "input_select", "cards", "form"] description: The ID of the account
description: The type of the template message inbox_id:
content_attributes: type: number
type: object description: The ID of the inbox
description: The content attributes for each content_type conversation_id:
type: number
description: The ID of the conversation
message_type: message_type:
type: string type: string
enum: ["incoming", "outgoing", "activity", "template"] enum: ["incoming", "outgoing", "activity", "template"]
@@ -17,15 +22,51 @@ properties:
created_at: created_at:
type: integer type: integer
description: The time at which message was created description: The time at which message was created
updated_at:
type: integer
description: The time at which message was updated
private: private:
type: boolean type: boolean
description: The flags which shows whether the message is private or not 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: attachment:
type: object type: object
description: The file object attached to the image description: The file object attached to the image
sender: sender:
type: object type: object
description: User/Agent/AgentBot 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", "type": "integer",
"description": "ID of the canned response" "description": "ID of the canned response"
}, },
"content": { "account_id": {
"type": "string", "type": "integer",
"description": "Message content for canned response" "description": "Account Id"
}, },
"short_code": { "short_code": {
"type": "string", "type": "string",
"description": "Short Code for quick access of the canned response" "description": "Short Code for quick access of the canned response"
}, },
"account_id": { "content": {
"type": "integer", "type": "string",
"description": "Account Id" "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", "type": "string",
"description": "Attribute unique key value" "description": "Attribute unique key value"
}, },
"regex_pattern": {
"type": "string",
"description": "Regex pattern"
},
"regex_cue": {
"type": "string",
"description": "Regex cue"
},
"attribute_values": { "attribute_values": {
"type": "string", "type": "string",
"description": "Attribute values" "description": "Attribute values"
}, },
"default_value": {
"type": "string",
"description": "Attribute default value"
},
"attribute_model": { "attribute_model": {
"type": "string", "type": "string",
"description": "Attribute type(conversation_attribute/contact_attribute)" "description": "Attribute type(conversation_attribute/contact_attribute)"
}, },
"account_id": { "default_value": {
"type": "integer", "type": "string",
"description": "Account Id" "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": { "automation_rule": {
"type": "object", "type": "object",
"properties": { "properties": {
"event_name": { "payload": {
"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", "type": "array",
"description": "Array of actions which we perform when condition matches",
"items": { "items": {
"type": "object", "type": "object",
"example": { "properties": {
"action_name": "add_label", "id": {
"action_params": [ "type": "integer",
"support", "description": "The ID of the automation rule"
"sales" },
] "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", "type": "object",
"properties": { "properties": {
"payload": { "payload": {
"type": "object", "type": "array",
"properties": { "items": {
"contact": { "type": "object",
"type": "object", "properties": {
"properties": { "additional_attributes": {
"email": { "type": "object",
"type": "string", "description": "The object containing additional attributes related to the contact"
"description": "Email address of the contact" },
}, "availability_status": {
"name": { "type": "string",
"type": "string", "description": "The availability status of the contact"
"description": "The name of the contact" },
}, "email": {
"phone_number": { "type": "string",
"type": "string", "description": "The email address of the contact"
"description": "Phone number of the contact" },
}, "id": {
"thumbnail": { "type": "integer",
"type": "string", "description": "The ID of the contact"
"description": "Avatar URL of the contact" },
}, "name": {
"additional_attributes": { "type": "string",
"type": "object", "description": "The name of the contact"
"description": "The object containing additional attributes related to the contact" },
}, "phone_number": {
"custom_attributes": { "type": "string",
"type": "object", "description": "The phone number of the contact"
"description": "The object to save custom attributes for contact, accepts custom attributes key and value", },
"example": { "blocked": {
"attribute_key": "attribute_value", "type": "boolean",
"signed_up_at": "dd/mm/yyyy" "description": "Whether the contact is blocked"
} },
}, "identifier": {
"contact_inboxes": { "type": "string",
"type": "array", "description": "The identifier of the contact"
"items": { },
"$ref": "#/components/schemas/contact_inboxes" "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": { "id": {
"type": "integer" "type": "integer"
}, },
"uid": {
"type": "string"
},
"name": {
"type": "string"
},
"available_name": {
"type": "string"
},
"display_name": {
"type": "string"
},
"email": {
"type": "string"
},
"account_id": { "account_id": {
"type": "integer" "type": "integer"
}, },
"role": {
"type": "string",
"enum": [
"agent",
"administrator"
]
},
"confirmed": {
"type": "boolean"
},
"availability_status": { "availability_status": {
"type": "string", "type": "string",
"enum": [ "enum": [
@@ -8003,9 +8032,37 @@
"type": "boolean", "type": "boolean",
"description": "Whether the availability status of agent is configured to go offline automatically when away." "description": "Whether the availability status of agent is configured to go offline automatically when away."
}, },
"custom_attributes": { "confirmed": {
"type": "object", "type": "boolean",
"description": "Available for users who are created through platform APIs and has custom attributes associated." "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", "type": "string",
"description": "The description about the agent bot" "description": "The description about the agent bot"
}, },
"account_id": { "thumbnail": {
"type": "number", "type": "string",
"description": "Account ID if it's an account specific bot" "description": "The thumbnail of the agent bot"
}, },
"outgoing_url": { "outgoing_url": {
"type": "string", "type": "string",
"description": "The webhook URL for the bot" "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": [ "x-tagGroups": [
{ {
"name": "Platform", "name": "Platform",