Sinch Contact Center Restful Configuration Interface (RCI) version v1

Query Parameters

• certificateSubject: (string)

  Search users with certificate subject

  Example:

  certificateSubject=john*
  

• certificateIssuer: (string)

  Search users with certificate issuer

  Example:

  certificateIssuer=acme*
  

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: firstName, surname, externalId, chatName, chat, email, phone, crmId, businessObjectsId, presenceId, mobile, forwardNumber, title, location

  Example:

  firstName=John
  

• sort: (string)

  Can be sorted by any field. Default sort is firstName, surname, externalId, chatName, chat, email, phone. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=firstName, surname, externalId, chatName, chat, email, phone,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

• cursor: (string)

  Fetch result set in pages ordered by id (not alphabetical but GUID order). Can't use offset and sort parameters. limit has default value of 100. To get first page, give "cursor=" with empty value. To get next page, give "cursor=lastId" where lastId is the last id value of the previous page (page is array of objects, each having id field). The result might have less rows than the given limit, because of possible filtering and access control. There are no more rows when the result set is empty.

  Example:

  cursor= or cursor=058948E02E444AFD8D6D9F3E376065C8

Query Parameters

• userGroupId: (string)

  Id of the user group the newly created user is added to.

  Example:

  userGroupId=26C059173EFB432B9EA29EC1A74E19FB
  

• copyFromId: (string)

  Copy fields from another user.

  Example:

  copyFromId=8108B8FF0BC145C2B3FE0400247EB52F
  

• copyFromName: (string)

  Copy fields from another user by using name in format "surname, firstName".

  Example:

  copyFromName=surname, firstName
  

• copyOptions: (string)

  Used only with copyFromId or copyFromName parameters. Specify what data is copied from source user. Default options are: Fields,UserGroups,Roles,Skills,Settings,ForcedQueues

  Example:

  copyOptions=Fields,UserGroups,Roles,Skills,Settings,ForcedQueues
  

• companyId: (string)

  Used only with copyFromId or copyFromName parameters. When copying user from template user, see /templateCompany resource, then the possible template user groups and template roles linked to this template user are replaced with links to copied company level user groups and roles. For example, if template user group "TEMPLATE:{ID}/agents/{NAME}" is linked to template user, and companyId=01234/1234, and there is company level user group "01234/1234/agents/Company Ltd", then the new created user will be linked to that instead.

  Example:

  companyId=01234/1234
  

• masterId: (string)

  Used only with copyFromId or copyFromName parameters, and with companyId parameter. When copying user from template user, see /templateCompany resource, then the possible template user groups and template roles linked to this template user are replaced with links to copied master level user groups and roles. For example, if template user group "TEMPLATE:{MASTER} users" is linked to template user, and masterId=01234, and there is master level user group "01234 users", then the new created user will be linked to that instead.

  Example:

  masterId=01234
  

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• firstName: required(string - minLength: 1 - maxLength: 400)
• surname: required(string - minLength: 1 - maxLength: 400)
• login: (string - minLength: 1 - maxLength: 64)
• externalId: (string - minLength: 1 - maxLength: 128)
• phone: (string - minLength: 1 - maxLength: 256)
• mobile: (string - minLength: 1 - maxLength: 256)
• chat: (string - minLength: 3 - maxLength: 256)
• chatName: (string - minLength: 1 - maxLength: 64)
• email: (string - minLength: 6 - maxLength: 256)
• uiLanguage: (string - minLength: 2 - maxLength: 4)
• promptLanguage: (string - minLength: 2 - maxLength: 4)
• settings: (string)

  User Settings Template name, default value can be defined in IA variable Restful Interfaces / "Default User Settings Template Name for Users".

• timeZone: (string - minLength: 3 - maxLength: 50)
• synchronised: (boolean)
• businessObjectsId: (string - minLength: 1 - maxLength: 128)
• crmId: (string - minLength: 1 - maxLength: 128)
• presenceId: (string - minLength: 1 - maxLength: 128)
• forwardNumber: (string - maxLength: 32)
• title: (string - maxLength: 400)
• location: (string - maxLength: 400)
• callSwitchingLocationId: (union of string or nil)

  Id of the user's Call Switching Location. To remove the Call Switching Location from the user in an update, send field with null as value. If callSwitchingLocationId is missing from request, no modification is done to User's Call Switching Location.

