Tessell Conversation API

The Conversation API from Tessell — 3 operation(s) for conversation.

OpenAPI Specification

tessell-conversation-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Tessell APIs activity-center Conversation API
  contact:
    email: support@tessell.com
    name: Tessell Inc
    url: https://www.tessell.com
  description: Tessell API Documentation
  termsOfService: https://www.tessell.com/terms
  version: '1.0'
servers:
- url: '{server}'
  variables:
    server:
      default: console.tessell.com
tags:
- name: Conversation
paths:
  /tickets/v2/{id}/conversations:
    get:
      summary: ticket's conversation
      description: Get conversations for a ticket
      tags:
      - Conversation
      operationId: getTicketConversationsV2
      parameters:
      - name: id
        in: path
        description: Id of the ticket
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketConversationResponseV2'
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /tickets/v2/{id}/reply:
    post:
      summary: Post ticket reply
      description: Post a ticket reply for a ticket with the given id
      tags:
      - Conversation
      operationId: postReplyV2
      parameters:
      - name: id
        in: path
        description: Id of the ticket
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request body to post reply
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ReplyTicketRequestBodyV2'
      responses:
        '200':
          description: OK
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
  /tickets/v2/{id}/notes:
    post:
      summary: Post ticket notes
      description: Post a ticket note for a ticket with the given id
      tags:
      - Conversation
      operationId: postNotesV2
      parameters:
      - name: id
        in: path
        description: Id of the ticket
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Authorization Token
        required: true
        style: simple
        schema:
          type: string
      requestBody:
        description: Request body to post notes
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NoteTicketRequestBodyV2'
      responses:
        '200':
          description: OK
        default:
          description: API error response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    ApiError:
      type: object
      description: Common error response object for non 2xx responses
      properties:
        code:
          type: string
          description: Status code for the error response
        message:
          type: string
          description: Error message for API response
        resolution:
          type: string
        timestamp:
          type: string
          format: date-time
        contextId:
          type: string
          description: ContextId of API request
        sessionId:
          type: string
          description: SessionId of API request
        tessellErrorCode:
          type: string
          description: Unique error code specific to Tessell
    TicketConversationResponseV2:
      title: Ticket Conversation Response
      description: array of conversations
      type: array
      items:
        $ref: '#/components/schemas/ConversationDTOV2'
    ConversationDTOV2:
      title: Ticket conversation
      type: object
      description: Ticket conversation DTO
      properties:
        id:
          type: integer
          format: int64
          description: Conversation identifier
        attachments:
          type: array
          description: Get conversation attachments
          items:
            $ref: '#/components/schemas/AttachmentDTO'
        body:
          type: string
          description: conversation body
        created_at:
          type: string
          format: date-time
          description: conversation creation date
        updated_at:
          type: string
          format: date-time
          description: conversation last updated
        name:
          type: string
          description: user who made this conversation
    ReplyTicketRequestBodyV2:
      title: Reply to ticket body
      type: object
      description: Reply to ticket body
      properties:
        body:
          type: string
          description: reply body
        attachments:
          type: array
          description: File content
          items:
            type: string
            format: binary
    AttachmentDTO:
      title: Ticket conversation attachment
      type: object
      description: Conversation attachment
      properties:
        attachment_url:
          type: string
          description: attachment url
        content_type:
          type: string
          description: attachment content type
        id:
          type: integer
          format: int64
          description: attachment identifier
        name:
          type: string
          description: attachment name
        size:
          type: integer
          format: int64
          description: attachment size
    NoteTicketRequestBodyV2:
      title: Note to ticket body
      type: object
      description: Note to ticket body
      properties:
        body:
          type: string
          description: reply body
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer