Book a Meeting Worktual(or)Chat on WhatsApp Worktual
Worktual Logo
Products
Pricing
Solution
Resources
About Us
WorktualLogin
API DocumentationCcaas
API Documentation
OverviewConfiguration ModuleContact ModuleKnowledge Base ModuleOmni Channel Module
Configuration Module▼

Configuration Module:

1.Get ALL Agent List: Retrieve all Agents details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/agents

Headers Authorisation : token

Query Parameters:

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "statusName": "Busy",
    "UserID": 2620,
    "UserName": "Agent TestThree",
    "emailId": "testThree@agent.com",
    "directNumber": 0,
    "address": null,
    "routing_profile_id": 1940,
    "report_to_UserID": 2433,
    "ext": 208,
    "isActive": 1,
    "callTypeId": 1,
    "roleid": 6,
    "localization": "0",
    "currentSession": "0",
    "isVoice": 0,
    "isVoiceCallTransfer": 0,
    "isChat": 0,
    "isChatTransfer": 0,
    "isEmail": 0,
    "isEmailTransfer": 0,
    "StatusID": 8061,
    "isSms": 0,
    "isSocialMedia": 0,
    "companyName": "Mancherter city",
    "addSkill": "[{\"value\": \"Technical expertise\"}, {\"value\": \"Empathy\"}, {\"value\": \"Product/service knowledge\"}, {\"value\": \"Conflict resolution\"}, {\"value\": \"Problem-solving\"}]",
    "voice": 1,
    "chat": 1,
    "email": 1,
    "sms": 1,
    "socialMedia": 1,
    "stateTimer": "1712575245",
    "quId": "2091"
  }
]

2.Get single Agent List : Retrieve the particular Agent details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/agents/{id}

Headers Authorisation : token

Parameters

Id - agent ext id.

Query Parameters:

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "statusName": "Busy",
    "UserID": 2620,
    "UserName": "Agent TestThree",
    "emailId": "testThree@agent.com",
    "directNumber": 0,
    "address": null,
    "routing_profile_id": 1940,
    "report_to_UserID": 2433,
    "ext": 208,
    "isActive": 1,
    "callTypeId": 1,
    "roleid": 6,
    "localization": "0",
    "currentSession": "0",
    "isVoice": 0,
    "isVoiceCallTransfer": 0,
    "isChat": 0,
    "isChatTransfer": 0,
    "isEmail": 0,
    "isEmailTransfer": 0,
    "StatusID": 8061,
    "isSms": 0,
    "isSocialMedia": 0,
    "companyName": "Mancherter city",
    "addSkill": "[{\"value\": \"Technical expertise\"}, {\"value\": \"Empathy\"}, {\"value\": \"Product/service knowledge\"}, {\"value\": \"Conflict resolution\"}, {\"value\": \"Problem-solving\"}]",
    "voice": 1,
    "chat": 1,
    "email": 1,
    "sms": 1,
    "socialMedia": 1,
    "stateTimer": "1712575245",
    "quId": "2091"
  }
]

3.Get All Business Availablity : Retrieve all the Business Hours details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/business/availablity

Headers Authorisation : token

Query Parameters :