• recordingMode: (one of None, UserDriven, UserDrivenDefaultOn, ForcedVisible, ForcedHidden, ForcedVisibleForwarded, ForcedHiddenForwarded)

  User's recording mode.
  UserDriven=Controlled by User,
  UserDrivenDefaultOn=Controlled by User and Enbaled by Default,
  ForcedVisible=Forced (All calls except forwarded calls),
  ForcedHidden=Forced and Hidden (All calls except forwarded calls),
  ForcedVisibleForwarded=Forced (All calls including forwarded calls),
  ForcedHiddenForwarded=Forced (All calls including forwarded calls)

Example:

{
  "firstName": "John",
  "surname": "Fox",
  "login": "John.Fox",
  "externalId": "JohnFox11223344",
  "phone": "123456",
  "mobile": "+7451254741",
  "chat": "John.Fox@customer.com",
  "chatName": "John",
  "email": "John.Fox@customer.com",
  "uiLanguage": "EN",
  "promptLanguage": "EN",
  "timeZone": "Europe/Helsinki",
  "synchronised": true,
  "crmId": "j.fox",
  "businessObjectsId": "john.fox",
  "presenceId": "john.fox",
  "forwardNumber": "5569",
  "title": "Customer Service Supervisor",
  "location": "Helsinki",
  "callSwitchingLocationId": "2EC1003BF0954197AC3EC17C3DD0A6FD"
}

URI Parameters

• userId: required(string)

URI Parameters

• userId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• firstName: required(string - minLength: 1 - maxLength: 400)
• surname: required(string - minLength: 1 - maxLength: 400)
• login: (string - minLength: 1 - maxLength: 64)
• externalId: (string - minLength: 1 - maxLength: 128)
• phone: (string - minLength: 1 - maxLength: 256)
• mobile: (string - minLength: 1 - maxLength: 256)
• chat: (string - minLength: 3 - maxLength: 256)
• chatName: (string - minLength: 1 - maxLength: 64)
• email: (string - minLength: 6 - maxLength: 256)
• uiLanguage: (string - minLength: 2 - maxLength: 4)
• promptLanguage: (string - minLength: 2 - maxLength: 4)
• settings: (string)

  User Settings Template name, default value can be defined in IA variable Restful Interfaces / "Default User Settings Template Name for Users".

• timeZone: (string - minLength: 3 - maxLength: 50)
• synchronised: (boolean)
• businessObjectsId: (string - minLength: 1 - maxLength: 128)
• crmId: (string - minLength: 1 - maxLength: 128)
• presenceId: (string - minLength: 1 - maxLength: 128)
• forwardNumber: (string - maxLength: 32)
• title: (string - maxLength: 400)
• location: (string - maxLength: 400)
• callSwitchingLocationId: (union of string or nil)

  Id of the user's Call Switching Location. To remove the Call Switching Location from the user in an update, send field with null as value. If callSwitchingLocationId is missing from request, no modification is done to User's Call Switching Location.

• recordingMode: (one of None, UserDriven, UserDrivenDefaultOn, ForcedVisible, ForcedHidden, ForcedVisibleForwarded, ForcedHiddenForwarded)

  User's recording mode.
  UserDriven=Controlled by User,
  UserDrivenDefaultOn=Controlled by User and Enbaled by Default,
  ForcedVisible=Forced (All calls except forwarded calls),
  ForcedHidden=Forced and Hidden (All calls except forwarded calls),
  ForcedVisibleForwarded=Forced (All calls including forwarded calls),
  ForcedHiddenForwarded=Forced (All calls including forwarded calls)

URI Parameters

• userId: required(string)

URI Parameters

• userId: required(string)

URI Parameters

• userId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• synchronised: (boolean)

Example:

{"id":"A9934415A02845B69389008CF1F27EAB"}

