openapi: 3.1.0
info:
  title: Helpcenter IMCannedMessage API
  version: 1.0.0
tags:
- name: IMCannedMessage
paths:
  /api/v1/im/cannedMessages/{id}:
    get:
      tags:
      - IMCannedMessage
      summary: Get a Template Message
      description: This API fetches details of a template message.
      operationId: getCannedMessage
      parameters:
      - $ref: '#/components/parameters/id'
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '404':
          $ref: ./Common.json#/components/responses/urlNotFoundErrorResponse
        '200':
          $ref: '#/components/responses/getCannedMessage'
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '400':
          $ref: ./Common.json#/components/responses/badRequestErrorResponse
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.InstantMessages.READ
      x-audience:
      - external-public
  /api/v1/im/cannedMessages:
    get:
      tags:
      - IMCannedMessage
      summary: List Template Message
      description: This API lists all sessions
      operationId: getCannedMessages
      parameters:
      - name: modifiedAfter
        in: query
        description: After which date entities to be included. Enter a date in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ.
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          description: After which date entities to be included. Enter a date in the ISO date format of yyyy-MM-ddThh:mm:ss.SSSZ.
          maxLength: 100
          minLength: 0
          pattern: (((19|20)\d\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\d]{0,3})?(Z))
      - $ref: '#/components/parameters/contactId'
      - name: departmentId
        in: query
        description: Department ID for which the canned messages to be fetched
        required: true
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int64
          description: Department ID for which the canned messages to be fetched
          pattern: ([0-9]+)
      - name: limit
        in: query
        description: Number of canned messages to fetch
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int32
          description: Number of canned messages to fetch
          pattern: ([0-9]+)
      - name: from
        in: query
        description: Index number, starting from which the canned messages must be fetched
        required: false
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          - integer
          format: int32
          description: Index number, starting from which the canned messages must be fetched
          pattern: ([0-9]+)
      - name: type
        in: query
        description: Filter by MessageType. Allowed values are @TEMPLATE@
        required: true
        style: form
        explode: true
        schema:
          type:
          - string
          - 'null'
          description: Filter by MessageType. Allowed values are @TEMPLATE@
          enum:
          - TEMPLATE
          - CANNED
          - WELCOMEMSG
          - AWAY
          maxLength: 100
          minLength: 0
      - name: isActive
        in: query
        description: Canned Message Active Status
        required: false
        style: form
        explode: true
        schema:
          type:
          - boolean
          - 'null'
          description: Canned Message Active Status
      - $ref: ./Common.json#/components/parameters/orgId
      responses:
        '422':
          $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse
        '204':
          $ref: ./Common.json#/components/responses/emptyResponse
        '200':
          $ref: '#/components/responses/getCannedMessages'
      security:
      - iam-oauth2-schema:
        - Desk.basic.READ
        - Desk.InstantMessages.READ
      x-audience:
      - external-public
