freshworks Channels API

openapi: 3.2.0
info:
  title: Freshworks Freshchat Channels API
  description: The Freshchat API provides programmatic access to the Freshchat messaging platform for managing customer conversations and engagement. It supports operations for conversations, messages, agents, channels, and users. The API enables developers to automate customer communication workflows, integrate Freshchat with external systems, and build custom messaging solutions on top of the Freshchat platform. Authentication is handled via API tokens obtained from the Freshchat admin panel.
  version: '2.0'
  contact:
    name: Freshworks Support
    url: https://support.freshchat.com/
  termsOfService: https://www.freshworks.com/terms/
servers:
- url: https://{domain}.freshchat.com/v2
  description: Freshchat Production Server (Standalone)
  variables:
    domain:
      default: yourdomain
      description: Your Freshchat account name
- url: https://{domain}.myfreshworks.com/v2
  description: Freshchat Production Server (Freshsales Suite)
  variables:
    domain:
      default: yourdomain
      description: Your Freshworks bundle alias
security:
- bearerAuth: []
tags:
- name: Channels
  description: Manage messaging channels and their configurations.
paths:
  /channels:
    get:
      operationId: listChannels
      summary: List all channels
      description: Retrieves a list of all messaging channels configured in the Freshchat account.
      tags:
      - Channels
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  channels:
                    type: array
                    items:
                      $ref: '#/components/schemas/Channel'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /channels/{channel_id}:
    get:
      operationId: getChannel
      summary: View a channel
      description: Retrieves the details of a specific messaging channel.
      tags:
      - Channels
      parameters:
      - name: channel_id
        in: path
        required: true
        description: The ID of the channel.
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Channel'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Human-readable error message.
    Channel:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of the channel.
        name:
          type: string
          description: Name of the channel.
        icon:
          type: object
          description: Channel icon details.
          properties:
            url:
              type: string
              format: uri
              description: URL of the icon image.
        enabled:
          type: boolean
          description: Whether the channel is enabled.
        public:
          type: boolean
          description: Whether the channel is public.
        welcome_message:
          type: object
          description: Welcome message configuration.
          properties:
            message_parts:
              type: array
              items:
                type: object
                properties:
                  text:
                    type: object
                    properties:
                      content:
                        type: string
                        description: Welcome message text.
        updated_time:
          type: string
          format: date-time
          description: Timestamp when the channel was last updated.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication. Obtain the API token from the Freshchat admin settings panel.
externalDocs:
  description: Freshchat API Documentation
  url: https://developers.freshchat.com/api/