URI Parameters

• userId: required(string)
• userGroupId: required(string)

URI Parameters

• userId: required(string)
• userGroupId: required(string)

URI Parameters

• userId: required(string)

URI Parameters

• userId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string)
• description: (string)

Example:

{"id":"2CADB6A137124F13BC68938E2B5FEFC1"}

URI Parameters

• userId: required(string)
• roleId: required(string)

URI Parameters

• userId: required(string)
• roleId: required(string)

URI Parameters

• userId: required(string)

URI Parameters

• userId: required(string)

Body

Media type: application/json

Type: object

• subject: required(string - minLength: 1 - maxLength: 450)
• issuer: required(string - minLength: 1 - maxLength: 450)

Example:

{
"subject":"john.fox",
"issuer":"SSO_CA"
}

URI Parameters

• userId: required(string)
• certificateId: required(string)

URI Parameters

• userId: required(string)
• certificateId: required(string)

URI Parameters

• userId: required(string)

URI Parameters

• userId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Skill ID.

• value: required(integer)

  Skill value 1-5.

Example:

{"id":"ABFF5E5BC1E44E90877C55570D06E8A7", "value": 2}

URI Parameters

• userId: required(string)
• skillId: required(string)

URI Parameters

• userId: required(string)
• skillId: required(string)

Body

Media type: application/json

Type: object

• value: required(integer)

  Skill value 1-5.

Example:

{"value": 3}

URI Parameters

• userId: required(string)
• skillId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name

  Example:

  name = HelpDesk
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• synchronised: (boolean)

Example:

{
  "name": "HelpDesk",
  "synchronised": true
}

URI Parameters

• userGroupId: required(string)

URI Parameters

• userGroupId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• synchronised: (boolean)

URI Parameters

• userGroupId: required(string)

URI Parameters

• userGroupId: required(string)

URI Parameters

• userGroupId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Id of the object.

Example:

{
  "id":"E936C474B22311D38FBE0090279A922E"
}

URI Parameters

• userGroupId: required(string)
• userId: required(string)

URI Parameters

• userGroupId: required(string)
• userId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name

  Example:

  name = CC Agent
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

Query Parameters

• copyFromId: required(string)

  Mandatory - copy settings from another userSettingsTemplate.

  Example:

  copyFromId=8108B8FF0BC145C2B3FE0400247EB52F

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  User settings template ID.

• name: required(string)

  User settings template name.

• description: (string)

  User settings template description.

• settings: (array of UserSettingsTemplateSetting)

  Array of settings for this user settings template.

  Items: UserSettingsTemplateSetting

  • name: required(string)

    User settings template setting name.

  • value: (string)

    User settings template setting value.

  • forced: (boolean)

    True if this setting can't be overridden in user level settings. By default false.

Example:

{
  "name": "CC Agent",
  "description": "Default setting sample for CC agents",
  "settings": [
   {
      "name": "MultiChatMaxSessions",
      "value": "6",
      "forced": false
    }
  ]
}

URI Parameters

• userSettingsTemplateId: required(string)

URI Parameters

• userSettingsTemplateId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  User settings template ID.

• name: required(string)

  User settings template name.

• description: (string)

  User settings template description.

• settings: (array of UserSettingsTemplateSetting)

  Array of settings for this user settings template.

  Items: UserSettingsTemplateSetting

  • name: required(string)

    User settings template setting name.

  • value: (string)

    User settings template setting value.

  • forced: (boolean)

    True if this setting can't be overridden in user level settings. By default false.

URI Parameters

• userSettingsTemplateId: required(string)

URI Parameters

• userSettingsTemplateId: required(string)

Query Parameters

• name: (string)

  Filter result array to have only one setting.

  Example:

  name=MultiChatMaxSessions

URI Parameters

• userSettingsTemplateId: required(string)

Body

Media type: application/json

Type: object

• name: required(string)

  User settings template setting name.

• value: (string)

  User settings template setting value.

• forced: (boolean)

  True if this setting can't be overridden in user level settings. By default false.

Example:

{
  "name": "MultiChatMaxSessions",
  "value": "4",
  "forced": false
}