components:
  parameters:
    id:
      name: id
      in: path
      required: true
      style: simple
      explode: false
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        pattern: ([0-9]+)
    contactId:
      name: contactId
      in: query
      description: Contact id for which the canned message has to be applied
      required: true
      style: form
      explode: true
      schema:
        type:
        - string
        - 'null'
        - integer
        format: int64
        description: Contact id for which the canned message has to be applied
        pattern: ([0-9]+)
  responses:
    getCannedMessage:
      description: getCannedMessage template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              actor:
                $ref: ./IMCannedMessage.json#/components/schemas/cannedMessageActor
              modifiedTime:
                type:
                - string
                - 'null'
                maxLength: 100
                minLength: 0
              displayMessage:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
              translations:
                $ref: ./IMCannedMessage.json#/components/schemas/listOfCannedMessageTranslations
              departmentId:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              id:
                type:
                - string
                - 'null'
                - integer
                format: int64
                pattern: ([0-9]+)
              title:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
              message:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
              type:
                type:
                - string
                - 'null'
                enum:
                - TEMPLATE
                - CANNED
                - WELCOMEMSG
                - AWAY
                maxLength: 100
                minLength: 0
              isActive:
                type:
                - boolean
                - 'null'
              tags:
                type:
                - string
                - 'null'
                maxLength: 65535
                minLength: 0
              status:
                type:
                - string
                - 'null'
                enum:
                - SUBMITTED
                - FAILED
                - APPROVED
                - REJECTED
                - PENDING
                maxLength: 100
                minLength: 0
            required:
            - actor
            - departmentId
            - displayMessage
            - id
            - isActive
            - message
            - modifiedTime
            - status
            - tags
            - title
            - translations
            - type
          examples:
            Valid responses Definitions:
              value: null
    getCannedMessages:
      description: getCannedMessages template definitions
      content:
        application/json:
          schema:
            type:
            - 'null'
            - object
            additionalProperties: false
            properties:
              data:
                $ref: ./IMCannedMessage.json#/components/schemas/listofCannedMessages
              hasMore:
                type:
                - boolean
                - 'null'
            required:
            - data
            - hasMore
          examples:
            Valid responses Definitions:
              value:
                data:
                - modifiedTime: 1711085762000
                  departmentId: '186543000000006907'
                  title: fb marketing
                  message: Welcome to Tasty Bakery. What would you like to eat?
                  type: TEMPLATE
                  isActive: true
                  tags: MARKETING
                  actor:
                    photoURL: https://desk.zoho.com/api/v1/agents/186543000000190001/photo?orgId=78412359
                    name: Abhishek Aich
                    id: '186543000000190001'
                    type: AGENT
                    email: zykler@sales.com
                  wabaId: '102086489526176'
                  displayMessage: Welcome to Tasty Bakery. What would you like to eat?
                  translations:
                  - displayMessage: Welcome to Tasty Bakery. What would you like to eat?
                    templateItems:
                      buttons:
                      - action: null
                        type: QUICK_REPLY
                        message: Cakes
                      - action: null
                        type: QUICK_REPLY
                        message: pizza
                      footer: null
                      header: null
                    language: en
                    id: '3942000001074177'
                    message: Welcome to Tasty Bakery. What would you like to eat?
                    rejectionReason: null
                    status: APPROVED
                  id: '3942000001074175'
                  status: APPROVED
                - modifiedTime: 1711085753000
                  departmentId: '186543000000006907'
                  title: Rice Marketing
                  message: Hello please select our new rice items
                  type: TEMPLATE
                  isActive: true
                  tags: MARKETING
                  actor:
                    photoURL: https://desk.zoho.com/api/v1/agents/186543000000190001/photo?orgId=78412359
                    name: Abhishek Aich
                    id: '186543000000190001'
                    type: AGENT
                    email: zykler@sales.com
                  wabaId: '102086489526176'
                  displayMessage: Hello please select our new rice items
                  translations:
                  - displayMessage: Hello please select our new rice items
                    templateItems:
                      buttons:
                      - action: null
                        type: QUICK_REPLY
                        message: Boiled Rice
                      - action: null
                        type: QUICK_REPLY
                        message: Rice Cake
                      - action: null
                        type: QUICK_REPLY
                        message: Fried Rice
                      footer: null
                      header:
                        attachment: null
                        type: TEXT
                        message: Welcome Back
                    language: en
                    id: '3942000001423160'
                    message: Hello please select our new rice items
                    rejectionReason: null
                    status: APPROVED
                  id: '3942000001423158'
                  status: APPROVED
                - modifiedTime: 1711082873000
                  departmentId: '186543000000006907'
                  title: Whatsapp marketing
                  message: 'Welcome to Tasty Bakery. What would you like to eat?

                    Here are our new products'
                  type: TEMPLATE
                  isActive: true
                  tags: UTILITY
                  actor:
                    photoURL: https://desk.zoho.com/api/v1/agents/186543000000190001/photo?orgId=78412359
                    name: Abhishek Aich
                    id: '186543000000190001'
                    type: AGENT
                    email: zykler@sales.com
                  wabaId: '102086489526176'
                  displayMessage: 'Welcome to Tasty Bakery. What would you like to eat?

                    Here are our new products'
                  translations:
                  - displayMessage: 'Welcome to Tasty Bakery. What would you like to eat?

                      Here are our new products'
                    templateItems:
                      buttons:
                      - action: null
                        type: QUICK_REPLY
                        message: Croissants
                      - action: null
                        type: QUICK_REPLY
                        message: Pizza
                      footer: null
                      header: null
                    language: en
                    id: '3942000001262607'
                    message: 'Welcome to Tasty Bakery. What would you like to eat?

                      Here are our new products'
                    rejectionReason: null
                    status: APPROVED
                  id: '3942000001262605'
                  status: APPROVED
                hasMore: false
  securitySchemes:
    iam-oauth2-schema:
      $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema
x-entity: Helpcenter