2020-02-23 19:21:31 +00:00
|
|
|
get:
|
2020-03-03 19:11:21 +00:00
|
|
|
tags:
|
|
|
|
|
- Conversation
|
|
|
|
|
operationId: conversationList
|
2020-02-23 19:21:31 +00:00
|
|
|
description: List all the conversations with pagination
|
|
|
|
|
summary: Conversations List
|
|
|
|
|
parameters:
|
2021-05-11 14:50:52 +00:00
|
|
|
- $ref: '#/parameters/account_id'
|
2020-03-11 10:49:13 +00:00
|
|
|
- name: assignee_type
|
2020-02-23 19:21:31 +00:00
|
|
|
in: query
|
|
|
|
|
type: string
|
2020-03-11 10:49:13 +00:00
|
|
|
enum: ['me', 'unassigned', 'all']
|
|
|
|
|
required: true
|
|
|
|
|
- name: status
|
|
|
|
|
in: query
|
|
|
|
|
type: string
|
|
|
|
|
enum: ['open', 'resolved', 'bot']
|
|
|
|
|
required: true
|
|
|
|
|
- name: page
|
|
|
|
|
in: query
|
|
|
|
|
type: integer
|
|
|
|
|
required: true
|
|
|
|
|
- name: inbox_id
|
|
|
|
|
in: query
|
|
|
|
|
type: integer
|
|
|
|
|
- name: labels
|
|
|
|
|
in: query
|
|
|
|
|
type: array
|
|
|
|
|
items:
|
|
|
|
|
type: string
|
|
|
|
|
|
2020-02-23 19:21:31 +00:00
|
|
|
responses:
|
|
|
|
|
200:
|
|
|
|
|
description: Success
|
|
|
|
|
schema:
|
|
|
|
|
$ref: '#/definitions/conversation_list'
|
|
|
|
|
400:
|
|
|
|
|
description: Bad Request Error
|
|
|
|
|
schema:
|
|
|
|
|
$ref: '#/definitions/bad_request_error'
|
2020-04-10 11:12:37 +00:00
|
|
|
description: Access denied
|
|
|
|
|
|
2020-09-23 09:57:41 +00:00
|
|
|
get:
|
|
|
|
|
tags:
|
|
|
|
|
- Conversation
|
|
|
|
|
operationId: conversationSearch
|
|
|
|
|
description: Search for conversations containing a messages with the query string
|
|
|
|
|
summary: Conversations Search
|
|
|
|
|
parameters:
|
|
|
|
|
- name: q
|
|
|
|
|
in: query
|
|
|
|
|
type: string
|
|
|
|
|
- name: assignee_type
|
|
|
|
|
in: query
|
|
|
|
|
type: string
|
|
|
|
|
enum: ['me', 'unassigned', 'all']
|
|
|
|
|
- name: status
|
|
|
|
|
in: query
|
|
|
|
|
type: string
|
|
|
|
|
enum: ['open', 'resolved', 'bot']
|
|
|
|
|
- name: page
|
|
|
|
|
in: query
|
|
|
|
|
type: integer
|
|
|
|
|
- name: inbox_id
|
|
|
|
|
in: query
|
|
|
|
|
type: integer
|
|
|
|
|
- name: labels
|
|
|
|
|
in: query
|
|
|
|
|
type: array
|
|
|
|
|
items:
|
|
|
|
|
type: string
|
2021-05-11 14:50:52 +00:00
|
|
|
- $ref: '#/parameters/account_id'
|
2020-09-23 09:57:41 +00:00
|
|
|
|
|
|
|
|
responses:
|
|
|
|
|
200:
|
|
|
|
|
description: Success
|
|
|
|
|
schema:
|
|
|
|
|
$ref: '#/definitions/conversation_list'
|
|
|
|
|
400:
|
|
|
|
|
description: Bad Request Error
|
|
|
|
|
schema:
|
|
|
|
|
$ref: '#/definitions/bad_request_error'
|
|
|
|
|
description: Access denied
|
|
|
|
|
|
|
|
|
|
|
2020-04-10 11:12:37 +00:00
|
|
|
post:
|
|
|
|
|
tags:
|
|
|
|
|
- Conversation
|
|
|
|
|
operationId: newConversation
|
|
|
|
|
summary: Create New Conversation
|
|
|
|
|
description: Create conversation
|
2020-06-25 18:05:16 +00:00
|
|
|
security:
|
|
|
|
|
- userApiKey: []
|
|
|
|
|
- agentBotApiKey: []
|
2020-04-10 11:12:37 +00:00
|
|
|
parameters:
|
2021-05-11 14:50:52 +00:00
|
|
|
- $ref: '#/parameters/account_id'
|
2020-04-10 11:12:37 +00:00
|
|
|
- name: data
|
|
|
|
|
in: body
|
|
|
|
|
required: true
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
|
|
|
|
properties:
|
|
|
|
|
source_id:
|
|
|
|
|
type: string
|
|
|
|
|
description: Contact Source Id
|
2021-01-07 08:17:38 +00:00
|
|
|
additional_attributes:
|
|
|
|
|
type: object
|
|
|
|
|
description: Lets you specify attributes like browser information
|
2020-04-10 11:12:37 +00:00
|
|
|
|
|
|
|
|
responses:
|
|
|
|
|
200:
|
|
|
|
|
description: Success
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
|
|
|
|
properties:
|
|
|
|
|
id:
|
|
|
|
|
type: number
|
|
|
|
|
description: ID of the conversation
|
|
|
|
|
account_id:
|
|
|
|
|
type: number
|
|
|
|
|
description: Account Id
|
|
|
|
|
inbox_id:
|
|
|
|
|
type: number
|
|
|
|
|
description: ID of the inbox
|
|
|
|
|
403:
|
|
|
|
|
description: Access denied
|