Query Parameters

• groupId: (string)

  Search queues that belong to queue group. Supports multiple group IDs separated by comma.

  Example:

  groupId=8108B8FF0BC145C2B3FE0400247EB52F

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: name, description, address, forwardNumber

  Example:

  name = Sales*
  

• attributeName: (string)

  Search item by attribute name.

  Example:

  attributeName=displayName
  

• attributeValue: (string)

  Search by value of the attribute, attributeName parameter is mandatory in case attributeValue is given.

  Example:

  attributeValue=*support*
  

• includeAttributes: (boolean - default: false)

  Includes attributes into result

  Example:

  includeAttributes=true

• sort: (string)

  Can be sorted by any field. Default sort is name, description. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=name, description,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

• cursor: (string)

  Fetch result set in pages ordered by id (not alphabetical but GUID order). Can't use offset and sort parameters. limit has default value of 100. To get first page, give "cursor=" with empty value. To get next page, give "cursor=lastId" where lastId is the last id value of the previous page (page is array of objects, each having id field). The result might have less rows than the given limit, because of possible filtering and access control. There are no more rows when the result set is empty.

  Example:

  cursor= or cursor=058948E02E444AFD8D6D9F3E376065C8

Query Parameters

• copyFromId: (string)

  Copy fields from another queue.

  Example:

  copyFromId=8108B8FF0BC145C2B3FE0400247EB52F
  

• copyOptions: (string)

  Used only with copyFromId parameter. Specify what data is copied from source queue. Default options are: Fields,Rights,QueueGroups,Skills,ServiceTimeSchedules,PromptSchedules

  Example:

  copyOptions=Fields,Rights,QueueGroups,Skills,ServiceTimeSchedules,PromptSchedules
  

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• type: required(one of Phone, Chat, Email)
• name: required(string - minLength: 1 - maxLength: 400)
• description: (string - minLength: 1 - maxLength: 400)
• synchronised: (boolean)
• loginType: required(one of AutoAllocation, HuntGroup)
• forwardNumber: (string)

  For phone queues only. instant forwarding number.

• forwardEnabled: (boolean)

  For phone queues only. Enable instant forwarding. Null value is ignored.

• addresses: (object)
  • address: (array of string)

Example:

{
  "type": "Phone",
  "name":  "Sales",
  "description": "Sales phone",
  "loginType": "AutoAllocation",
  "synchronised": true,
  "forwardNumber": "700",
  "forwardEnabled": true
 }

URI Parameters

• queueId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• type: required(one of Phone, Chat, Email)
• name: required(string - minLength: 1 - maxLength: 400)
• description: (string - minLength: 1 - maxLength: 400)
• synchronised: (boolean)
• loginType: required(one of AutoAllocation, HuntGroup)
• forwardNumber: (string)

  For phone queues only. instant forwarding number.

• forwardEnabled: (boolean)

  For phone queues only. Enable instant forwarding. Null value is ignored.

• addresses: (object)
  • address: (array of string)

URI Parameters

• queueId: required(string)

URI Parameters

• queueId: required(string)

URI Parameters

• queueId: required(string)

URI Parameters

• queueId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• address: required(string)
• language: (string)
• priority: (number)
• countryCode: (string)

  Country code for chat extensions only, for example: "+123", "234".

Example:

{
  "address": "103"
}

URI Parameters

• queueId: required(string)
• extensionId: required(string)

URI Parameters

• queueId: required(string)
• extensionId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• address: required(string)
• language: (string)
• priority: (number)
• countryCode: (string)

  Country code for chat extensions only, for example: "+123", "234".

URI Parameters

• queueId: required(string)
• extensionId: required(string)

URI Parameters

• queueId: required(string)

URI Parameters

• queueId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• description: required(string - minLength: 1 - maxLength: 400)

Example:

{
  "id":"2CADB6A1-3712-4F13-BC68-938E2B5FEFC1"
}

URI Parameters

• queueId: required(string)
• queueGroupId: required(string)

URI Parameters

• queueId: required(string)
• queueGroupId: required(string)

