openapi: 3.1.0 info: title: Helpcenter IM_Channel API version: 1.0.0 tags: - name: IM_Channel paths: /api/v1/im/channels/{id}: get: tags: - IM_Channel summary: Get a Channel description: This API fetches details of an channel. operationId: getIMChannel parameters: - name: include in: query description: Additional information related to the channel. Allowed values are @preference@, @creator@ required: false style: simple explode: true schema: type: - 'null' - array description: Additional information related to the channel. Allowed values are @preference@, @creator@ items: type: - string - 'null' enum: - preference - creator maxLength: 100 minLength: 0 maxItems: 2 uniqueItems: true - $ref: '#/components/parameters/id' - $ref: ./Common.json#/components/parameters/orgId responses: '404': $ref: ./Common.json#/components/responses/urlNotFoundErrorResponse '200': $ref: '#/components/responses/getIMChannel' '422': $ref: ./Common.json#/components/responses/multipleUnprocessEntityResponse '400': $ref: ./Common.json#/components/responses/badRequestErrorResponse '403': $ref: ./Common.json#/components/responses/forbiddenErrorResponse security: - iam-oauth2-schema: - Desk.basic.READ - Desk.InstantMessages.READ x-audience: - external-public /api/v1/im/channels: get: tags: - IM_Channel summary: List Channels description: This API lists all channels operationId: getIMChannelsList parameters: - name: include in: query description: Additional information related to the channels.If passed in the param, then these values will be appended in the channel response. Allowed values are @preference@,@creator@,@meta@,@configParams@ required: false style: simple explode: true schema: type: - 'null' - array description: Additional information related to the channels.If passed in the param, then these values will be appended in the channel response. Allowed values are @preference@,@creator@,@meta@,@configParams@ items: type: - string - 'null' enum: - preference - creator maxLength: 100 minLength: 0 maxItems: 2 uniqueItems: true - name: departmentId in: query description: Department Id for which channels to be fetched required: false style: form explode: true schema: type: - string - 'null' - integer format: int64 description: Department Id for which channels to be fetched pattern: ([0-9]+) - $ref: '#/components/parameters/integrationServiceId' - $ref: ./Common.json#/components/parameters/orgId responses: '204': $ref: ./Common.json#/components/responses/emptyResponse '200': $ref: '#/components/responses/getIMChannelsList' security: - iam-oauth2-schema: - Desk.basic.READ - Desk.InstantMessages.READ x-audience: - external-public components: responses: getIMChannel: description: getIMChannel template definitions content: application/json: schema: type: - 'null' - object additionalProperties: false properties: defaultBotId: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) code: type: - string - 'null' maxLength: 100 minLength: 0 accountName: type: - string - 'null' maxLength: 500 minLength: 0 pattern: '[0-9a-zA-Z_\-\&\.\$\@\^\(\)\{\}\~\=\-\|\*\+\?\[\]\,\:\''\/\!\P{InBasicLatin}\s]+' integrationServiceType: type: - string - 'null' enum: - TELEGRAM - TWILIO - IM_TALK - LINE - WECHAT - WHATSAPP - FACEBOOKMESSENGER maxLength: 100 minLength: 0 appName: type: - string - 'null' maxLength: 100 minLength: 0 departmentId: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) universalLink: type: - string - 'null' maxLength: 65535 minLength: 0 pattern: (^(ht|f)tp(s?)\://[-.\w]*(/?)([a-zA-Z0-9\-\.\?\,\:\'/\\+=&%\$#_@]*)?$) isActive: type: - boolean - 'null' isAuthorizationPending: type: - boolean - 'null' photoURL: type: - string - 'null' maxLength: 65535 minLength: 0 pattern: (^(ht|f)tp(s?)\://[-.\w]*(/?)([a-zA-Z0-9\-\.\?\,\:\'/\\+=&%\$#_@]*)?$) isSubscribed: type: - boolean - 'null' configParams: $ref: ./IM_Channel.json#/components/schemas/listOfConfigParams isDeleted: type: - boolean - 'null' createdBy: type: - string - 'null' maxLength: 100 minLength: 0 pattern: '[0-9]+' isOwner: type: - boolean - 'null' isStorageEnabled: type: - boolean - 'null' conversationCount: type: - string - 'null' maxLength: 100 minLength: 0 pattern: '[0-9]+' meta: $ref: ./IM_Channel.json#/components/schemas/listOfChannelMeta name: type: - string - 'null' maxLength: 100 minLength: 0 pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+ createdTime: type: - string - 'null' 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)) authenticationURL: type: - string - 'null' maxLength: 100 minLength: 0 pattern: (^(ht|f)tp(s?)\://[-.\w]*(/?)([a-zA-Z0-9\-\.\?\,\:\'/\\+=&%\$#_@]*)?$) id: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) isSandBox: type: - boolean - 'null' required: - accountName - appName - authenticationURL - code - configParams - conversationCount - createdBy - createdTime - defaultBotId - departmentId - id - integrationServiceType - isActive - isAuthorizationPending - isDeleted - isOwner - isSandBox - isStorageEnabled - isSubscribed - meta - name - photoURL - universalLink examples: Valid responses Definitions: value: null getIMChannelsList: description: getIMChannelsList template definitions content: application/json: schema: allOf: - type: object properties: data: type: array items: type: object properties: creator: type: - 'null' - object additionalProperties: false maxProperties: 13 minProperties: 13 properties: lastName: type: - string - 'null' maxLength: 50 minLength: 0 agent: type: - boolean - 'null' displayName: type: - string - 'null' maxLength: 200 minLength: 0 pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+ externalId: type: - string - 'null' maxLength: 100 minLength: 0 emailId: type: - string - 'null' maxLength: 100 minLength: 0 pattern: ^[a-zA-Z0-9\_]([a-zA-Z0-9\_\+\-\.\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\-\_]*[a-zA-Z0-9])*)[\.])+[a-zA-Z]{2,22}$ type: type: - string - 'null' enum: - END_USER - AGENT - TEAM - TICKET - ACTIVITY maxLength: 100 minLength: 0 zuid: type: - string - 'null' - integer format: int32 pattern: ([0-9]+) photoURL: type: - string - 'null' maxLength: 200 minLength: 0 pattern: (^(ht|f)tp(s?)\://[-.\w]*(/?)([a-zA-Z0-9\-\.\?\,\:\'/\\+=&%\$#_@]*)?$) firstName: type: - string - 'null' maxLength: 50 minLength: 0 name: type: - string - 'null' maxLength: 100 minLength: 0 roleName: type: - string - 'null' maxLength: 100 minLength: 0 id: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) email: type: - string - 'null' maxLength: 100 minLength: 0 pattern: ^[a-zA-Z0-9\_]([a-zA-Z0-9\_\+\-\.\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\-\_]*[a-zA-Z0-9])*)[\.])+[a-zA-Z]{2,22}$ required: - agent - displayName - email - emailId - externalId - firstName - id - lastName - name - photoURL - roleName - type - zuid preference: type: - 'null' - object additionalProperties: false maxProperties: 8 minProperties: 8 properties: updatedBy: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) businessHourEnabled: type: - boolean - 'null' businessHourId: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) allHandlingAgents: type: - 'null' - array items: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) uniqueItems: false autoTicketConvertInterval: type: - string - 'null' maxLength: 100 minLength: 0 pattern: '[0-9]+' autoTicketConvert: type: - boolean - 'null' assignmentRuleEnabled: type: - boolean - 'null' updater: type: - 'null' - object additionalProperties: false maxProperties: 13 minProperties: 13 properties: lastName: type: - string - 'null' maxLength: 50 minLength: 0 agent: type: - boolean - 'null' displayName: type: - string - 'null' maxLength: 200 minLength: 0 pattern: ([0-9a-zA-Z_\-\.\$@\?\,\:\'\/\!\P{InBasicLatin}\s])+ externalId: type: - string - 'null' maxLength: 100 minLength: 0 emailId: type: - string - 'null' maxLength: 100 minLength: 0 pattern: ^[a-zA-Z0-9\_]([a-zA-Z0-9\_\+\-\.\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\-\_]*[a-zA-Z0-9])*)[\.])+[a-zA-Z]{2,22}$ type: type: - string - 'null' enum: - END_USER - AGENT - TEAM - TICKET - ACTIVITY maxLength: 100 minLength: 0 zuid: type: - string - 'null' - integer format: int32 pattern: ([0-9]+) photoURL: type: - string - 'null' maxLength: 200 minLength: 0 pattern: (^(ht|f)tp(s?)\://[-.\w]*(/?)([a-zA-Z0-9\-\.\?\,\:\'/\\+=&%\$#_@]*)?$) firstName: type: - string - 'null' maxLength: 50 minLength: 0 name: type: - string - 'null' maxLength: 100 minLength: 0 roleName: type: - string - 'null' maxLength: 100 minLength: 0 id: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) email: type: - string - 'null' maxLength: 100 minLength: 0 pattern: ^[a-zA-Z0-9\_]([a-zA-Z0-9\_\+\-\.\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\-\_]*[a-zA-Z0-9])*)[\.])+[a-zA-Z]{2,22}$ required: - agent - displayName - email - emailId - externalId - firstName - id - lastName - name - photoURL - roleName - type - zuid required: - allHandlingAgents - assignmentRuleEnabled - autoTicketConvert - autoTicketConvertInterval - businessHourEnabled - businessHourId - updatedBy - updater - type: - 'null' - object additionalProperties: false properties: data: $ref: ./IM_Channel.json#/components/schemas/listOfIMChannels required: - data examples: Valid responses Definitions: value: data: - defaultBotId: '-1' code: SANDBOX accountName: '+13312040199' integrationServiceType: WHATSAPP appName: Sandbox departmentId: '186543000000006907' universalLink: https://wa.me/13312040199 isActive: true isAuthorizationPending: false photoURL: https://desk.zoho.com/api/v1/channels/sandbox/photo?orgId=78412359 isSubscribed: true isDeleted: false isStorageEnabled: false createdBy: '78412824' isOwner: true name: Sandbox createdTime: 1693818836000 id: '3942000000045001' authenticationURL: null isSandBox: true - defaultBotId: '-1' code: TEST_SOFTWARE_4_3 accountName: Test Software 4 integrationServiceType: FACEBOOKMESSENGER appName: Test Software 4 departmentId: '186543000000393040' universalLink: https://m.me/168123406390163 isActive: true isAuthorizationPending: false photoURL: https://desk.zoho.com/api/v1/channels/test_software_4_3/photo?orgId=78412359 isSubscribed: true isDeleted: false isStorageEnabled: false createdBy: '78412824' isOwner: true name: Test Software 4 createdTime: 1707287312000 id: '3942000000943035' authenticationURL: null isSandBox: false - defaultBotId: '-1' code: TEST_DEP accountName: ZImAbhiTestBot integrationServiceType: TELEGRAM appName: Test DEP departmentId: '186543000000393040' universalLink: https://t.me/ZImAbhiTestBot isActive: true isAuthorizationPending: false photoURL: https://desk.zoho.com/api/v1/channels/test_dep/photo?orgId=78412359 isSubscribed: true isDeleted: false isStorageEnabled: false createdBy: '76837521' isOwner: true name: Test DEP createdTime: 1705378636000 id: '3942000000735961' authenticationURL: null isSandBox: false parameters: integrationServiceId: name: integrationServiceId in: query description: Channel ID to filter required: true style: form explode: true schema: type: - string - 'null' description: Channel ID to filter enum: - TELEGRAM - TWILIO - IM_TALK - LINE - WECHAT - WHATSAPP - FACEBOOKMESSENGER maxLength: 100 minLength: 0 id: name: id in: path required: true style: simple explode: false schema: type: - string - 'null' - integer format: int64 pattern: ([0-9]+) securitySchemes: iam-oauth2-schema: $ref: ./Common.json#/components/securitySchemes/iam-oauth2-schema x-entity: Helpcenter