Department
  • 05 Jul 2022
  • 1 Minute to read
  • Dark
    Light

Department

  • Dark
    Light

Article summary

You need the Manage Site permission to manage departments.

Department JSON Format

Department is represented as simple flat JSON objects with the following keys:

NameTypeDescription
idguidId of the department.
namestringName of the department.
descriptionstringDescription of the department.
isAvailableInLiveChatboolWhen the value is false, the department will not be displayed in the Pre-chat window, department drop down list, routing rules, chat transfer rules etc. Default: true.
isAvailableInTicketingAndMessagingboolWhen the value is false, the department name will not be displayed in the 'Assigned Department' field. Default: true.
offlineMessageMailTostringAllowed values are "toAllAgents", "toEmailAddresses".
offlineMessageEmailAddressesstringThe specified email addresses that offline messages are sent to. Available and required when Offline Message Mail Type is "toEmailAddresses".
agentIdsarrayID of the agents in this department.
isDeletedboolWhether the department is deleted or not.
chatbotSmartTriggerActionIdsarrayThe guid array of chatbot smart trigger actions for the selected departments.
shiftIdsarrayThe guid array of shifts for the selected departments.
segmentIdsarrayThe guid array of segmentations for the selected departments.

Get site Departments

GET global/sites/{siteId}/departments

  • Parameters:

NameTypeinRequiredDescription
keywordsstringquerynoFilter by keywords in name of the department.
includestringquerynoAllowed value is "agent".
siteIdintqueryyesId of the Site.
  • Response:

An array of Department

  • Example

Sample Request:

curl https://partnerapi.comm100.io/v4/global/sites/100/departments \ 
    -X 'GET' \ 
    -H 'Authorization: Bearer {access_token}' \ 

Response:

HTTP/1.1 200 OK

[
  {
      "id": "a0831b44-a2d0-4bed-96c4-43f7eb69b095",
      "name": "markting",
      "description": "markting departments",
      "isAvailableInLiveChat": true,
      "isAvailableInTicketingAndMessaging": true,
      "offlineMessageMailTo": "toAllAgents",
      "offlineMessageEmailAddresses": "andy@comm100.com",
      "isDeleted": false,
      "agentIds": [
          "3CA2EF45-7D46-EB11-8100-00155D081D0B"
      ],
      "chatbotSmartTriggerActionIds": [],
      "shiftIds": [],
      "segmentIds": []
  }
] 

Was this article helpful?

What's Next