URI Parameters

• queueId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: name, language

  Example:

  name=Helpdesk
  

URI Parameters

• queueId: required(string)

Body

Media type: application/json

Type: object

• name: required(string)
• langauge: required(string)
• value: required(string)

Example:

{
    name: "Name",
    language: "EN",
    value: "Advanced"
}

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: name, description

  Example:

  name = HelpDesk
  

• attributeName: (string)

  Search item by attribute name.

  Example:

  attributeName=displayName
  

• attributeValue: (string)

  Search by value of the attribute, attributeName parameter is mandatory in case attributeValue is given.

  Example:

  attributeValue=*support*
  

• includeAttributes: (boolean - default: false)

  Includes attributes into result

  Example:

  includeAttributes=true

• sort: (string)

  Can be sorted by any field. Default sort is name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• description: required(string - minLength: 1 - maxLength: 400)

Example:

[
  {
    "name": "CC Agent"
    "description": "CC Agent queue group"
  }
]

URI Parameters

• queueGroupId: required(string)

URI Parameters

• queueGroupId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• description: required(string - minLength: 1 - maxLength: 400)

URI Parameters

• queueGroupId: required(string)

URI Parameters

• queueGroupId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: name

  Example:

  name = Sales*
  

• sort: (string)

  Can be sorted by any field. Default sort is name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

URI Parameters

• queueGroupId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• type: required(one of Phone, Chat, Email)
• name: required(string - minLength: 1 - maxLength: 400)
• description: (string - minLength: 1 - maxLength: 400)
• synchronised: (boolean)
• loginType: required(one of AutoAllocation, HuntGroup)
• forwardNumber: (string)

  For phone queues only. instant forwarding number.

• forwardEnabled: (boolean)

  For phone queues only. Enable instant forwarding. Null value is ignored.

• addresses: (object)
  • address: (array of string)

Example:

{
  "id": "B8F0CA9CFC0411D3A2230050DA29E0F4"
}

URI Parameters

• queueGroupId: required(string)
• queueId: required(string)

URI Parameters

• queueGroupId: required(string)
• queueId: required(string)

URI Parameters

• queueGroupId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: name, language

  Example:

  name=Helpdesk
  

URI Parameters

• queueGroupId: required(string)

Body

Media type: application/json

Type: object

• name: required(string)
• langauge: required(string)
• value: required(string)

Example:

{
    name: "Name",
    language: "EN",
    value: "Advanced"
}

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name

  Example:

  name = CC Agent
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string)
• description: (string)

Example:

{
  "name": "CC Agent",
  "description":"CC Agent Role"
}

URI Parameters

• roleId: required(string)

URI Parameters

• roleId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string)
• description: (string)

URI Parameters

• roleId: required(string)

URI Parameters

• roleId: required(string)

URI Parameters

• roleId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• firstName: required(string - minLength: 1 - maxLength: 400)
• surname: required(string - minLength: 1 - maxLength: 400)
• login: (string - minLength: 1 - maxLength: 64)
• externalId: (string - minLength: 1 - maxLength: 128)
• phone: (string - minLength: 1 - maxLength: 256)
• mobile: (string - minLength: 1 - maxLength: 256)
• chat: (string - minLength: 3 - maxLength: 256)
• chatName: (string - minLength: 1 - maxLength: 64)
• email: (string - minLength: 6 - maxLength: 256)
• uiLanguage: (string - minLength: 2 - maxLength: 4)
• promptLanguage: (string - minLength: 2 - maxLength: 4)
• settings: (string)

  User Settings Template name, default value can be defined in IA variable Restful Interfaces / "Default User Settings Template Name for Users".

• timeZone: (string - minLength: 3 - maxLength: 50)
• synchronised: (boolean)
• businessObjectsId: (string - minLength: 1 - maxLength: 128)
• crmId: (string - minLength: 1 - maxLength: 128)
• presenceId: (string - minLength: 1 - maxLength: 128)
• forwardNumber: (string - maxLength: 32)
• title: (string - maxLength: 400)
• location: (string - maxLength: 400)
• callSwitchingLocationId: (union of string or nil)

  Id of the user's Call Switching Location. To remove the Call Switching Location from the user in an update, send field with null as value. If callSwitchingLocationId is missing from request, no modification is done to User's Call Switching Location.

