Restructure omni services and add Chatwoot research snapshot
This commit is contained in:
6
research/chatwoot/swagger/parameters/account_id.yml
Normal file
6
research/chatwoot/swagger/parameters/account_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: account_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the account
|
||||
6
research/chatwoot/swagger/parameters/agent_bot_id.yml
Normal file
6
research/chatwoot/swagger/parameters/agent_bot_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The ID of the agentbot to be updated
|
||||
15
research/chatwoot/swagger/parameters/contact_sort.yml
Normal file
15
research/chatwoot/swagger/parameters/contact_sort.yml
Normal file
@@ -0,0 +1,15 @@
|
||||
in: query
|
||||
name: sort
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- name
|
||||
- email
|
||||
- phone_number
|
||||
- last_activity_at
|
||||
- -name
|
||||
- -email
|
||||
- -phone_number
|
||||
- -last_activity_at
|
||||
required: false
|
||||
description: The attribute by which list should be sorted
|
||||
6
research/chatwoot/swagger/parameters/conversation_id.yml
Normal file
6
research/chatwoot/swagger/parameters/conversation_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: conversation_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the conversation
|
||||
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: conversation_uuid
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The uuid of the conversation
|
||||
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: custom_filter_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the custom filter
|
||||
6
research/chatwoot/swagger/parameters/hook_id.yml
Normal file
6
research/chatwoot/swagger/parameters/hook_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: hook_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the integration hook
|
||||
6
research/chatwoot/swagger/parameters/inbox_id.yml
Normal file
6
research/chatwoot/swagger/parameters/inbox_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: inbox_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The ID of the Inbox
|
||||
56
research/chatwoot/swagger/parameters/index.yml
Normal file
56
research/chatwoot/swagger/parameters/index.yml
Normal file
@@ -0,0 +1,56 @@
|
||||
account_id:
|
||||
$ref: ./account_id.yml
|
||||
|
||||
agent_bot_id:
|
||||
$ref: ./agent_bot_id.yml
|
||||
|
||||
team_id:
|
||||
$ref: ./team_id.yml
|
||||
|
||||
inbox_id:
|
||||
$ref: ./inbox_id.yml
|
||||
|
||||
hook_id:
|
||||
$ref: ./hook_id.yml
|
||||
|
||||
source_id:
|
||||
$ref: ./source_id.yml
|
||||
|
||||
contact_sort_param:
|
||||
$ref: ./contact_sort.yml
|
||||
|
||||
conversation_id:
|
||||
$ref: ./conversation_id.yml
|
||||
|
||||
conversation_uuid:
|
||||
$ref: ./conversation_uuid.yml
|
||||
|
||||
custom_filter_id:
|
||||
$ref: ./custom_filter_id.yml
|
||||
|
||||
webhook_id:
|
||||
$ref: ./webhook_id.yml
|
||||
|
||||
message_id:
|
||||
$ref: ./message_id.yml
|
||||
|
||||
page:
|
||||
$ref: ./page.yml
|
||||
|
||||
platform_user_id:
|
||||
$ref: ./platform_user_id.yml
|
||||
|
||||
report_type:
|
||||
$ref: ./report_type.yml
|
||||
|
||||
report_metric:
|
||||
$ref: ./report_metric.yml
|
||||
|
||||
public_inbox_identifier:
|
||||
$ref: ./public/inbox_identifier.yml
|
||||
|
||||
public_contact_identifier:
|
||||
$ref: ./public/contact_identifier.yml
|
||||
|
||||
portal_id:
|
||||
$ref: ./portal_id.yml
|
||||
6
research/chatwoot/swagger/parameters/message_id.yml
Normal file
6
research/chatwoot/swagger/parameters/message_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: message_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the message
|
||||
7
research/chatwoot/swagger/parameters/page.yml
Normal file
7
research/chatwoot/swagger/parameters/page.yml
Normal file
@@ -0,0 +1,7 @@
|
||||
in: query
|
||||
name: page
|
||||
schema:
|
||||
type: integer
|
||||
default: 1
|
||||
required: false
|
||||
description: The page parameter
|
||||
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the user on the platform
|
||||
6
research/chatwoot/swagger/parameters/portal_id.yml
Normal file
6
research/chatwoot/swagger/parameters/portal_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: id
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The slug identifier of the portal
|
||||
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: contact_identifier
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The source id of contact obtained on contact create
|
||||
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: inbox_identifier
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The identifier obtained from API inbox channel
|
||||
13
research/chatwoot/swagger/parameters/report_metric.yml
Normal file
13
research/chatwoot/swagger/parameters/report_metric.yml
Normal file
@@ -0,0 +1,13 @@
|
||||
in: query
|
||||
name: metric
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- conversations_count
|
||||
- incoming_messages_count
|
||||
- outgoing_messages_count
|
||||
- avg_first_response_time
|
||||
- avg_resolution_time
|
||||
- resolutions_count
|
||||
required: true
|
||||
description: The type of metric
|
||||
12
research/chatwoot/swagger/parameters/report_type.yml
Normal file
12
research/chatwoot/swagger/parameters/report_type.yml
Normal file
@@ -0,0 +1,12 @@
|
||||
in: query
|
||||
name: type
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- account
|
||||
- agent
|
||||
- inbox
|
||||
- label
|
||||
- team
|
||||
required: true
|
||||
description: Type of report
|
||||
6
research/chatwoot/swagger/parameters/source_id.yml
Normal file
6
research/chatwoot/swagger/parameters/source_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: source_id
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
description: "Id of the session for which the conversation is created.\n\n\n\n Source Ids can be obtained through contactable inboxes API or via generated.<br/><br/>Website: Chatwoot generated string which can be obtained from webhook events. <br/> Phone Channels(Twilio): Phone number in e164 format <br/> Email Channels: Contact Email address <br/> API Channel: Any Random String"
|
||||
6
research/chatwoot/swagger/parameters/team_id.yml
Normal file
6
research/chatwoot/swagger/parameters/team_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: team_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The ID of the team to be updated
|
||||
6
research/chatwoot/swagger/parameters/webhook_id.yml
Normal file
6
research/chatwoot/swagger/parameters/webhook_id.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
in: path
|
||||
name: webhook_id
|
||||
schema:
|
||||
type: integer
|
||||
required: true
|
||||
description: The numeric ID of the webhook
|
||||
Reference in New Issue
Block a user