offset - Default value is 0,increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "cid": 1505,
    "name": "london",
    "description": "",
    "hours": [
      {
        "day": "Monday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1709231440259,
            "endTimeStamp": 1709317780259,
            "differenceTime": "23 : 59 hrs",
            "id": 1,
            "startTime": "00:00",
            "endTime": "23:59"
          }
        ]
      },
      {
        "day": "Tuesday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1709263840259,
            "endTimeStamp": 1709317780259,
            "differenceTime": "14 : 59 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:59"
          }
        ]
      },
      {
        "day": "Wednesday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1709263840259,
            "endTimeStamp": 1709317780259,
            "differenceTime": "14 : 59 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:59"
          }
        ]
      },
      {
        "day": "Thursday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1709263840259,
            "endTimeStamp": 1709317780259,
            "differenceTime": "14 : 59 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:59"
          }
        ]
      },
      {
        "day": "Friday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1709263840259,
            "endTimeStamp": 1709314240259,
            "differenceTime": "14 : 0 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "Saturday",
        "isHoliday": false,
        "entry": [
          {
            "id": 1,
            "startTimeStamp": 1711164600501,
            "endTimeStamp": 1711215000365,
            "differenceTime": "13 : 59 hrs",
            "startTime": "09:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "Sunday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1711305000951,
            "endTimeStamp": 1711391340986,
            "differenceTime": "23 : 59 hrs",
            "id": 1,
            "startTime": "00:00",
            "endTime": "23:59"
          }
        ]
      }
    ],
    "timeZone": "Asia/Kolkata (IST) GMT +05:30",
    "default_hours": "9",
    "timeZoneValue": "Asia/Kolkata",
    "type": "custom",
    "createdAt": "2024-03-01T03:47:56.000Z",
    "updatedAt": "2024-03-25T03:38:18.000Z"
  }
]

4.Get single Business Availablity : Get the particular Business Hour details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/business/availablity/{id}

Headers Authorisation : token

Parameters :

Id - business availablity id.

Query Parameters :

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "cid": 1401,
    "name": "new",
    "description": "",
    "hours": [
      {
        "day": "Monday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1701973849109,
            "endTimeStamp": 1702056649109,
            "differenceTime": "23 : 0 hrs",
            "id": 1,
            "startTime": "00:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "Tuesday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1702006249109,
            "endTimeStamp": 1702056649109,
            "differenceTime": "14 : 0 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "Wednesday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1702006249109,
            "endTimeStamp": 1702056649109,
            "differenceTime": "14 : 0 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "Thursday",
        "isHoliday": false,
        "entry": [
          {
            "startTimeStamp": 1702006249109,
            "endTimeStamp": 1702056649109,
            "differenceTime": "14 : 0 hrs",
            "id": 1,
            "startTime": "09:00",
            "endTime": "23:00"
          }
        ]
      },
      {
        "day": "Friday",
        "isHoliday": false,
        "entry": []
      },
      {
        "day": "Saturday",
        "isHoliday": false,
        "entry": [
          {
            "id": 1,
            "startTimeStamp": 1705980600253,
            "endTimeStamp": 1706027400765,
            "differenceTime": "13 : 0 hrs",
            "startTime": "09:00",
            "endTime": "22:00"
          }
        ]
      },
      {
        "day": "Sunday",
        "isHoliday": true,
        "entry": [
          {
            "startTimeStamp": null,
            "endTimeStamp": null,
            "differenceTime": "",
            "id": 1,
            "startTime": "Invalid date",
            "endTime": "Invalid date"
          }
        ]
      }
    ],
    "timeZone": "Europe/London (GMT) GMT +00:00",
    "default_hours": "9",
    "timeZoneValue": "Europe/London",
    "type": "custom",
    "createdAt": "2023-12-08T00:52:01.000Z",
    "updatedAt": "2024-03-16T07:08:47.000Z"
  }
]

5.Get Contact Center : Retrieve the contact center details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/contactCenter

Headers Authorisation : token

Query Parameters :

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "pid": 1096,
    "user_id": 200,
    "type": "LOCAL NUMBER",
    "city": "string",
    "your_number": "441234936121",
    "createdAt": "2023-11-30T04:02:16.000Z",
    "updatedAt": "2024-03-20T01:07:46.000Z",
    "callFlowId": "95147c26-6d8e-43a6-b2de-a0a53dfc75f7",
    "recording": 1,
    "isCall": 0,
    "isSms": 0,
    "queueName": null,
    "aliasName": null,
    "outboundSms": 0,
    "smsThreshold": 0,
    "status": 1,
    "callFlowName": "Default Call Flow",
    "defaultUpdated": 1,
    "supervisorName": null,
    "isCallIn": 0,
    "isCallOut": 0,
    "isSmsOut": 0,
    "isSmsIn": 0,
    "queueId": 1959,
    "country": null,
    "isBot": 0,
    "isBotPurchased": 0,
    "knowledgeBasedId": null,
    "autoAssignAgent": null
  }
]