• recordingMode: (one of None, UserDriven, UserDrivenDefaultOn, ForcedVisible, ForcedHidden, ForcedVisibleForwarded, ForcedHiddenForwarded)

  User's recording mode.
  UserDriven=Controlled by User,
  UserDrivenDefaultOn=Controlled by User and Enbaled by Default,
  ForcedVisible=Forced (All calls except forwarded calls),
  ForcedHidden=Forced and Hidden (All calls except forwarded calls),
  ForcedVisibleForwarded=Forced (All calls including forwarded calls),
  ForcedHiddenForwarded=Forced (All calls including forwarded calls)

Example:

{
  "id":"E936C474B22311D38FBE0090279A922E"
}

URI Parameters

• roleId: required(string)
• userId: required(string)

URI Parameters

• roleId: required(string)
• userId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name

  Example:

  name=HelpDesk
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• description: required(string - minLength: 1 - maxLength: 400)

Example:

{
  "name": "Russian",
  "description": "Russian language skill"
}

URI Parameters

• skillId: required(string)

URI Parameters

• skillId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string - minLength: 1 - maxLength: 400)
• description: required(string - minLength: 1 - maxLength: 400)

URI Parameters

• skillId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name

  Example:

  name=Script Name
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

URI Parameters

• scriptId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name

  Example:

  id = Europe/Helsinki
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

URI Parameters

• timeZoneId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, name, reason

  Example:

  reason = VACATION
  

• sort: (string)

  Can be sorted by any field. Default sort is id, name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=id, name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

URI Parameters

• prsProfileId: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: id, type

  Example:

  type = facebook
  

• sort: (string)

  Can be sorted by any field. Default sort is name. "-" in front of field name will sort descending. With the postfix ",LOCALE-xx" where xx can be for example en,en-US,de,fi, the user may sort with given locale that are based on standard "IETF BCP 47".

  Example:

  sort=name,LOCALE-en
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string)
• type: required(one of facebook, twilio, sap365, social365, c4semail, sinchsms, sinchconversation, wavy, Microsoft Teams)
• connection: required(string)
• authenticationScope: (string)
• authenticationUrl: (string)

Example:

{
  "type": "facebook",
  "name": "Facebook connection",
  "connection": "https://serviceaddress/"
}

URI Parameters

• messagingServiceId: required(string)

URI Parameters

• messagingServiceId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• name: required(string)
• type: required(one of facebook, twilio, sap365, social365, c4semail, sinchsms, sinchconversation, wavy, Microsoft Teams)
• connection: required(string)
• authenticationScope: (string)
• authenticationUrl: (string)

URI Parameters

• messagingServiceId: required(string)

URI Parameters

• messagingServiceId: required(string)

URI Parameters

• messagingServiceId: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• authenticationId: (string - maxLength: 512)
• password: (string)

Example:

{
   "authenticationId":"my_login_id",
   "password":"zzzxxxx"
}

URI Parameters

• messagingServiceId: required(string)
• id: required(string)

URI Parameters

• messagingServiceId: required(string)
• id: required(string)

Body

Media type: application/json

Type: object

• id: required(string - minLength: 32 - maxLength: 32)

  Added by the system

• authenticationId: (string - maxLength: 512)
• password: (string)

URI Parameters

• messagingServiceId: required(string)
• id: required(string)

Query Parameters

• any fields: (string)

  &field1=value1&field2=value2...
  Values may contain patterns * and ?, except for ID fields, which must be in id32 or id36 format (GUID).
  Valid searchable fields: keyword, queueId, language, name

  Example:

  keyword=sales, keyword=proble*,apple
  

• offset: (integer - default: 0)

  Skip over a number of elements by specifying an offset value for the query

  Example:

  20

• limit: (integer - default: 100)

  Limit number of elements by specifying a limit value for the query

  Example:

  100