6.Get Configured Email Detail : Retrieve the email configured detail using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/configureEmail

Headers Authorisation : token

Query Parameters :

createdDate - string.

1712824166111 timestamp of the created Date contact.

condition - string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "web_id": null,
    "websiteId": null,
    "baseName": null,
    "EmailConfigId": 528,
    "emailAddress": "support@manchertercity7179.worktual.net",
    "aliasName": "Julian",
    "emailThreshold": 24,
    "isEmail": 1,
    "createdAt": "2023-11-30T04:02:28.000Z",
    "updatedAt": null,
    "primaryEmail": 1,
    "supervisorName": "Julian",
    "isBot": null,
    "isBotPurchased": 0,
    "knowledgeBasedId": null,
    "autoAssignAgent": null
  }
]

7.Get Configured Sms Detial : Retrieve the SMS configured details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/configureSms

Headers Authorisation : token

Query Parameters :

createdDate - string.

1712824166111 timestamp of the created Date contact.

condition - string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "web_id": null,
    "baseName": null,
    "websiteId": null,
    "pid": 1096,
    "user_id": 200,
    "type": "LOCAL NUMBER",
    "city": "string",
    "your_number": "441234936121",
    "createdAt": "2023-11-30T04:02:16.000Z",
    "updatedAt": "2024-03-20T01:07:46.000Z",
    "callFlowId": "95147c26-6d8e-43a6-b2de-a0a53dfc75f7",
    "recording": 1,
    "isCall": 0,
    "isSms": 0,
    "queueName": null,
    "aliasName": null,
    "outboundSms": 0,
    "smsThreshold": 0,
    "status": 1,
    "callFlowName": "Default Call Flow",
    "defaultUpdated": 1,
    "supervisorName": null,
    "isCallIn": 0,
    "isCallOut": 0,
    "isSmsOut": 0,
    "isSmsIn": 0,
    "queueId": 1959,
    "country": null,
    "isBot": 0,
    "isBotPurchased": 0,
    "knowledgeBasedId": null,
    "autoAssignAgent": null
  }
]

8.Get All Queue List: Retrieve all the queue details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/queue

Headers Authorisation : token

Query Parameters :

createdDate - string.

1712824166111 timestamp of the created Date contact.

condition - string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "name": "selva queue",
    "description": "selva queue",
    "settingAudio": "{\"connectingAudio\":{\"ConnectingAudioFile\":{\"uuid\":4931,\"fieldname\":\"doc\",\"encoding\":\"7bit\",\"mimetype\":\"audio/wav\",\"filename\":\"ConnectingAudio.wav\",\"path\":\"/volume/nfsshare/ccaas/prompt/ConnectingAudio.wav\",\"size\":288044,\"type\":\"upload\",\"promptType\":0,\"url\":\"https://ccaas-storage.worktual.co.uk/prompt/ConnectingAudio.wav\",\"name\":\"Queue Connecting  Audio\",\"description\":\"connecting audio file\",\"domainId\":7179,\"companyId\":7247,\"message\":\"\",\"createdAt\":\"2023-11-30T09:32:14.000Z\",\"updateddAt\":null,\"promptStatus\":\"promptStatus\"},\"ConnectingAudioName\":\"Queue Connecting  Audio\"},\"greetingAudio\":{\"greetingAudioFile\":{\"uuid\":4932,\"fieldname\":\"doc\",\"encoding\":\"7bit\",\"mimetype\":\"audio/wav\",\"filename\":\"Greeting tone.wav\",\"path\":\"/volume/nfsshare/ccaas/prompt/GreetingTone.wav\",\"size\":163660,\"type\":\"upload\",\"promptType\":0,\"url\":\"https://ccaas-storage.worktual.co.uk/prompt/GreetingTone.wav\",\"name\":\"Queue Greeting  Audio\",\"description\":\"Greeting tone file\",\"domainId\":7179,\"companyId\":7247,\"message\":\"\",\"createdAt\":\"2023-11-30T09:32:14.000Z\",\"updateddAt\":null,\"promptStatus\":\"promptStatus\"},\"greetingAudioName\":\"Queue Greeting  Audio\"},\"queueAudio\":{\"queueAudioFile\":{\"uuid\":4933,\"fieldname\":\"doc\",\"encoding\":\"7bit\",\"mimetype\":\"Queue Audio\",\"filename\":\"QueueAudio.wav\",\"path\":\"/volume/nfsshare/ccaas/prompt/QueueAudio.wav\",\"size\":911626,\"type\":\"upload\",\"promptType\":0,\"url\":\"https://ccaas-storage.worktual.co.uk/prompt/QueueAudio.wav\",\"name\":\"Queue Audio\",\"description\":\"Queue Audio file\",\"domainId\":7179,\"companyId\":7247,\"message\":\"\",\"createdAt\":\"2023-11-30T09:32:14.000Z\",\"updateddAt\":null,\"promptStatus\":\"promptStatus\"},\"queueAudioName\":\"Queue Audio\"},\"holdAudio\":{\"holdAudioFile\":{\"uuid\":4934,\"fieldname\":\"doc\",\"encoding\":\"7bit\",\"mimetype\":\"Hold Audio\",\"filename\":\"hold_stay_on_line.wav\",\"path\":\"/volume/nfsshare/ccaas/prompt/hold_stay_on_line.wav\",\"size\":311340,\"type\":\"upload\",\"promptType\":0,\"url\":\"https://ccaas-storage.worktual.co.uk/prompt/hold_stay_on_line.wav\",\"name\":\"Hold Audio\",\"description\":\"Hold tone file\",\"domainId\":7179,\"companyId\":7247,\"message\":\"\",\"createdAt\":\"2023-11-30T09:32:14.000Z\",\"updateddAt\":null,\"promptStatus\":\"promptStatus\"},\"holdAudioName\":\"Hold Audio\"}}",
    "announcement": "{\"type\":0,\"textToSpeech\":\"\",\"AnnouncementValue\":\"No Announcement\",\"placeHolder\":\"\",\"voicemail\":0,\"callback\":0,\"frequency\":0}",
    "maximumCallers": "{\"type\":\"No Limit\",\"limitResponseType\":0,\"queueLimit\":0,\"overFlowQueueName\":\"\",\"overFlowQueue\":0}",
    "maximumWaitTime": "{\"type\":\"Keep Waiting\",\"maxWaitTime\":0,\"fallBackQueue\":0,\"file\":{},\"timeElapsed\":0,\"timeElapsedValue\":\"\",\"fallBackQueueName\":\"\",\"fileName\":\"\"}",
    "OutboundCallerId": "selva",
    "outBoundNumber": "441234936121",
    "maxCallHandlingTimeMM": 4,
    "maxCallHandlingTimeSS": null,
    "callWrapUpTime": 10,
    "outBoundCallStatus": 0,
    "hoursOfOperatioId": 1505,
    "hours_of_operation": "{\"businessHoursFile\":{\"cid\":1505,\"name\":\"london\",\"description\":\"\",\"hours\":[{\"day\":\"Monday\",\"isHoliday\":false,\"entry\":[{\"startTimeStamp\":1709231440259,\"endTimeStamp\":1709317780259,\"differenceTime\":\"23 : 59 hrs\",\"id\":1,\"startTime\":\"00:00\",\"endTime\":\"23:59\"}]},{\"day\":\"Tuesday\",\"isHoliday\":false,\"entry\":[{\"startTimeStamp\":1709263840259,\"endTimeStamp\":1709317780259,\"differenceTime\":\"14 : 59 hrs\",\"id\":1,\"startTime\":\"09:00\",\"endTime\":\"23:59\"}]},{\"day\":\"Wednesday\",\"isHoliday\":false,\"entry\":[{\"startTimeStamp\":1709263840259,\"endTimeStamp\":1709317780259,\"differenceTime\":\"14 : 59 hrs\",\"id\":1,\"startTime\":\"09:00\",\"endTime\":\"23:59\"}]},{\"day\":\"Thursday\",\"isHoliday\":false,\"entry\":[{\"startTimeStamp\":1709263840259,\"endTimeStamp\":1709317780259,\"differenceTime\":\"14 : 59 hrs\",\"id\":1,\"startTime\":\"09:00\",\"endTime\":\"23:59\"}]},{\"day\":\"Friday\",\"isHoliday\":false,\"entry\":[{\"startTimeStamp\":1709263840259,\"endTimeStamp\":1709314240259,\"differenceTime\":\"14 : 0 hrs\",\"id\":1,\"startTime\":\"09:00\",\"endTime\":\"23:00\"}]},{\"day\":\"Saturday\",\"isHoliday\":false,\"entry\":[{\"id\":1,\"startTimeStamp\":1711164600501,\"endTimeStamp\":1711215000365,\"differenceTime\":\"13 : 59 hrs\",\"startTime\":\"09:00\",\"endTime\":\"23:00\"}]},{\"day\":\"Sunday\",\"isHoliday\":false,\"entry\":[{\"startTimeStamp\":1711305000951,\"endTimeStamp\":1711391340986,\"differenceTime\":\"23 : 59 hrs\",\"id\":1,\"startTime\":\"00:00\",\"endTime\":\"23:59\"}]}],\"timeZone\":\"Asia/Kolkata\",\"domainId\":7179,\"type\":\"custom\",\"default_hours\":\"9\",\"timeZoneValue\":\"Asia/Kolkata\",\"createdAt\":\"2024-03-01T09:17:56.000Z\",\"updatedAt\":\"2024-03-20T06:38:57.000Z\"}}",
    "outOfBusinessHours": "{\"busineHoursType\":0,\"busineHoursValue\":\"Announcement\",\"fileName\":\"closed\",\"file\":{\"uuid\":4980,\"fieldname\":null,\"encoding\":null,\"mimetype\":null,\"filename\":\"closed.wav\",\"path\":\"/volume/nfsshare/ccaas/prompt/7179/17c85b57-83e1-40b1-b088-2b8e28866a87/closed.wav\",\"size\":0,\"type\":\"text\",\"promptType\":1,\"url\":\"https://ccaas-storage.worktual.co.uk/prompt/7179/17c85b57-83e1-40b1-b088-2b8e28866a87/closed.wav\",\"name\":\"closed\",\"description\":\"\",\"domainId\":7179,\"companyId\":7247,\"message\":\"sorry we are closed \",\"createdAt\":\"2023-12-08T06:23:07.000Z\",\"updateddAt\":\"2023-12-08T06:23:07.000Z\",\"promptStatus\":\"promptLibrary\"}}",
    "createdAt": "2024-03-21T04:11:49.000Z",
    "updatedAt": null
  }
]

9.Get all Routing profile List: Retrieve the all routing profile details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/routingProfile

Headers Authorisation : token

Query Parameters :

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "rid": 1952,
    "name": "qwer",
    "description": "zxdfg",
    "default_outbound_queue": "null",
    "No_of_linked_queues": 1,
    "status": 1,
    "routingMethod": "Long wait time Based Routing",
    "concurrentChat": 5,
    "type": null
  }
]

10.Single Routing Profile : Retrieve the particular Routing Profile details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/routingProfile/{id}

Headers Authorisation : token

Parameters :

rid - routing profile id.

Query Parameters :

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "rid": 1951,
    "name": "water bottle",
    "description": "test meet",
    "default_outbound_queue": "null",
    "No_of_linked_queues": 1,
    "status": 1,
    "routingMethod": "Long wait time Based Routing",
    "concurrentChat": 2,
    "type": null
  }
]

11.Get all skill List : Retrieve the all skills details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/skill

Headers Authorisation : token

Query Parameters :

createdDate - string.

1712824166111 timestamp of the created Date contact.

condition - string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "sid": 6865,
    "skill_name": "Technical expertise",
    "skill_description": "Depending on the industry, Agents may also be expected to have technical expertise in a particular area",
    "status": 1,
    "type": null,
    "createdAt": "2023-11-30T04:02:14.000Z",
    "updatedAt": null
  }
]

12.Get single skill list : Retrieve the particular skill details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/skill/{id}

Headers Authorisation : token

Parameters :

Id - skill id.

Query Parameters :

createdDate - string.

1712824166111 timestamp of the created Date contact.

condition - string.

Accept Values are EQ, LT, GT, GTE, LTE.

Default : EQ value.

offset - Default value is 0, increase by 1.

limit - Maximum records is 100. Default Value is 100.

Response : 200

Copy code
[
  {
    "sid": 6864,
    "skill_name": "Empathy",
    "skill_description": "The ability to understand and respond to customer emotions and needs in a compassionate and understanding way",
    "status": 1,
    "type": null,
    "createdAt": "2023-11-30T04:02:14.000Z",
    "updatedAt": null
  }
]

13.Create a new skill : Create a new skill using this API

Request

Posthttps://api.worktual.co.uk/services/ccaas/v1/skill

Headers Authorisation : token

Body :

Copy code
[
  {
    "skillName": "string",
    "skillDescription": "string"
  }
]

Response : 200

Copy code
[
  {
    "message": "Skill inserted successfully"
  }
]

14.Update a particular skill : Update the particular skill using this API

Request

Patchhttps://api.worktual.co.uk/services/ccaas/v1/skill/{id}

Headers Authorisation : token

Parameters :

Id - skill id.

Body :

Copy code
[
  {
    "skillName": "string",
    "skillDescription": "string",
    "status": "number"
  }
]

Response : 200

Copy code
[
  {
    "message": "successfully skill updated"
  }
]

15.Get all user List : Retrieve the all users details using this API

Request

Gethttps://api.worktual.co.uk/services/ccaas/v1/user

Headers Authorisation : token

Query Parameters :

fields - to retrieve particular fileds.

Response : 200

Copy code
[
  {
    "address": null,
    "addSkill": "[{\"skid\": 6700, \"value\": \"Technical expertise\"}, {\"skid\": 6699, \"value\": \"Empathy\"}, {\"skid\": 6698, \"value\": \"Product/service knowledge\"}, {\"skid\": 6697, \"value\": \"Conflict resolution\"}, {\"skid\": 6696, \"value\": \"Problem-solving\"}]",
    "AssignedTime": null,
    "callTypeId": 0,
    "chat": 1,
    "chatFlag": null,
    "chatLimit": 0,
    "companyName": null,
    "createdAt": "2023-09-25T09:15:03.000Z",
    "currentSession": "0",
    "directNumber": 0,
    "email": 1,
    "emailId": "cost75@test.com",
    "ext": 200,
    "isActive": 1,
    "isAvailableForVoice": 1,
    "isChat": 0,
    "isChatTransfer": 0,
    "isEmail": 0,
    "isEmailTransfer": 0,
    "isSms": 0,
    "isSocialMedia": 0,
    "isVoice": 0,
    "isVoiceCallTransfer": 0,
    "localization": "0",
    "report_to_UserID": 0,
    "routing_profile_id": 1762,
    "sms": 1,
    "socialMedia": 1,
    "stateTimer": "1711357034",
    "StatusID": 7860,
    "updatedAt": "2024-03-25T03:27:14.000Z",
    "UserID": 2371,
    "UserName": "Cost  Less admin",
    "voice": 1
  }
]
Products
Lola - Advanced ChatbotLukas - Standard ChatbotAI Contact CentreTicketing SystemCustomer Data PlatformCustomer Value ManagementCampaign Management
Solutions
AI for Small BusinessAI for Medium BusinessAI for Enterprise BusinessIndustry
Company
About UsContact Us
Resources
BlogPartnerApp MarketplaceAPI DocumentationFAQs
Legal
Privacy NoticeTerms & ConditionsCookie Policy
Improve your business with sales, support, and customer service automation
Worktual Logo

© 2025 Worktual

Terms & ConditionsPrivacy NoticeCookie Settings
Worktual LogoWorktual LogoWorktual LogoWorktual LogoWorktual Logo

© 2025 Worktual