Sinch Contact Center Restful Configuration Interface (RCI) version v1

http://localhost:8080/RI/rci

Description

This interface provides restricted configuration interface for Sinch Contact Center.

Request Header Data Requirements

To GET JSON response, the request must have "Accept = application/json" header.

To GET XML response, the request should have "Accept = application/xml" header.

To POST/PUT JSON data, the request must have "Content-Type = application/json" header.

To POST/PUT XML data, the request should have "Content-Type = application/xml" header.

POST should also have "Accept = text/html" header. It returns the ID of the created object.

PUT and DELETE do not have any response, instead they return code 201 (No Content).

/users

Collection of users.

get post

get

Get a list of users.

post

Add a new user.

Add a new user.

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

Properties
  • 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)
  • 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"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a user.

get

Get the user with userId = {userId}.

put

Update the user with userId = {userId}.

Note: Provide all properties since all fields are updated.

delete

Delete the user.

Get the user with userId = {userId}.

URI Parameters

  • userId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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)
  • 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",
	"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",
	"settings": "CEC Agent",
	"timeZone": "Europe/Helsinki",
	"synchronised": true,
	"crmId": "j.fox",
	"businessObjectsId": "john.fox",
	"presenceId": "john.fox",
	"forwardNumber": "5569",
	"title": "Customer Service Supervisor",
	"location": "Helsinki",
	"recordingMode":"ForcedVisible"
}

Update the user with userId = {userId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • userId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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)
  • 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)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the user.

URI Parameters

  • userId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of userGroups.

get

Get a list of userGroups for user.

post

Add user group for user.

Get a list of userGroups for user.

URI Parameters

  • userId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: userGroups

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

    Added by the system

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

Example:

[
  {
    "id": "7B9ED6753BCD460C98501E9FD1C02002",
    "name": "HelpDesk"
  },
  {
    "id": "7211703C1CF047D9AA1B6FD5B2B35640",
    "name": "IT"
  },
  {
    "id": "FDA4CD5052144FFBB3794EC7ADF7EFD5",
    "name": "Partner Support"
  }
]

Add user group for user.

URI Parameters

  • userId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{"id":"A9934415A02845B69389008CF1F27EAB"}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

A9934415A02845B69389008CF1F27EAB

get delete

Entity representing a userGroup.

get

Get the userGroup with userGroupId = {userGroupId}.

delete

Remove user from user group.

Get the userGroup with userGroupId = {userGroupId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{
  "id":"7B9ED6753BCD460C98501E9FD1C02002",
  "name": "HelpDesk",
  "synchronised": true
}

Remove user from user group.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: any

Example:

{"message": "The user has been removed properly from user group."}

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of roles.

get

Get a list of roles for user.

post

Add role for user.

Get a list of roles for user.

URI Parameters

  • userId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: roles

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

    Added by the system

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

Example:

[
  {
    "id": "2CADB6A137124F13BC68938E2B5FEFC1",
    "name": "CC Agent"
  },
  {
    "id": "F4E0E3C6AEC64BEA9200DCC05F5980F1",
    "name": "CC Supervisor"
  },
  {
    "id": "C2ED670838344EC4B6F0E620D3206B8D",
    "name": "Office User"
  }
]

Add role for user.

URI Parameters

  • userId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{"id":"2CADB6A137124F13BC68938E2B5FEFC1"}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

2CADB6A137124F13BC68938E2B5FEFC1

get delete

Entity representing a role.

get

Get the role with roleId = {roleId}.

delete

Remove user from role.

Get the role with roleId = {roleId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{
  "id": "2CADB6A137124F13BC68938E2B5FEFC1",
  "name": "CC Agent",
  "description": "CC Agent Role"
}

Remove user from role.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of certificates.

get

Get a list of certificates for user.

post

Add certificate for user.

Get a list of certificates for user.

URI Parameters

  • userId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: certificates

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

Example:

[
  {
    "id": "5D3A260F9F1D4BBFA5A3ADACFFE6C97B",
    "issuer": "SSO_CA",
    "subject": "john.fox"
  },
  {
    "id": "6BEDFB8244494A698164CE0C2594C6FF",
    "issuer": "SSO_CA",
    "subject": "i123456"
  }
]

Add certificate for user.

URI Parameters

  • userId: required(string)

Body

Media type: application/json

Type: object

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

5D3A260F9F1D4BBFA5A3ADACFFE6C97B

get delete

Entity representing a certificate.

get

Get the certificate with certificateId = {certificateId}.

delete

Delete user certificate.

Get the certificate with certificateId = {certificateId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

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

Example:

{
  "id": "5D3A260F9F1D4BBFA5A3ADACFFE6C97B",
  "issuer": "SSO_CA",
  "subject": "john.fox"
}

Delete user certificate.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of skills.

get

Get a list of skills for user.

post

Add skill for user.

Get a list of skills for user.

URI Parameters

  • userId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Skill ID.

  • value: required(integer)

    Skill value 1-5.

Example:

[
  {
    "id": "175A098FEDDB41EB8839AACBAB26A0B6",
    "value": 5
  },
  {
    "id": "9B87EDA47F394762A510811F368A0ABA",
    "value": 4
  },
  {
    "id": "ABFF5E5BC1E44E90877C55570D06E8A7",
    "value": 3
  }
]

Add skill for user.

URI Parameters

  • userId: required(string)

Body

Media type: application/json

Type: object

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

    Skill ID.

  • value: required(integer)

    Skill value 1-5.

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

ABFF5E5BC1E44E90877C55570D06E8A7

get put delete

Entity representing a skill.

get

Get user's skill value.

put

Update user's skill value.

delete

Delete user skill.

Get user's skill value.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Skill ID.

  • value: required(integer)

    Skill value 1-5.

Example:

{
  "id": "175A098FEDDB41EB8839AACBAB26A0B6",
  "value": 5
}

Update user's skill value.

URI Parameters

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

Body

Media type: application/json

Type: object

Properties
  • value: required(integer)

    Skill value 1-5.

Example:

{"value": 3}

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete user skill.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/userGroups

Collection of userGroups.

get post

get

Get a list of userGroups.

post

Add a new userGroup.

Add a new userGroup.

Body

Media type: application/json

Type: object

Properties
  • 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
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a userGroup.

get

Get the userGroup with userGroupId = {userGroupId}.

put

Update the userGroup with userGroupId = {userGroupId}.

Note: Provide all properties since all fields are updated.

delete

Delete the userGroup.

Get the userGroup with userGroupId = {userGroupId}.

URI Parameters

  • userGroupId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{
  "id":"7B9ED6753BCD460C98501E9FD1C02002",
  "name": "HelpDesk",
  "synchronised": true
}

Update the userGroup with userGroupId = {userGroupId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • userGroupId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the userGroup.

URI Parameters

  • userGroupId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of users.

get

Get a list of users in user group.

post

Add user into user group.

Get a list of users in user group.

URI Parameters

  • userGroupId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: users

  • 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)

Example:

[
  {
    "id": "E936C474B22311D38FBE0090279A922E",
    "firstName": "John",
    "surname": "Fox"
    // + all fields used in query parameter
  },
  {
    "id": "40ECCFBFAEA24FEDA90A3347E9BC26E7",
    "firstName": "David",
    "surname": "Duck"
    // + all fields used in query parameter
  },
  {
    "id": "DC76CDDC340B43C291932428B6039AA6",
    "firstName": "Peter",
    "surname": "Frog"
    // + all fields used in query parameter
  }
]

Add user into user group.

URI Parameters

  • userGroupId: required(string)

Body

Media type: application/json

Type: object

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

    Id of the object.

Example:

{
  "id":"E936C474B22311D38FBE0090279A922E"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

E936C474B22311D38FBE0090279A922E

get delete

Entity representing a user.

get

Get the user with userId = {userId}.

delete

Remove user from user group.

Get the user with userId = {userId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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)

Example:

{
	"id":"E936C474B22311D38FBE0090279A922E",
	"firstName": "John",
	"surname": "Fox"
}

Remove user from user group.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/userSettingsTemplates

Collection of userSettingsTemplates.

get post

get

Get a list of userSettingsTemplates.

post

Creates new user settings template. "copyFromId" query parameter is mandatory. All settings are copied from that existing user settings template, including those which can't be added using this service.

Supported settings in System Configurator order:

Communication Panel Settings: all

  • ECFUI_ReplyTemplateShortcutWin - "Reply Templates Shortcut (Windows)", default: alt+t
  • ECFUI_ReplyTemplateShortcutMac - "Reply Templates Shortcut (Mac)", default: alt+t
  • ECFUI_AutoActivateDefaultReplyTemplate - "Automate Sending First Chat Response", boolean 1 or 0, default: 0=false
  • ECFUI_DailyPauseTime - "Daily Pause Time", integer seconds, default: 1800 = 30 minutes
  • ECFUI_DailyWorkTime - "Daily Work Time", integer seconds, default: 30600 = 510 minutes = 8.5 hours
  • ECFUI_WrapupTimeDirect - "Personal Wrap-Up Time", integer seconds, default: 0 seconds
  • ECFUI_EnableNotReadyTimer - "Use Timer with Not Ready Status", boolean 1 or 0, default: 0=false
  • ECFUI_EnableAbsenceTimer - "Use Timer with Absence Profiles", boolean 1 or 0, default: 0=false
  • ECFUI_MaxRejectCount - "Number of Offerings Before Activating Not Ready", integer, default: 1
  • ECFUI_AutoAnswerDelay - "Delay for Auto-Answering", integer seconds, default: 5 seconds
  • ECFUI_AutoAnswerAutoAllocated - "Use Auto-Answering with Auto-Allocated Conversations", boolean 1 or 0, default: 0=false
  • ECFUI_AutoAnswerPicked - "Use Auto-Answering with Picked Conversations", boolean 1 or 0, default: 1=true
  • ECFUI_AutoAnswerDirect - "Use Auto-Answering with Direct Conversations", boolean 1 or 0, default: 0=false
  • ECFUI_PicklistEnabled - "Enable Picklist Feature", boolean 1 or 0, default: 1=true
  • ECFUI_PicklistHuntGroup - "Filter Picklist to Show Only Conversations from Hunt Group Queues", boolean 1 or 0, default: 0=false
  • ECFUI_PicklistActiveQueue - "Show Conversations from Agent's Active Queues in Picklist", boolean 1 or 0, default: 0=false
  • ECFUI_DefaultView - "Default Focus View", one of: QueueLogin,InteractionPicklist,UserInteractions, default: QueueLogin

Communication Panel Chat Input Cleanup: all

  • ECFUI_HtmlSanitizerAllowedTags - "Allowed HTML Tags", default: a,abbr,b,blockquote,body,br,center,code,div,em,font,h1,h2,h3,h4,h5,h6,i,label,li,ol,p,pre,small,source,span,strong,ul,u
  • ECFUI_HtmlSanitizerAllowedCssStyles - "Allowed CSS Styles in HTML", default: text-decoration,font-style,font-weight
  • ECFUI_HtmlSanitizerAllowedAttributes - "Allowed HTML Attributes", default: controls,href,src,style,target,title,type

Communication Panel Contact Center: all

  • ECFUI_EnableSupervisor - "Enable Supervisor Elements and Actions", boolean 1 or 0, default: 0=false
  • ECFUI_EnableSupervisorDenyButton - "Allow Call Monitoring", boolean 1 or 0, default: 1=true
  • ECFUI_SupervisorChatQueueAddress - "Internal Chat Queue Address", must contain @ character
  • ECFUI_ShowSupervisorDashboardLaunchButton - "Show Launch Button for Supervisor Dashboard", boolean 1 or 0, default: 0=false

CDT Personalization: none

CDT Directory: none

CDT Shortcut Keys: none

Recording: only 1

  • CDT_CUI_SOL_PHONE_callrecordinglistenlog - "Log Recording Listenings", boolean 1 or 0, default: 1=true

CDT Phone Settings: only 1

  • CDT_CUI_SOL_PHONE_visibleanumber - "Visible A Number", external phone number.

CDT Audio Settings: none

CDT Contact Center: none

Multiterminal Desktop / Simultaneous Ring: a few

  • CDT_CUI_SOL_PHONE_phonemtdactive - "Use MTD / Simultaneous Ring Mode", boolean 1 or 0, default: 0=false
  • CDT_CUI_SOL_PHONE_phonemtdinotheractive - "Activate Other Number", boolean 1 or 0, default: 0=false
  • CDT_CUI_SOL_PHONE_phonemtdinothernumber - "Other Number", must be empty, can only set "forced" field
  • CDT_CUI_SOL_PHONE_phonemtdoutterminal - "Terminal for Outbound Calls", one of: VIRTUAL,HARDPHONE,GSM,OTHER

Contact Settings: a few

  • CDT_CUI_SOL_autopwtime - "Wrap-Up Time", integer seconds, default: 3
  • CRMMultiChat - "Enable Multi-Chat", boolean 1 or 0, default: 1=true
  • MultiChatMaxSessions - "Maximum Number of Chat Sessions", integer, default: 2
  • EcfEmail - "Use ECF for E-Mail", boolean 1 or 0, default: 1=true

SAP Service Cloud (C4C) Integration: all

  • CRMCOD_directcallurl - "URL for Direct Calls"
  • CRMCOD_queuecallurl - "URL for Queue Calls"
  • ECFUI_C4CIntegration - "Enable Communication Panel Integration with SAP Service Cloud (C4C)", boolean 1 or 0, default: 1=true

ServiceNow Integration: all

  • ECFUI_ServiceNowPhoneIntegration - "Enable ServiceNow Integration for Phone Channel", boolean 1 or 0, default: 0=false
  • ECFUI_ServiceNowChatIntegration - "Enable ServiceNow Integration for Chat Channel", boolean 1 or 0, default: 0=false
  • ECFUI_ServiceNowAddress - "ServiceNow Host Address"

Salesforce Integration: all

  • ECFUI_SalesforceIntegration - "Enable Salesforce Integration", boolean 1 or 0, default: 0=false
  • ECFUI_SalesforceOpenCPInPopout - "Use Communication Panel in Separate Window", boolean 1 or 0, default: 0=false

Dynamics 365 Integration: all

  • ECFUI_Dynamics365PhoneIntegration - "Enable Dynamics 365 Integration for Phone Channel", boolean 1 or 0, default: 0=false
  • ECFUI_Dynamics365CPWidth - "Embedded Communication Panel Width (px)", integer, default: 550 px
  • ECFUI_Dynamics365HostAddress - "Dynamics 365 Host Address"

CMC Settings: none

DTMF Mapping for Presence Profiles: none

User's Directory Fields: none

Creates new user settings template. "copyFromId" query parameter is mandatory. All settings are copied from that existing user settings template, including those which can't be added using this service.

Supported settings in System Configurator order:

Communication Panel Settings: all

  • ECFUI_ReplyTemplateShortcutWin - "Reply Templates Shortcut (Windows)", default: alt+t
  • ECFUI_ReplyTemplateShortcutMac - "Reply Templates Shortcut (Mac)", default: alt+t
  • ECFUI_AutoActivateDefaultReplyTemplate - "Automate Sending First Chat Response", boolean 1 or 0, default: 0=false
  • ECFUI_DailyPauseTime - "Daily Pause Time", integer seconds, default: 1800 = 30 minutes
  • ECFUI_DailyWorkTime - "Daily Work Time", integer seconds, default: 30600 = 510 minutes = 8.5 hours
  • ECFUI_WrapupTimeDirect - "Personal Wrap-Up Time", integer seconds, default: 0 seconds
  • ECFUI_EnableNotReadyTimer - "Use Timer with Not Ready Status", boolean 1 or 0, default: 0=false
  • ECFUI_EnableAbsenceTimer - "Use Timer with Absence Profiles", boolean 1 or 0, default: 0=false
  • ECFUI_MaxRejectCount - "Number of Offerings Before Activating Not Ready", integer, default: 1
  • ECFUI_AutoAnswerDelay - "Delay for Auto-Answering", integer seconds, default: 5 seconds
  • ECFUI_AutoAnswerAutoAllocated - "Use Auto-Answering with Auto-Allocated Conversations", boolean 1 or 0, default: 0=false
  • ECFUI_AutoAnswerPicked - "Use Auto-Answering with Picked Conversations", boolean 1 or 0, default: 1=true
  • ECFUI_AutoAnswerDirect - "Use Auto-Answering with Direct Conversations", boolean 1 or 0, default: 0=false
  • ECFUI_PicklistEnabled - "Enable Picklist Feature", boolean 1 or 0, default: 1=true
  • ECFUI_PicklistHuntGroup - "Filter Picklist to Show Only Conversations from Hunt Group Queues", boolean 1 or 0, default: 0=false
  • ECFUI_PicklistActiveQueue - "Show Conversations from Agent's Active Queues in Picklist", boolean 1 or 0, default: 0=false
  • ECFUI_DefaultView - "Default Focus View", one of: QueueLogin,InteractionPicklist,UserInteractions, default: QueueLogin

Communication Panel Chat Input Cleanup: all

  • ECFUI_HtmlSanitizerAllowedTags - "Allowed HTML Tags", default: a,abbr,b,blockquote,body,br,center,code,div,em,font,h1,h2,h3,h4,h5,h6,i,label,li,ol,p,pre,small,source,span,strong,ul,u
  • ECFUI_HtmlSanitizerAllowedCssStyles - "Allowed CSS Styles in HTML", default: text-decoration,font-style,font-weight
  • ECFUI_HtmlSanitizerAllowedAttributes - "Allowed HTML Attributes", default: controls,href,src,style,target,title,type

Communication Panel Contact Center: all

  • ECFUI_EnableSupervisor - "Enable Supervisor Elements and Actions", boolean 1 or 0, default: 0=false
  • ECFUI_EnableSupervisorDenyButton - "Allow Call Monitoring", boolean 1 or 0, default: 1=true
  • ECFUI_SupervisorChatQueueAddress - "Internal Chat Queue Address", must contain @ character
  • ECFUI_ShowSupervisorDashboardLaunchButton - "Show Launch Button for Supervisor Dashboard", boolean 1 or 0, default: 0=false

CDT Personalization: none

CDT Directory: none

CDT Shortcut Keys: none

Recording: only 1

  • CDT_CUI_SOL_PHONE_callrecordinglistenlog - "Log Recording Listenings", boolean 1 or 0, default: 1=true

CDT Phone Settings: only 1

  • CDT_CUI_SOL_PHONE_visibleanumber - "Visible A Number", external phone number.

CDT Audio Settings: none

CDT Contact Center: none

Multiterminal Desktop / Simultaneous Ring: a few

  • CDT_CUI_SOL_PHONE_phonemtdactive - "Use MTD / Simultaneous Ring Mode", boolean 1 or 0, default: 0=false
  • CDT_CUI_SOL_PHONE_phonemtdinotheractive - "Activate Other Number", boolean 1 or 0, default: 0=false
  • CDT_CUI_SOL_PHONE_phonemtdinothernumber - "Other Number", must be empty, can only set "forced" field
  • CDT_CUI_SOL_PHONE_phonemtdoutterminal - "Terminal for Outbound Calls", one of: VIRTUAL,HARDPHONE,GSM,OTHER

Contact Settings: a few

  • CDT_CUI_SOL_autopwtime - "Wrap-Up Time", integer seconds, default: 3
  • CRMMultiChat - "Enable Multi-Chat", boolean 1 or 0, default: 1=true
  • MultiChatMaxSessions - "Maximum Number of Chat Sessions", integer, default: 2
  • EcfEmail - "Use ECF for E-Mail", boolean 1 or 0, default: 1=true

SAP Service Cloud (C4C) Integration: all

  • CRMCOD_directcallurl - "URL for Direct Calls"
  • CRMCOD_queuecallurl - "URL for Queue Calls"
  • ECFUI_C4CIntegration - "Enable Communication Panel Integration with SAP Service Cloud (C4C)", boolean 1 or 0, default: 1=true

ServiceNow Integration: all

  • ECFUI_ServiceNowPhoneIntegration - "Enable ServiceNow Integration for Phone Channel", boolean 1 or 0, default: 0=false
  • ECFUI_ServiceNowChatIntegration - "Enable ServiceNow Integration for Chat Channel", boolean 1 or 0, default: 0=false
  • ECFUI_ServiceNowAddress - "ServiceNow Host Address"

Salesforce Integration: all

  • ECFUI_SalesforceIntegration - "Enable Salesforce Integration", boolean 1 or 0, default: 0=false
  • ECFUI_SalesforceOpenCPInPopout - "Use Communication Panel in Separate Window", boolean 1 or 0, default: 0=false

Dynamics 365 Integration: all

  • ECFUI_Dynamics365PhoneIntegration - "Enable Dynamics 365 Integration for Phone Channel", boolean 1 or 0, default: 0=false
  • ECFUI_Dynamics365CPWidth - "Embedded Communication Panel Width (px)", integer, default: 550 px
  • ECFUI_Dynamics365HostAddress - "Dynamics 365 Host Address"

CMC Settings: none

DTMF Mapping for Presence Profiles: none

User's Directory Fields: none

Query Parameters

  • copyFromId: required(string)

    Mandatory - copy settings from another userSettingsTemplate.

    Example:

    copyFromId=8108B8FF0BC145C2B3FE0400247EB52F

Body

Media type: application/json

Type: object

Properties
  • 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
    }
  ]
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a userSettingsTemplate.

get

Get the userSettingsTemplate with userSettingsTemplateId = {userSettingsTemplateId}.

put

Updates only those settings that are included. See POST /userSettingsTemplates for a list of supported settings.

delete

Delete the userSettingsTemplate.

Get the userSettingsTemplate with userSettingsTemplateId = {userSettingsTemplateId}.

URI Parameters

  • userSettingsTemplateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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": "CDT_CUI_SOL_PHONE_callrecordinglistenlog",
      "value": "1",
      "forced": true
    },
    {
      "name": "CDT_CUI_SOL_PHONE_phonemtdactive",
      "value": "0",
      "forced": false
    },
    {
      "name": "CDT_CUI_SOL_PHONE_visibleanumber",
      "value": "",
      "forced": false
    },
    {
      "name": "CDT_CUI_SOL_autopwtime",
      "value": "0",
      "forced": false
    },
    {
      "name": "CRMCOD_directcallurl",
      "value": "http://localhost:36729/?CID=BCM1234",
      "forced": true
    },
    {
      "name": "CRMCOD_queuecallurl",
      "value": "http://localhost:36729/?CID=BCM1234",
      "forced": true
    },
    {
      "name": "CRMMultiChat",
      "value": "1",
      "forced": false
    },
    {
      "name": "ECFUI_AutoActivateDefaultReplyTemplate",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_AutoAnswerAutoAllocated",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_AutoAnswerDelay",
      "value": "5",
      "forced": true
    },
    {
      "name": "ECFUI_AutoAnswerDirect",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_AutoAnswerPicked",
      "value": "1",
      "forced": true
    },
    {
      "name": "ECFUI_C4CIntegration",
      "value": "1",
      "forced": true
    },
    {
      "name": "ECFUI_DailyPauseTime",
      "value": "1800",
      "forced": true
    },
    {
      "name": "ECFUI_DailyWorkTime",
      "value": "30600",
      "forced": true
    },
    {
      "name": "ECFUI_DefaultView",
      "value": "QueueLogin",
      "forced": true
    },
    {
      "name": "ECFUI_Dynamics365CPWidth",
      "value": "550",
      "forced": true
    },
    {
      "name": "ECFUI_Dynamics365HostAddress",
      "value": "",
      "forced": true
    },
    {
      "name": "ECFUI_Dynamics365PhoneIntegration",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_EnableAbsenceTimer",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_EnableNotReadyTimer",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_EnableSupervisor",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_EnableSupervisorDenyButton",
      "value": "1",
      "forced": true
    },
    {
      "name": "ECFUI_HtmlSanitizerAllowedAttributes",
      "value": "align,color,controls,height,href,src,style,target,title,type,width",
      "forced": true
    },
    {
      "name": "ECFUI_HtmlSanitizerAllowedCssStyles",
      "value": "color,background-color,font-size,font-weight,text-align,text-decoration",
      "forced": true
    },
    {
      "name": "ECFUI_HtmlSanitizerAllowedTags",
      "value": "a,abbr,b,blockquote,body,br,center,code,div,em,font,h1,h2,h3,h4,h5,h6,hr,i,img,label,li,ol,p,pre,small,source,span,strong,table,tbody,td,th,thead,tr,u,ul,video",
      "forced": true
    },
    {
      "name": "ECFUI_MaxRejectCount",
      "value": "1",
      "forced": true
    },
    {
      "name": "ECFUI_PicklistActiveQueue",
      "value": "0",
      "forced": false
    },
    {
      "name": "ECFUI_PicklistEnabled",
      "value": "1",
      "forced": true
    },
    {
      "name": "ECFUI_PicklistHuntGroup",
      "value": "0",
      "forced": false
    },
    {
      "name": "ECFUI_ReplyTemplateShortcutMac",
      "value": "alt+t",
      "forced": true
    },
    {
      "name": "ECFUI_ReplyTemplateShortcutWin",
      "value": "alt+t",
      "forced": true
    },
    {
      "name": "ECFUI_SalesforceIntegration",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_SalesforceOpenCPInPopout",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_ServiceNowAddress",
      "value": "",
      "forced": true
    },
    {
      "name": "ECFUI_ServiceNowChatIntegration",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_ServiceNowPhoneIntegration",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_ShowSupervisorDashboardLaunchButton",
      "value": "0",
      "forced": true
    },
    {
      "name": "ECFUI_SupervisorChatQueueAddress",
      "value": "",
      "forced": true
    },
    {
      "name": "ECFUI_WrapupTimeDirect",
      "value": "0",
      "forced": true
    },
    {
      "name": "EcfEmail",
      "value": "1",
      "forced": true
    },
    {
      "name": "MultiChatMaxSessions",
      "value": "4",
      "forced": false
    }
  ],
  "id": "3B86545F79934F76A48706BCAB64E16A"
}

Updates only those settings that are included. See POST /userSettingsTemplates for a list of supported settings.

URI Parameters

  • userSettingsTemplateId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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.

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the userSettingsTemplate.

URI Parameters

  • userSettingsTemplateId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of settings.

get

Get a list of settings in user settings template.

post

Add or update setting into user settings template. See POST /userSettingsTemplates for a list of supported settings.

Get a list of settings in user settings template.

URI Parameters

  • userSettingsTemplateId: required(string)

Query Parameters

  • name: (string)

    Filter result array to have only one setting.

    Example:

    name=MultiChatMaxSessions

HTTP status code 200

Body

Media type: application/json

Type: array of settings

Example:

[
  {
    "name": "CDT_CUI_SOL_PHONE_callrecordinglistenlog",
    "value": "1",
    "forced": true
  },
  {
    "name": "CDT_CUI_SOL_PHONE_phonemtdactive",
    "value": "0",
    "forced": false
  },
  {
    "name": "CDT_CUI_SOL_PHONE_visibleanumber",
    "value": "",
    "forced": false
  },
  {
    "name": "CDT_CUI_SOL_autopwtime",
    "value": "0",
    "forced": false
  },
  {
    "name": "CRMCOD_directcallurl",
    "value": "http://localhost:36729/?CID=BCM1234",
    "forced": true
  },
  {
    "name": "CRMCOD_queuecallurl",
    "value": "http://localhost:36729/?CID=BCM1234",
    "forced": true
  },
  {
    "name": "CRMMultiChat",
    "value": "1",
    "forced": false
  },
  {
    "name": "ECFUI_AutoActivateDefaultReplyTemplate",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_AutoAnswerAutoAllocated",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_AutoAnswerDelay",
    "value": "5",
    "forced": true
  },
  {
    "name": "ECFUI_AutoAnswerDirect",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_AutoAnswerPicked",
    "value": "1",
    "forced": true
  },
  {
    "name": "ECFUI_C4CIntegration",
    "value": "1",
    "forced": true
  },
  {
    "name": "ECFUI_DailyPauseTime",
    "value": "1800",
    "forced": true
  },
  {
    "name": "ECFUI_DailyWorkTime",
    "value": "30600",
    "forced": true
  },
  {
    "name": "ECFUI_DefaultView",
    "value": "QueueLogin",
    "forced": true
  },
  {
    "name": "ECFUI_Dynamics365CPWidth",
    "value": "550",
    "forced": true
  },
  {
    "name": "ECFUI_Dynamics365HostAddress",
    "value": "",
    "forced": true
  },
  {
    "name": "ECFUI_Dynamics365PhoneIntegration",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_EnableAbsenceTimer",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_EnableNotReadyTimer",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_EnableSupervisor",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_EnableSupervisorDenyButton",
    "value": "1",
    "forced": true
  },
  {
    "name": "ECFUI_HtmlSanitizerAllowedAttributes",
    "value": "align,color,controls,height,href,src,style,target,title,type,width",
    "forced": true
  },
  {
    "name": "ECFUI_HtmlSanitizerAllowedCssStyles",
    "value": "color,background-color,font-size,font-weight,text-align,text-decoration",
    "forced": true
  },
  {
    "name": "ECFUI_HtmlSanitizerAllowedTags",
    "value": "a,abbr,b,blockquote,body,br,center,code,div,em,font,h1,h2,h3,h4,h5,h6,hr,i,img,label,li,ol,p,pre,small,source,span,strong,table,tbody,td,th,thead,tr,u,ul,video",
    "forced": true
  },
  {
    "name": "ECFUI_MaxRejectCount",
    "value": "1",
    "forced": true
  },
  {
    "name": "ECFUI_PicklistActiveQueue",
    "value": "0",
    "forced": false
  },
  {
    "name": "ECFUI_PicklistEnabled",
    "value": "1",
    "forced": true
  },
  {
    "name": "ECFUI_PicklistHuntGroup",
    "value": "0",
    "forced": false
  },
  {
    "name": "ECFUI_ReplyTemplateShortcutMac",
    "value": "alt+t",
    "forced": true
  },
  {
    "name": "ECFUI_ReplyTemplateShortcutWin",
    "value": "alt+t",
    "forced": true
  },
  {
    "name": "ECFUI_SalesforceIntegration",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_SalesforceOpenCPInPopout",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_ServiceNowAddress",
    "value": "",
    "forced": true
  },
  {
    "name": "ECFUI_ServiceNowChatIntegration",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_ServiceNowPhoneIntegration",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_ShowSupervisorDashboardLaunchButton",
    "value": "0",
    "forced": true
  },
  {
    "name": "ECFUI_SupervisorChatQueueAddress",
    "value": "",
    "forced": true
  },
  {
    "name": "ECFUI_WrapupTimeDirect",
    "value": "0",
    "forced": true
  },
  {
    "name": "EcfEmail",
    "value": "1",
    "forced": true
  },
  {
    "name": "MultiChatMaxSessions",
    "value": "4",
    "forced": false
  }
]

Add or update setting into user settings template. See POST /userSettingsTemplates for a list of supported settings.

URI Parameters

  • userSettingsTemplateId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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
}

HTTP status code 201

Returns the name of the added or updated setting.

Body

Media type: text/html

Type: any

Example:

MultiChatMaxSessions

/queues

Collection of queues.

get post

get

Get a list of queues.

post

Add a new queue.

Add a new queue.

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

Properties
  • 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

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a queue.

get

Get the queue with queueId = {queueId}.

put

Update the queue with queueId = {queueId}.

Note: Provide all properties since all fields are updated.

delete

Delete the queue.

Get the queue with queueId = {queueId}.

URI Parameters

  • queueId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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

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

Example:

{
  "id": "B8F0CA9CFC0411D3A2230050DA29E0F4",
  "type": "Phone",
  "name":  "Sales",
  "description": "Sales phone",
  "loginType": "AutoAllocation",
  "addresses":{"address":["100"]},
  "synchronised": true,
  "forwardNumber": "800"
}

Update the queue with queueId = {queueId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • queueId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the queue.

URI Parameters

  • queueId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of extensions.

get

Get a list of extensions for queue.

post

Add a new extension.

Get a list of extensions for queue.

URI Parameters

  • queueId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: extensions

  • 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:

[
  {
    "id": "A8F2AC742E914654B9AB5F420406B828",
    "address": "101"
  },
  {
    "id": "CB5AF61A7E2C4E728C62069A85EB73BA",
    "address": "102
  }
]

Add a new extension.

URI Parameters

  • queueId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a extension.

get

Get the extension with extensionId = {extensionId}.

put

Update the extension with extensionId = {extensionId}.

Note: Provide all properties since all fields are updated.

delete

Delete the extension.

Get the extension with extensionId = {extensionId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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:

{
  "id": "A8F2AC742E914654B9AB5F420406B828",
  "address": "101"
}

Update the extension with extensionId = {extensionId}.

Note: Provide all properties since all fields are updated.

URI Parameters

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

Body

Media type: application/json

Type: object

Properties
  • 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".

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the extension.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of queueGroups.

get

Get a list of queue groups for queue.

post

Add queue group for queue.

Get a list of queue groups for queue.

URI Parameters

  • queueId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: queueGroups

  • 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",
    "name": "CC Agent"
  },
  {
    "id": "E8E5E74E1CB540458639310940C07BA5",
    "name": "CC Helpdesk"
  },
  {
    "id": "BE5F74207C51437CB1B749E608DEB30F",
    "name": "CC Support"
  }
]

Add queue group for queue.

URI Parameters

  • queueId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

2CADB6A137124F13BC68938E2B5FEFC1

get delete

Entity representing a queueGroup.

get

Get the queueGroup with queueGroupId = {queueGroupId}.

delete

Remove queue from queue group.

Get the queueGroup with queueGroupId = {queueGroupId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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":"2CADB6A137124F13BC68938E2B5FEFC1",
  "name": "CC Agent"
}

Remove queue from queue group.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of attributes.

get

Get a list of attributes.

post

Add a new attribute.

Get a list of attributes.

URI Parameters

  • queueId: required(string)

Query Parameters

  • any fields: (string)

    &field1=value1&field2=value2...
    Values may contain patterns * and ?
    Valid searchable fields: name, language

    Example:

    name=HelpDesk

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: attributes

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

Example:

[
  {
      name: "Name",
      language: "EN",
      value: "Sales"
  },
  {
      name: "Name",
      language: "FI",
      value: "Myynti"
  }
]

Add a new attribute.

URI Parameters

  • queueId: required(string)

Body

Media type: application/json

Type: object

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

/queueGroups

Collection of queueGroups.

get post

get

Get a list of queueGroups.

post

Add a new queueGroup.

Add a new queueGroup.

Body

Media type: application/json

Type: object

Properties
  • 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"
  }
]

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

2CADB6A1-3712-4F13-BC68-938E2B5FEFC1

get put delete

Entity representing a queueGroup.

get

Get the queueGroup with queueGroupId = {queueGroupId}.

put

Update the queueGroup with queueGroupId = {queueGroupId}.

Note: Provide all properties since all fields are updated.

delete

Delete the queueGroup.

Get the queueGroup with queueGroupId = {queueGroupId}.

URI Parameters

  • queueGroupId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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": "2CADB6A137124F13BC68938E2B5FEFC1",
  "description": "CC Agent queue group",
  "name": "CC Agent"
}

Update the queueGroup with queueGroupId = {queueGroupId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • queueGroupId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the queueGroup.

URI Parameters

  • queueGroupId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of queues.

get

Get a list of queues for queue group.

post

Add queue into queue group.

Get a list of queues for queue group.

URI Parameters

  • queueGroupId: required(string)

Query Parameters

  • any fields: (string)

    &field1=value1&field2=value2...
    Values may contain patterns * and ?
    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

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: queues

  • 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

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

Example:

[
  {
    "id": "B8F0CA9CFC0411D3A2230050DA29E0F4",
    "name": "Sales"
  },
  {
    "id": "409FBE1B217643089F291B8796174643",
    "name": "Helpdesk"
  }
  },
  {
    "id": "AA60293EB8AD49959C5B67A2B0A1DC84",
    "name": "Sales chat"
  },
  {
    "id": "7B2EB5F5DF62439690CF6D180A2009C8",
    "name": "Sales Email"
  }
]

Add queue into queue group.

URI Parameters

  • queueGroupId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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

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

Example:

{
  "id": "B8F0CA9CFC0411D3A2230050DA29E0F4"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

5D3A260F9F1D4BBFA5A3ADACFFE6C97B

get delete

Entity representing a queue.

get

Get the queue with queueId = {queueId}.

delete

Delete the queue.

Get the queue with queueId = {queueId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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

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

Example:

{
  "id": "B8F0CA9CFC0411D3A2230050DA29E0F4",
  "name": "Sales"
}

Delete the queue.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of attributes.

get

Get a list of attributes.

post

Add a new attribute.

Get a list of attributes.

URI Parameters

  • queueGroupId: required(string)

Query Parameters

  • any fields: (string)

    &field1=value1&field2=value2...
    Values may contain patterns * and ?
    Valid searchable fields: name, language

    Example:

    name=HelpDesk

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: attributes

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

Example:

[
  {
      name: "Name",
      language: "EN",
      value: "Sales"
  },
  {
      name: "Name",
      language: "FI",
      value: "Myynti"
  }
]

Add a new attribute.

URI Parameters

  • queueGroupId: required(string)

Body

Media type: application/json

Type: object

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

/roles

Collection of roles.

get post

get

Get a list of roles.

post

Add a new role.

Add a new role.

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

2CADB6A137124F13BC68938E2B5FEFC1

get put delete

Entity representing a role.

get

Get the role with roleId = {roleId}.

put

Update the role with roleId = {roleId}.

Note: Provide all properties since all fields are updated.

delete

Delete the role.

Get the role with roleId = {roleId}.

URI Parameters

  • roleId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{
  "id": "2CADB6A137124F13BC68938E2B5FEFC1",
  "name": "CC Agent",
  "description": "CC Agent Role"
}

Update the role with roleId = {roleId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • roleId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the role.

URI Parameters

  • roleId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of users.

get

Get a list of users having role.

post

Add role for user.

Get a list of users having role.

URI Parameters

  • roleId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: users

  • 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)

Example:

[
  {
    "id": "E936C474B22311D38FBE0090279A922E",
    "firstName": "John",
    "surname": "Fox"
    // + all fields used in query parameter
  },
  {
    "id": "40ECCFBFAEA24FEDA90A3347E9BC26E7",
    "firstName": "David",
    "surname": "Duck"
    // + all fields used in query parameter
  },
  {
    "id": "DC76CDDC340B43C291932428B6039AA6",
    "firstName": "Peter",
    "surname": "Frog"
    // + all fields used in query parameter
  }
]

Add role for user.

URI Parameters

  • roleId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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)
  • 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"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

E936C474B22311D38FBE0090279A922E

get delete

Entity representing a user.

get

Get the user with userId = {userId}.

delete

Remove role from user.

Get the user with userId = {userId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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)
  • 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",
	"firstName": "John",
	"surname": "Fox"
}

Remove role from user.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/skills

Collection of skills.

get post

get

Get a list of skills.

post

Add a new skill.

Add a new skill.

Body

Media type: application/json

Type: object

Properties
  • 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"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a skill.

get

Get the skill with skillId = {skillId}.

put

Update the skill with skillId = {skillId}.

Note: Provide all properties since all fields are updated.

delete

Delete the skill.

Get the skill with skillId = {skillId}.

URI Parameters

  • skillId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • 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": "175A098FEDDB41EB8839AACBAB26A0B6",
  "name": "English",
  "description": "English language skill"
}

Update the skill with skillId = {skillId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • skillId: required(string)

Body

Media type: application/json

Type: object

Properties
  • 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)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the skill.

URI Parameters

  • skillId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/scripts

Collection of scripts.

get

get

Get a list of scripts.

get

Entity representing a script.

get

Get the script with scriptId = {scriptId}.

Get the script with scriptId = {scriptId}.

URI Parameters

  • scriptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • remarks: (string)
  • type: required(one of STATIC, INTERACTIVE, CALLBACK)

    CALLBACK used in CDT only.

  • lockFirstQuestion: (boolean)

    Show first question always on top, default false.

  • questions: (array of ScriptQuestion)

    Array of questions for this script.

    Items: ScriptQuestion

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

      Added by the system

    • ordinal: required(integer)

      Identifies the question and specifies the order within the script.

    • question: required(string)

      Text for the actual question.

    • nextOrdinal: (integer)

      Next question ordinal. Can be used only in INTERACTIVE scripts.

    • controlType: required(one of INFO, RADIOBUTTON, CHECKBOX, DROPDOWNLIST, COMBOBOX, INPUTTEXT, TEXTAREA, DROPDOWNCHECKBOX)
    • dataType: (one of TEXT, INTEGER, FLOATING, DATETIME, CURRENCY)

      Can only be used for COMBOBOX, INPUTTEXT or TEXTAREA control types.

    • prefill: (integer)

      Max. number of answers.

    • mandatory: (boolean)

      Is it mandatory to answer this question, default false.

    • amount: (boolean)

      Is the answer used in amount calculations, default false.

    • width: (string)

      View setting for question width in pixels.

    • height: (string)

      View setting for question height in pixels.

    • answers: (array of ScriptAnswer)

      Array of answers for this questions. The following question types can have answers: RADIOBUTTON, CHECKBOX, DROPDOWNLIST, COMBOBOX, DROPDOWNCHECKBOX.

      Items: ScriptAnswer

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

        Added by the system

      • ordinal: required(integer)

        Identifies the answer and specifies the order within the question.

      • answer: required(string)
      • amount: (number)

        Can only be used if question amount=true.

      • recording: (boolean)

        Start recording if true, default false.

      • nextQuestion: (integer)

        Next question ordinal in INTERACTIVE scripts.

Example:

{
  "name": "ALL ELEMENTS",
  "remarks": "notes or remarks",
  "type": "STATIC",
  "lockFirstQuestion": false,
  "questions": [
    {
      "ordinal": 10,
      "question": "What?",
      "controlType": "CHECKBOX",
      "answers": [
        {
          "ordinal": 1,
          "answer": "Yes",
          "id": "B50FB75BB12548D3871B52594D34740A"
        },
        {
          "ordinal": 2,
          "answer": "No",
          "id": "2E94055607B142F5A59990B812AD992A"
        }
      ],
      "id": "C1862381333A439C93BDCE2AD9BCA231"
    },
    {
      "ordinal": 20,
      "question": "Who?",
      "controlType": "DROPDOWNCHECKBOX",
      "answers": [
        {
          "ordinal": 1,
          "answer": "Me",
          "id": "F95C7874BE6B46F5BE3B0D68BB0EEC2A"
        },
        {
          "ordinal": 2,
          "answer": "You",
          "id": "2FE7C04E43DE4512B2D28CBDAA4145D8"
        },
        {
          "ordinal": 3,
          "answer": "We",
          "id": "14507E87902C49BDA81AEF62B6801F29"
        }
      ],
      "id": "4BEF6AF409C04E77A90585CBAD8F875D"
    },
    {
      "ordinal": 30,
      "question": "Where?",
      "controlType": "DROPDOWNLIST",
      "answers": [
        {
          "ordinal": 2,
          "answer": "There",
          "id": "8884348C5F8D491C8B4548B537F2E6BB"
        },
        {
          "answer": "Everyewhere",
          "id": "90E50511A4AF430BBD43F2AD9A130B97"
        },
        {
          "answer": "Here",
          "id": "4DA7C7EF9D894594917145E73637E0E6"
        }
      ],
      "id": "5A5DD0F5D9CF4EAAB2C0D4EA95C7F7B8"
    },
    {
      "ordinal": 40,
      "question": "THis is just information so no answer.",
      "controlType": "INFO",
      "id": "A55A4F1EE2CE4361B2376368EC6D4682"
    },
    {
      "ordinal": 50,
      "question": "What for?",
      "controlType": "RADIOBUTTON",
      "answers": [
        {
          "ordinal": 1,
          "answer": "Because",
          "id": "73C04697693949318AEB6B1F1B6798CD"
        },
        {
          "ordinal": 2,
          "answer": "'cause I wanna",
          "id": "902B95BDA7F3476ABCAD980D1D101A35"
        }
      ],
      "id": "6E93E5B0168749789E4F0FE9DF12FA0C"
    },
    {
      "ordinal": 60,
      "question": "Combo box D&T",
      "controlType": "COMBOBOX",
      "dataType": "DATETIME",
      "answers": [
        {
          "answer": "10.12.2012",
          "id": "D7AE773CE764413B84DB0919AA28B114"
        },
        {
          "answer": "Aikapaika1",
          "id": "EA01CBF3980A4A048B35E955D9DDF1DA"
        },
        {
          "answer": "Aikapaika2",
          "id": "F0F400BA7F3C4FC8BD1503EBC699B15D"
        }
      ],
      "id": "ED2DE0289ACA47A0AAA8B41EA946033E"
    },
    {
      "ordinal": 70,
      "question": "Combo box Decimal",
      "controlType": "COMBOBOX",
      "dataType": "FLOATING",
      "answers": [
        {
          "answer": "1,23",
          "id": "2600DBBEF56547A7AB4841CA2F4D4247"
        },
        {
          "answer": "2,34",
          "id": "65E28B0456544E90834002C583BA9292"
        }
      ],
      "id": "480992EB520D4260A521E1CC22C5FE81"
    },
    {
      "ordinal": 80,
      "question": "Combo box Number",
      "controlType": "COMBOBOX",
      "dataType": "CURRENCY",
      "answers": [
        {
          "answer": "9876543,5",
          "id": "1BC7B1B5B31743CE9F828A229C2243DF"
        },
        {
          "answer": "1234,56732",
          "id": "5F64E8F88BBA4DA78696D87123F41438"
        }
      ],
      "id": "95A1678A08FF4377ACEB5CD712ACBD5C"
    },
    {
      "ordinal": 90,
      "question": "Combo box Text",
      "controlType": "COMBOBOX",
      "dataType": "TEXT",
      "answers": [
        {
          "answer": "plapla",
          "id": "C602D34E7B204B35A13E1593BA75B4A6"
        },
        {
          "answer": "PLAPLA",
          "id": "648C52519CBB44AFA502A5B75C5BADCF"
        }
      ],
      "id": "71BC4CEF5E0945379810AF9B1C3B6CA7"
    },
    {
      "ordinal": 100,
      "question": "Combo box WholeNUmber",
      "controlType": "COMBOBOX",
      "dataType": "INTEGER",
      "answers": [
        {
          "answer": "3",
          "id": "B8746CF8E7D34EFCB95DB95E8824CABD"
        },
        {
          "answer": "2",
          "id": "611A1991C6AF487DA7D801177628E502"
        },
        {
          "answer": "1",
          "id": "8584188DE38640238573E905EECE1465"
        }
      ],
      "id": "978A168C83AC44A8AFF05CA0439C4F1B"
    },
    {
      "ordinal": 110,
      "question": "Input Text Area D&T",
      "controlType": "TEXTAREA",
      "dataType": "DATETIME",
      "id": "8E0BB26182684F0B85D6B00F73A37A8B"
    },
    {
      "ordinal": 120,
      "question": "Input Text Area DEC",
      "controlType": "TEXTAREA",
      "dataType": "FLOATING",
      "id": "0A0362FE06DE4A55AF51D4F642FACF70"
    },
    {
      "ordinal": 130,
      "question": "Input Text Area NO",
      "controlType": "TEXTAREA",
      "dataType": "CURRENCY",
      "id": "290AE15A484A4A88815C4C517726930B"
    },
    {
      "ordinal": 140,
      "question": "Input Text Area TXT",
      "controlType": "TEXTAREA",
      "dataType": "TEXT",
      "id": "EC7DDFD80F8142468C59EA206CB690DD"
    },
    {
      "ordinal": 150,
      "question": "Input Text Area WN",
      "controlType": "TEXTAREA",
      "dataType": "INTEGER",
      "prefill": 4,
      "id": "AA0CF14D4CA14C6AAEA73941016D57D0"
    },
    {
      "ordinal": 160,
      "question": "Input Text Field D&T",
      "controlType": "INPUTTEXT",
      "dataType": "DATETIME",
      "prefill": 3,
      "mandatory": true,
      "id": "A762C9DA064C4879A4D6230A65D7D360"
    },
    {
      "ordinal": 170,
      "question": "Input Text Field DEC",
      "controlType": "INPUTTEXT",
      "dataType": "FLOATING",
      "id": "878C5CB537854F37B1F53471A0FB4F22"
    },
    {
      "ordinal": 180,
      "question": "CHECKBOX CURRENCY",
      "controlType": "CHECKBOX",
      "dataType": "CURRENCY",
      "answers": [
        {
          "ordinal": 1,
          "answer": "YEs",
          "id": "7630B447EB2141C3ADB2FA8C53BFE3B2"
        }
      ],
      "id": "F19DB100CB014A2288C6999C3DEF6EA7"
    },
    {
      "ordinal": 190,
      "question": "Input Text Field TXT",
      "controlType": "INPUTTEXT",
      "dataType": "TEXT",
      "id": "4D47C86ECB7C42F6BEAD9AF204DD5345"
    },
    {
      "ordinal": 200,
      "question": "Input Text Field WN",
      "controlType": "INPUTTEXT",
      "dataType": "INTEGER",
      "prefill": 6,
      "mandatory": true,
      "width": "30",
      "height": "30",
      "amount": true,
      "id": "123A6CB388C64C2BBAFD1C62BFF58B44"
    },
    {
      "ordinal": 210,
      "question": "radio and tv buttons <H1>here</H2>",
      "controlType": "RADIOBUTTON",
      "answers": [
        {
          "ordinal": 1,
          "answer": "1st",
          "id": "142F03600EB94F58B714B76117B07B22"
        },
        {
          "ordinal": 2,
          "answer": "2nd",
          "id": "21667AA5421B453FAEAB34E2AF130D9C"
        },
        {
          "ordinal": 3,
          "answer": "3rd",
          "id": "870EC5E691014FF19FF7362BB4545868"
        },
        {
          "ordinal": 4,
          "answer": "4th",
          "id": "23944F2462B94BA784DA16EBBBD017AF"
        }
      ],
      "id": "E04B2199438B4DB180D02209DB43F65B"
    }
  ],
  "id": "A1B0AA6C85014628B1ACB263F84C73B6"
}

/timeZones

Collection of timeZones.

get

get

Get a list of timeZones.

get

Entity representing a timeZone.

get

Get the timeZone with timeZoneId = {timeZoneId}.

Get the timeZone with timeZoneId = {timeZoneId}.

URI Parameters

  • timeZoneId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string)
  • name: required(string)

Example:

{
  "id": "Europe/Helsinki",
  "name":  "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius"
}

/prsProfiles

Collection of prsProfiles.

get

get

Get a list of prsProfiles.

get

Entity representing a prsProfile.

get

Get the prsProfile with prsProfileId = {prsProfileId}.

Get the prsProfile with prsProfileId = {prsProfileId}.

URI Parameters

  • prsProfileId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • reason: required(string)

Example:

{
  "id":"02770429F80BDF1191AD001CC4D98816",
  "name":"Default",
  "reason":"NONE"
}

/messagingServices

Collection of messagingServices.

get post

get

Get a list of messagingServices.

post

Add a new messagingService.

Add a new messagingService.

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • type: required(one of facebook, twilio, sap365, yaas)
  • connection: required(string)
  • authenticationScope: (string)
  • authenticationUrl: (string)

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a messagingService.

get

Get the messagingService with messagingServiceId = {messagingServiceId}.

put

Update the messagingService with messagingServiceId = {messagingServiceId}.

Note: Provide all properties since all fields are updated.

delete

Delete the messagingService.

Get the messagingService with messagingServiceId = {messagingServiceId}.

URI Parameters

  • messagingServiceId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • type: required(one of facebook, twilio, sap365, yaas)
  • connection: required(string)
  • authenticationScope: (string)
  • authenticationUrl: (string)

Example:

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

Update the messagingService with messagingServiceId = {messagingServiceId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • messagingServiceId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • type: required(one of facebook, twilio, sap365, yaas)
  • connection: required(string)
  • authenticationScope: (string)
  • authenticationUrl: (string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the messagingService.

URI Parameters

  • messagingServiceId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

get post

Collection of authentications.

get

Get a list of messaging service authentications.

post

Add Autehtication info to Messaging Service

Get a list of messaging service authentications.

URI Parameters

  • messagingServiceId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: authentications

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

    Added by the system

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

Example:

[
  {
    "id" : "AF8D906F2EDE40FC889303B52D26DA25",
    "authenticationId":"my_login_id"
  }
]

Add Autehtication info to Messaging Service

URI Parameters

  • messagingServiceId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

5D3A260F9F1D4BBFA5A3ADACFFE6C97B

get put delete

Entity representing a authentication.

get

Get the authentication with authenticationId = {authenticationId}.

put

Update the authentication with authenticationId = {authenticationId}.

Note: Provide all properties since all fields are updated.

delete

Delete the authentication.

Get the authentication with authenticationId = {authenticationId}.

URI Parameters

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

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

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

Example:

{
  "id" : "AF8D906F2EDE40FC889303B52D26DA25",
  "authenticationId":"my_login_id"
}

Update the authentication with authenticationId = {authenticationId}.

Note: Provide all properties since all fields are updated.

URI Parameters

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

Body

Media type: application/json

Type: object

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

    Added by the system

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the authentication.

URI Parameters

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

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/replyTemplates

Collection of replyTemplates.

get

get

Get a list of replyTemplates.

get

Entity representing a replyTemplate.

get

Get the replyTemplate with replyTemplateId = {replyTemplateId}.

Get the replyTemplate with replyTemplateId = {replyTemplateId}.

URI Parameters

  • replyTemplateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)
  • name: required(string)
  • description: (string - minLength: 1 - maxLength: 400)
  • language: required(string - minLength: 2 - maxLength: 4)
  • subject: (string - minLength: 0 - maxLength: 1024)
  • contentType: required(one of Static, Interactive)
  • attachmentCount: required(integer)
  • body: required(string)
  • keywords: (object)
    • keyword: (array of string)

Example:

{
    "id": "000BC39C7CC04554A95062CF4C6BBE06",
    "body": "Hello {CUSTOMERNAME}\n\nThank you for your message",
    "description": "this is a template",
    "language": "EN",
    "name": "template2",
    "contentType": "Static",
    "attachmentCount": 1,    
    "keywords": {
        "keyword": [
            "issue",
            "problem",
            "washing",
            "machine"
        ]
    }
}

get

Collection of attachments.

get

Get a list of attachments.

Get a list of attachments.

URI Parameters

  • replyTemplateId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: attachments

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

    Added by the system

  • size: required(integer)
  • fileName: required(string)
  • mimeType: required(string)

Example:

[
    {
       "size": 35917,
       "fileName": "picture.PNG",
       "mimeType": "image/png",
       "id": "D147D4339D1448158153B61D1F621AF9"
    },
    {
         "size": 56698,
         "fileName": "picture2.jpg",
         "mimeType": "image/jpeg",
         "id": "3D612DF2E3694A56A9253365CA8EEEFE"
     }
]

get

Entity representing a attachment.

get

Get the attachment with attachmentId = {attachmentId}.

Get the attachment with attachmentId = {attachmentId}.

URI Parameters

  • replyTemplateId: required(string)
  • attachmentId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • size: required(integer)
  • fileName: required(string)
  • mimeType: required(string)

Example:

{
     "size": 56698,
     "fileName": "picture2.jpg",
     "mimeType": "image/jpeg",
     "id": "3D612DF2E3694A56A9253365CA8EEEFE"
 }

/customIvrs

Collection of customIvrs.

get

get

Get a list of customIvrs.

get

Entity representing a customIvr.

get

Get the customIvr with customIvrId = {customIvrId}.

Get the customIvr with customIvrId = {customIvrId}.

URI Parameters

  • customIvrId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • addresses: (object)
    • address: (array of string)
  • name: required(string)
  • currentSourceCodeVersionId: (string - minLength: 32 - maxLength: 32)
  • active: required(boolean)

Example:

{
      "addresses": {
          "address": [
            "243",
            "234"
          ]
      },
      "name": "My Menu Ivr",
      "description": "Queue selection IVR",
      "currentSourceCodeVersionId": "BA78FF64DCEC40B885AF6D2C337D7C5D",
      "active": true,
      "id": "A5AF21AB416849BBA6FDBE92E5C15B69"
  }

get

Collection of sourceCodes.

get

Get a list of sourceCodes.

Get a list of sourceCodes.

URI Parameters

  • customIvrId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: sourceCodes

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

    Added by the system

  • versionNumber: required(number)
  • creationDate: required(datetime)
  • modificationDate: (datetime)
  • description: (string)

Example:

[
    {
        "modificationDate": "2020-01-21T13:10:47.493Z",
        "versionNumber": 1,
        "creationDate": "2020-01-21T13:10:33.293Z",
        "id": "C907169011AA48D8A6EE8F8F12423372"
    }
]

get

Entity representing a sourceCode.

get

Get the sourceCode with sourceCodeId = {sourceCodeId}.

Get the sourceCode with sourceCodeId = {sourceCodeId}.

URI Parameters

  • customIvrId: required(string)
  • sourceCodeId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • versionNumber: required(number)
  • creationDate: required(datetime)
  • modificationDate: (datetime)
  • description: (string)
  • sourceCode: (string)

Example:

{
    "description": "",
    "modificationDate": "2020-01-21T13:12:22Z",
    "sourceCode": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><vxml xmlns:bcm=\"http://bcm.sinch.com\" version=\"2.1\"><form id=\"form1\"><block name=\"blco1\"><audio src=\"42079722-0892-4A96-8163-82C5E1BFD686\" xml:lang=\"IT\"/></block></form></vxml>",
    "versionNumber": 1,
    "creationDate": "2020-01-21T13:10:33.293Z",
    "id": "C907169011AA48D8A6EE8F8F12423372"
}

get

Entity representing a currentSourceCodeVersion.

get

Get the currentSourceCodeVersion with currentSourceCodeVersionId = {currentSourceCodeVersionId}.

Get the currentSourceCodeVersion with currentSourceCodeVersionId = {currentSourceCodeVersionId}.

URI Parameters

  • customIvrId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • versionNumber: required(number)
  • creationDate: required(datetime)
  • modificationDate: (datetime)
  • description: (string)
  • sourceCode: (string)

Example:

{
    "description": "",
    "modificationDate": "2020-01-21T13:12:22Z",
    "sourceCode": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><vxml xmlns:bcm=\"http://bcm.sinch.com\" version=\"2.1\"><form id=\"form1\"><block name=\"blco1\"><audio src=\"42079722-0892-4A96-8163-82C5E1BFD686\" xml:lang=\"IT\"/></block></form></vxml>",
    "versionNumber": 1,
    "creationDate": "2020-01-21T13:10:33.293Z",
    "id": "C907169011AA48D8A6EE8F8F12423372"
}

get post

Collection of attributes.

get

Get a list of attributes.

post

Add a new attribute.

Get a list of attributes.

URI Parameters

  • customIvrId: required(string)

Query Parameters

  • any fields: (string)

    &field1=value1&field2=value2...
    Values may contain patterns * and ?
    Valid searchable fields: name, language

    Example:

    name=HelpDesk

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: attributes

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

Example:

[
  {
      name: "Name",
      language: "EN",
      value: "Sales"
  },
  {
      name: "Name",
      language: "FI",
      value: "Myynti"
  }
]

Add a new attribute.

URI Parameters

  • customIvrId: required(string)

Body

Media type: application/json

Type: object

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

Example:

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

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

/audioPrompts

Collection of audioPrompts.

get

get

Get a list of audioPrompts.

get

Entity representing a audioPrompt.

get

Get the audioPrompt with audioPromptId = {audioPromptId}.

Get the audioPrompt with audioPromptId = {audioPromptId}.

URI Parameters

  • audioPromptId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • description: (string)
  • promptType: required(one of BlindTransferFailed, ExtAgentAcceptQuestion, ExternalTransfer, ExternalTransferFailed, InQueue, InQueueBusy, InternalTransfer, IVRPrompt, OfferingPrompt, OnHold, PreWelcome, QueueFull, ServiceClosed, Welcome, WelcomeBusy)
  • loopType: required(one of ALL, LAST, RANDOM)
  • sourceType: required(one of Custom, QueueBuiltIn, UserBuiltIn, OptionalBuiltIn)

Example:

{
    "name": "InQueue (Built-In Default Prompt)",
    "description": "In queue message (the built-in default audio prompt)",
    "promptType": "InQueue",
    "sourceType": "QueueBuiltIn",
    "loopType": "RANDOM",
    "id": "EFF0CF25BC374F2982225C83BB21B3F3"
}

/cpExtensions

Collection of cpExtensions.

get

get

Get a list of cpExtensions.

get

Entity representing a cpExtension.

get

Get the cpExtension with cpExtensionId = {cpExtensionId}.

Get the cpExtension with cpExtensionId = {cpExtensionId}.

URI Parameters

  • cpExtensionId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: (string)

    Added by the system

  • description: (string)

    Added by the system

  • title: required(string)

    Translated title of the extension

  • url: required(string)

    URI location of the 3rd. party extension

  • icon: required(string)

    Sinch Icon library reference

  • queues: required(array of string)

    The queues this extension should be enabled for

  • hidden: required(boolean)

    Should the extension be visible or run in hidden mode

Example:

{
	"title": "MyExtension",
	"hidden": false,
	"url": "https://example.com/frame.html",
	"icon": "sap-icon://travel-request",
	"queues": ["B8F0CA9CFC0411D3A2230050DA29E0F4"],
	"id": "94C89D627D0340A2807B18D8B9C4CD90"
}

/disruptionSets

Collection of disruptionSets.

get

get

Get a list of disruptionSets.

get

Entity representing a disruptionSet.

get

Get the disruptionSet with disruptionSetId = {disruptionSetId}.

Get the disruptionSet with disruptionSetId = {disruptionSetId}.

URI Parameters

  • disruptionSetId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • name: required(string)
  • externalId: required(string)

Example:

{
    "name": "electricity",
    "externalId": "set1",
    "id": "14E14D7338C44EA5904A1E18180186FF"
}

get post

Collection of events.

get

Get a list of events.

post

Get a list of events.

URI Parameters

  • disruptionSetId: required(string)

Query Parameters

  • active: (boolean)

    search for active events

    Example:

    active=true
  • activeFrom: (string)

    Search for events that have the activeFrom value after the given UTC time

    Example:

    activeFrom=2020-06-29T12:00:00.000Z
  • activeFromEnd: (string)

    Search for events that have the activeFrom value before the given UTC time

    Example:

    activeFromEnd=2020-07-29T12:00:00.000Z
  • activeTo: (string)

    Search for events that have the activeTo value after the given UTC time

    Example:

    activeTo=2020-04-29T12:00:00.000Z
  • activeToEnd: (string)

    Search for events that have the activeTo value before the given UTC time

    Example:

    activeToEnd=2020-07-29T12:00:00.000Z
  • created: (string)

    Search for events that have the created value after the given UTC time

    Example:

    created=2020-06-29T12:00:00.000Z
  • createdEnd: (string)

    Search for events that have the created value before the given UTC time

    Example:

    createdEnd=2020-07-29T12:00:00.000Z
  • modified: (string)

    Search for events that have the modified value after the given UTC time

    Example:

    modified=2020-04-29T12:00:00.000Z
  • modifiedEnd: (string)

    Search for events that have the modified value before the given UTC time

    Example:

    modified=2020-07-29T12:00:00.000Z

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: events

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

    Added by the system

  • remarks: (string)
  • activeFrom: (datetime)
  • activeTo: (datetime)
  • modified: (datetime)
  • created: (datetime)
  • items: required(array of object)

    Items: items

    • id: required(string)
    • externalid: required(string)
    • type: required(one of WHY, WHERE, WHEN)

Example:

[
  {
    "id": "C21269BEA18B4146A219202DD8966FFA",
    "modified": "2020-12-29T12:01:00.000Z",
    "created": "2020-12-29T12:01:00.000Z",
    "items": {
        "item": [
            {
                "id": "4207972208924A96816382C5E1BFD686",
                "externalId": "05",
                "type": "WHY"
            },
            {
                "id": "8207972208924A96816382C5E18FD686",
                "externalId": "00100",
                "type": "WHERE"
            },
            {
                "id": "6207972208924A97816382C5E1BFD686",
                "externalId": "14",
                "type": "WHEN"
            }
        ]
    }
  },
  {
    "id": "C21269BEA18B4146A219202DD8966FFA",
    "modified": "2020-12-28T12:01:00.000Z",
    "created": "2020-12-28T12:01:00.000Z",
    "activeFrom": "2021-01-06T13:29:34.580Z",
    "activeTo": "2021-01-08T13:29:34.580Z",
    "items": {
        "item": [
            {
                "id": "4207972208924A96816382C5E1BFD686",
                "externalId": "05",
                "type": "WHY"
            },
            {
                "id": "8207972208924A96816382C5E18FD686",
                "externalId": "00200",
                "type": "WHERE"
            },
            {
                "id": "6207972208924A97816382C5E1BFD686",
                "externalId": "19",
                "type": "WHEN"
            }
        ]
    }
  }
]

URI Parameters

  • disruptionSetId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

  • remarks: (string)
  • activeFrom: (datetime)
  • activeTo: (datetime)
  • items: required(array of object)

    Either id or externalId and type are required for items

    Items: items

    • id: required(string)
    • externalid: required(string)
    • type: required(one of WHY, WHERE, WHEN)

Examples:

Items by id:

{
  "activeFrom": "2021-03-29T12:01:00.000Z",
  "activeTo": "2021-04-29T12:01:00.000Z",
  "items": {
      "item": [
          {
              "id": "4207972208924A96816382C5E1BFD686"
          },
          {
              "id": "921AF17CDD09411D91700F0B32F6C8A2"
          },
          {
              "id": "61809A9F49004C4399932A372ABF7692"
          }
      ]
  }
}

Items by externalId:

{
  "activeFrom": "2021-03-29T12:01:00.000Z",
  "activeTo": "2021-04-29T12:01:00.000Z",
  "items": {
      "item": [
          {
              "externalId": "05",
              "type": "WHY"
          },
          {
              "externalId": "90100",
              "type": "WHERE"
          },
          {
              "externalId": "1400",
              "type": "WHEN"
          }
      ]
  }
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get put delete

Entity representing a event.

get

Get the event with eventId = {eventId}.

put

Update the event with eventId = {eventId}.

Note: Provide all properties since all fields are updated.

delete

Delete the event.

Get the event with eventId = {eventId}.

URI Parameters

  • disruptionSetId: required(string)
  • eventId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • remarks: (string)
  • activeFrom: (datetime)
  • activeTo: (datetime)
  • modified: (datetime)
  • created: (datetime)
  • items: required(array of object)

    Items: items

    • id: required(string)
    • externalid: required(string)
    • type: required(one of WHY, WHERE, WHEN)

Example:

{
  "id": "C21269BEA18B4146A219202DD8966FFA",
  "modified": "2020-12-29T12:01:00.000Z",
  "created": "2020-12-29T12:01:00.000Z",
  "items": {
      "item": [
          {
              "id": "4207972208924A96816382C5E1BFD686",
              "externalId": "05",
              "type": "WHY"
          },
          {
              "id": "8207972208924A96816382C5E18FD686",
              "externalId": "00100",
              "type": "WHERE"
          },
          {
              "id": "6207972208924A97816382C5E1BFD686",
              "externalId": "14",
              "type": "WHEN"
          }
      ]
  }
}

Update the event with eventId = {eventId}.

Note: Provide all properties since all fields are updated.

URI Parameters

  • disruptionSetId: required(string)
  • eventId: required(string)

Body

Media type: application/json

Type: object

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

    Added by the system

  • remarks: (string)
  • activeFrom: (datetime)
  • activeTo: (datetime)
  • items: required(array of object)

    Either id or externalId and type are required for items

    Items: items

    • id: required(string)
    • externalid: required(string)
    • type: required(one of WHY, WHERE, WHEN)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

Delete the event.

URI Parameters

  • disruptionSetId: required(string)
  • eventId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

delete

delete

Delete all Disruption Events of this Disruption Set.

Delete all Disruption Events of this Disruption Set.

URI Parameters

  • disruptionSetId: required(string)

Query Parameters

  • eventType: (one of all, onlyAdhoc, onlyScheduled)

    It is possible to filter which events are deleted by using the optional eventType parameter.

    • "all" or empty = All events are deleted
    • "onlyAdhoc" = Events where ActiveFrom is not set AND ActiveTo is not set are deleted
    • "onlyScheduled" = Events where ActiveFrom is set OR ActiveTo is set are deleted

    Example:

    eventType=onlyAdhoc

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: items

  • statusCode: required(number)

    Status code of one event. Value is 204 in case the event was deleted succesfully. Any other value is error code.

  • id: (string)
  • error: (string)

get

Collection of items.

get

Get a list of items.

Get a list of items.

URI Parameters

  • disruptionSetId: required(string)

Query Parameters

  • any fields: (string)

    &field1=value1&field2=value2...
    Values may contain patterns * and ?
    Valid searchable fields: externalId, name, type, description, promptId, promptName, promptExternalId

    Example:

    externalId=001*

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: items

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

    Added by the system

  • externalId: required(string)
  • name: required(string)
  • type: required(one of WHY, WHERE, WHEN)
  • description: (string)
  • promptId: (string - minLength: 32 - maxLength: 32)
  • promptName: (string)
  • promptExternalId: (string)
  • attributes: (array of object)

    Attributes of the disruption item to define values when IVR Prompt and SayAs elements are used.

    Items: items

    • name: required(one of SayAsValue, SayAsDatatype, SayAsGender, SayAsDeclension)
    • language: required(string)
    • value: required(string)

Example:

[
    {
        "attributes": {
            "attribute": [
                {
                    "language": "EN",
                    "name": "SayAsDatatype",
                    "value": "digits"
                },
                {
                    "language": "EN",
                    "name": "SayAsValue",
                    "value": "00100"
                }
            ]
        },
        "description": "Helsinki1",
        "type": "WHERE",
        "externalId": "1.00.100",
        "name": "00100",
        "id": "F487CFD95D18402B941900247F12FD46"
    },
    {
        "description": "Service break",
        "type": "WHY",
        "externalId": "55",
        "promptExternalId": "WHY_55",
        "promptId": "C732A0C65336490B8D190F43E1B878F4",
        "promptName": "WHY_12",
        "name": "Service",
        "id": "145D6121895A491DB60F03AE610248E7"
    }
]

get

Entity representing a item.

get

Get the item with itemId = {itemId}.

Get the item with itemId = {itemId}.

URI Parameters

  • disruptionSetId: required(string)
  • itemId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Added by the system

  • externalId: required(string)
  • name: required(string)
  • type: required(one of WHY, WHERE, WHEN)
  • description: (string)
  • promptId: (string - minLength: 32 - maxLength: 32)
  • promptName: (string)
  • promptExternalId: (string)
  • attributes: (array of object)

    Attributes of the disruption item to define values when IVR Prompt and SayAs elements are used.

    Items: items

    • name: required(one of SayAsValue, SayAsDatatype, SayAsGender, SayAsDeclension)
    • language: required(string)
    • value: required(string)

Example:

{
    "description": "Service break",
    "type": "WHY",
    "externalId": "55",
    "promptExternalId": "WHY_55",
    "promptId": "C732A0C65336490B8D190F43E1B878F4",
    "promptName": "WHY_12",
    "name": "Service",
    "id": "145D6121895A491DB60F03AE610248E7"
}

/templateCompany

post

post

TemplateCompany can be used to create multiple logical companies within single system, using User Group rights to separate users of different companies from each other.

POST /RI/rci/templateCompany:
{
"id": "01234/1234",
"name": "Company Ltd",
"template": "TEMPLATE",
"masterId": "01234"
}

Creates new company using templates in system:

  • UserGroup(s)
  • Role(s)
  • QueueGroup(s)
  • Queue(s)
  • UserSettingsProfile(s)

Templates are named like

   "TEMPLATE:{ID}/name/{NAME}"

so if template is "TEMPLATE" and company ID is "01234/1234" and name is "Company Ltd" and user group template name is

   "TEMPLATE:{ID}/Agents/{NAME} UG"

then the created user group name will be

   "01234/1234/Agents/Company Ltd UG"

so "TEMPLATE:" prefix will be removed, and {ID} and {NAME} will be replaced. {ID} is mandatory while {NAME} is optional. {ID} can be anywhere in the template name, but it must start with "TEMPLATE:" (or whatever the template name is).

"masterId" is optional, and can be used to copy groups named like "TEMPLATE:{MASTER}" similar way as is done with company level groups.

If template UserGroup is synchronized to directory, then the directory group is also created in same batch so that UserGroup->DirectoryGroup rights can be copied. UserGroup hierarchy between template groups is preserved. Likewise links between template roles and template user groups will be preserved with references to copies.

Rights in UserGroups and Roles will be copied so that references to template objects will be replaced with references to copies.

It is possible to update company later by calling the same function. Then possible new UserGroups/Roles/QueueGroups are created, and possible new rights are created, and existing rights are updated. Nothing is deleted.

TemplateCompany can be used to create multiple logical companies within single system, using User Group rights to separate users of different companies from each other.

POST /RI/rci/templateCompany:
{
"id": "01234/1234",
"name": "Company Ltd",
"template": "TEMPLATE",
"masterId": "01234"
}

Creates new company using templates in system:

  • UserGroup(s)
  • Role(s)
  • QueueGroup(s)
  • Queue(s)
  • UserSettingsProfile(s)

Templates are named like

   "TEMPLATE:{ID}/name/{NAME}"

so if template is "TEMPLATE" and company ID is "01234/1234" and name is "Company Ltd" and user group template name is

   "TEMPLATE:{ID}/Agents/{NAME} UG"

then the created user group name will be

   "01234/1234/Agents/Company Ltd UG"

so "TEMPLATE:" prefix will be removed, and {ID} and {NAME} will be replaced. {ID} is mandatory while {NAME} is optional. {ID} can be anywhere in the template name, but it must start with "TEMPLATE:" (or whatever the template name is).

"masterId" is optional, and can be used to copy groups named like "TEMPLATE:{MASTER}" similar way as is done with company level groups.

If template UserGroup is synchronized to directory, then the directory group is also created in same batch so that UserGroup->DirectoryGroup rights can be copied. UserGroup hierarchy between template groups is preserved. Likewise links between template roles and template user groups will be preserved with references to copies.

Rights in UserGroups and Roles will be copied so that references to template objects will be replaced with references to copies.

It is possible to update company later by calling the same function. Then possible new UserGroups/Roles/QueueGroups are created, and possible new rights are created, and existing rights are updated. Nothing is deleted.

Body

Media type: application/json

Type: object

Properties
  • id: required(string)

    Company ID (which might contain masterId as well). {ID} in template name will be replaced with this value.

  • name: (string)

    Optional Company name. {NAME} in template name will be replaced with this value.

  • template: required(string)

    Template name, like "TEMPLATE". Template objects must begin with this given template name and : character, like: "TEMPLATE:{ID}/agents/{NAME}". The copied object will have this template name prefix removed, for example: id = 01234/1234 name = Company Name "TEMPLATE:{ID}/Agents/{NAME}" => "01234/1234/Agents/Company Name"

  • masterId: (string)

    Optional Master ID. {MASTER} in template name will be replaced with this value, for example: masterId = 01234 "TEMPLATE:{MASTER} Users" => "01234 Users"

Example:

{
 "id": "01234/1234",
 "name": "Company Ltd",
 "template": "TEMPLATE",
 "masterId": "01234"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string)

    Company ID (which might contain masterId as well). {ID} in template name will be replaced with this value.

  • name: (string)

    Optional Company name. {NAME} in template name will be replaced with this value.

  • template: required(string)

    Template name, like "TEMPLATE". Template objects must begin with this given template name and : character, like: "TEMPLATE:{ID}/agents/{NAME}". The copied object will have this template name prefix removed, for example: id = 01234/1234 name = Company Name "TEMPLATE:{ID}/Agents/{NAME}" => "01234/1234/Agents/Company Name"

  • masterId: (string)

    Optional Master ID. {MASTER} in template name will be replaced with this value, for example: masterId = 01234 "TEMPLATE:{MASTER} Users" => "01234 Users"

  • data: (object)

    Lists the IDs of objects that were created or updated from templates.

    • userGroups: required(array of id32)

      User Groups that were created or updated.

    • roles: required(array of id32)

      Roles that were created or updated.

    • queueGroups: required(array of id32)

      Queue Groups that were created or updated.

    • queues: required(array of id32)

      Queues that were created or updated.

    • rights: required(array of id32)

      Rights that were created or updated.

    • userSettingsProfiles: required(array of id32)

      User Settings Profiles created or updated.

Example:

{
    "id": "01234/1234",
    "name": "Company Ltd",
    "template": "TEMPLATE",
    "masterId": "01234",
    "data": {
        "userGroups": [
            "8920DF04010B4FB3B4A458CF93E8EE1D",
            "FD4976F2215E475D9E6ABAE63884A17D",
            "713AD64EE7DC48088ADBB7AF368EDE54"
        ],
        "roles": [
            "9227597D43FC4D95832E78C0E4E5BFBB",
            "4F8E888BED594DB7A4306A8183691615"
        ],
        "queueGroups": [
            "BBD41076C6284B85B67B0176D3461574",
            "8108B8FF0BC145C2B3FE0400247EB52F"
        ],
        "queues": [
            "EB98EAC0CCE4423F8252F017751BAA5A"
        ],
        "rights": [
            "229E569CA75E48028DED07D124F91D9E",
            "E9A9497BFD04407ABFFB7CB50853992E",
            "F7CC5020AB39485AB4DAB84413B9464F",
            "E189A49C6F8D4E739D87C0322B9548E8",
            "D1343EE67C74447D8961FB8ECB603354",
            "C4B8420467064B099610FA62B9CCB253",
            "C2B795DD9165475DB02CBE7C23D34316",
            "A456F10E668B47F99AEA2F897DD4700D",
            "1281D7A8016043BE8B19E1D433A7D5D0",
            "093307C4D3284C5EB670A1EE4A5F219E"
        ],
        "userSettingsProfiles": [
            "0E33C04FB17F40489D2DEBFFBD24A0F6",
            "1059B98CB770441F98572513AE530871"
        ]
    }
}

/jobs

Collection of jobs, which are handled by Batch Job Server. Jobs include System jobs and ImportExport jobs.

get

get

Get a list of jobs.

get delete

Entity representing a job.

get

Get the job with jobId = {jobId}.

delete

Delete ImportExport job. System jobs can't be deleted.

Get the job with jobId = {jobId}.

URI Parameters

  • jobId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    Job ID.

  • name: required(string)

    Job name, in case of ImportExport job, the same as technicalName.

  • description: (string)

    Description, in case of ImportExport job, the original file name if no other description given.

  • runningState: (boolean)

    True if job is running at the moment.

  • executionCount: (integer)

    How many times this job has been run.

  • lastStartTime: (datetime)

    When this job was last started.

  • lastEndTime: (datetime)

    When this job was last ended.

  • lastExecutionResult: (string)

    Textual result for the last execution.

  • errorCode: (integer)

    Error code for the last execution (0=OK, 1=warning, for example import validation failed, 2=error).

  • enabled: (boolean)

    True if job can be run according to the schedule. If job has only one ONE_TIME schedule and it has been run already, then it won't be run anymore.

  • created: (datetime)

    When this job was created.

  • executingUserId: (string - minLength: 32 - maxLength: 32)

    User ID of user whose access rights are used for this job.

  • executingUserName: (string)

    User name of user whose access rights are used for this job.

  • technicalName: required(one of Attribute syncronization, Automatic data removal, BO User Right Sync, CCTR365 Billing Job, DB Alarms, DB Maintenance, Dir rebuild, Dir Sync, LicenseReporting, Msg Cleaner, OBCampaignCleaner, OperDbCleaner, User Right Sync, ImportUserGroup, ImportDirectory, ImportQueues, ImportCalendar, ImportSkills, ImportPresence, ImportOutboundCampaign, ImportOutboundBlockedNumbers, ImportScripts, ImportConfiguration, ImportRights, ImportCustomerConsent, ImportDisruptionItem, ImportUserGroupHierarchy, ImportRoles, ExportUserGroup, ExportDirectory, ExportQueues, ExportCalendar, ExportSkills, ExportPresence, ExportOutboundCampaign, ExportOutboundBlockedNumbers, ExportScripts, ExportConfiguration, ExportRights, ExportCustomerConsent, ExportDisruptionItem, ExportUserGroupHierarchy, ExportRoles)

    Technical name of the System or ImportExport job.

  • parameter: (string)

    Parameters in XML format for ImportExport jobs.

  • fileName: (string)

    File name in ImportExport jobs. If file is embedded to job (instead of being in file system), then this has prefix of "(embedded) ".

  • schedules: (array of JobSchedule)

    Array of schedules for this job. System jobs by default have one recurring schedule, and ImportExport jobs usually have one ONE_TIME schedule.

    Items: JobSchedule

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

      Schedule ID.

    • type: required(one of ONE_TIME, RECURRING_DAILY, RECURRING_WEEKLY, RECURRING_MONTHLY)

      Schedule type.

    • executionTime: (string)

      In ONE_TIME schedule like 2021-12-30 11:59:41. In RECURRING_DAILY and RECURRING_WEEKLY schedules like *-*-* 02:00:00. In RECURRING_MONTHLY schedule like *-*-05 15:30. This time is in local system time, not in UTC time. If empty, then there is period defined instead.

    • enabled: required(boolean)

      If this schedule is enabled.

    • period: (integer)

      Period in seconds, for example 60 = once in minute, 3600 = once in hour.

    • periodStartTime: (string)

      Start time of period within a day, for example 00:00 or 03:00.

    • periodEndTime: (string)

      End time of period within a day, for example 23:59 or 19:00.

    • weekdays: (string)

      List of weekdays, when this schedule is active. 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday. For example, 0,6 = weekends, 1,2,3,4,5 from Monday to Friday. Used with RECURRING_WEEKLY schedule.

Example:

{
  "name": "ImportConfiguration",
  "description": "Configuration_testi.xlsx",
  "type": "ImportExport",
  "runningState": false,
  "executionCount": 1,
  "lastStartTime": "2021-12-30T09:59:58.133Z",
  "lastEndTime": "2021-12-30T10:00:07Z",
  "lastExecutionResult": "Error importing Configuration_testi.xlsx Queues\r\nRows: 0/1, Elapsed: 00:00:00 Commit: 00:00:00 Search:2 00:00:00\r\nRows: 0  Insert: 0  Update: 0  Delete: 0  Identical: 0  Errors: 2 (in row 3)\n\n2021-12-30 09:59:58 INF> Importing Configuration_testi.xlsx Queues\n2021-12-30 09:59:58 ERR> Invalid Address: Not valid subrange for extension: 603 (in row 3)\n2021-12-30 09:59:58 ERR> Invalid Address: Not valid subrange for extension: 603\r\n\r\nError (in row 3)\n2021-12-30 09:59:58 ERR> Error importing Configuration_testi.xlsx Queues\r\nRows: 0/1, Elapsed: 00:00:00 Commit: 00:00:00 Search:2 00:00:00\r\nRows: 0  Insert: 0  Update: 0  Delete: 0  Identical: 0  Errors: 2 (in row 3)\n\n--------\n",
  "errorCode": 2,
  "enabled": true,
  "created": "2021-12-30T09:59:41.733Z",
  "executingUserId": "BB78A8E9F500DF11B627463500000031",
  "executingUserName": "Admin, BCM",
  "technicalName": "ImportConfiguration",
  "parameter": "<A><a>LANGUAGE=EN</a><a>CHARSET=UTF-8</a></A>",
  "fileName": "Configuration_testi.xlsx",
  "schedules": [
    {
      "id": "B1F820E79E164B60B4167E7A7381D5FA",
      "type": "ONE_TIME",
      "executionTime": "2021-12-30 11:59:41",
      "enabled": true
    }
  ],
  "id": "C31BB77224324E808B8BAB9C7208E0F8"
}

Delete ImportExport job. System jobs can't be deleted.

URI Parameters

  • jobId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/import

Import supports .txt, .csv, .xls and .xlsx files. POSTing new import returns the job ID, which can be monitored using GET /RI/rci/jobs/ID. Files must have column names in the first line. Columns in .txt files are separated by tab and in .csv files by semicolon (;). If value contains separator character (or starts with " character), then it must be quoted using " characters (and " characters in value must be doubled).

post

post

Creates a new import job that adds or updates calendars.

Fields:

  • Id - Can be used to update existing calendar.
  • Name - Required. If Id is not used, then Name will identify the calendar (creates new if does not exist).
  • Priority - Integer. Must be unique. The schedule with highest priority calendar, which matches the current date, is used for queue/user settings template/contact center.
  • Weekdays - Calendar can have zero or one Weekdays columns. Format: MON,TUE,WED,THU,FRI,SAT,SUN.
  • Day - Calendar can have multiple Day columns (or none). Format: "MMDD:Description". ":Description" is optional.
  • Range - Calendar can have multiple Range columns (or none). Format: "YYYYMMDD-YYYYMMDD:Description". ":Description" is optional.
  • Delete - Should be empty. Value 'D' will delete the calendar.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Priority;Weekdays;Day;Day;Day;Day;Day;Range;Range
Workdays;100;MON,TUE,WED,THU,FRI
Leisure;123;SAT,SUN;0501:First of May;1224:Christmas Eve;;;;20160325-20160328:Easter holiday;20160624-20160626
Public Holidays in Finland;990;;1206;0101;1224;1226;1225

Creates a new import job that adds or updates calendars.

Fields:

  • Id - Can be used to update existing calendar.
  • Name - Required. If Id is not used, then Name will identify the calendar (creates new if does not exist).
  • Priority - Integer. Must be unique. The schedule with highest priority calendar, which matches the current date, is used for queue/user settings template/contact center.
  • Weekdays - Calendar can have zero or one Weekdays columns. Format: MON,TUE,WED,THU,FRI,SAT,SUN.
  • Day - Calendar can have multiple Day columns (or none). Format: "MMDD:Description". ":Description" is optional.
  • Range - Calendar can have multiple Range columns (or none). Format: "YYYYMMDD-YYYYMMDD:Description". ":Description" is optional.
  • Delete - Should be empty. Value 'D' will delete the calendar.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Priority;Weekdays;Day;Day;Day;Day;Day;Range;Range
Workdays;100;MON,TUE,WED,THU,FRI
Leisure;123;SAT,SUN;0501:First of May;1224:Christmas Eve;;;;20160325-20160328:Easter holiday;20160624-20160626
Public Holidays in Finland;990;;1206;0101;1224;1226;1225

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates customers to an outbound campaign.

Fields for outbound customer:

  • ExternalId - Required, must be unique within campaign.
  • Phone1, Phone2, Phone3 - Each customer can have up to 3 phone numbers. Phone1 is required.
  • Priority - Optional integer value. Smaller priority is handled first. Otherwise customers are handled in ExternalId order.
  • TimeZone - TimeZone for the customer (like 'Europe/Helsinki'). By default the campaign or system TimeZone is used.
  • AgentLogin - Which agent should handle this customer. By default any agent.
  • Date - When this customer should be handled (in UTC). Formats: "yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd HH:mm:ss", "yyyy-MM-dd HH:mm", "yyyy-MM-dd". By default empty, so that customer can be called at any time.
  • Result - Used in export only. New customer will get 'CALL' result by default. Customer will get result such as 'SUCCESS' or 'REFUSAL' eventually.
  • CallResult - Used in export only. Customer will get call result such as 'SUCCESS', 'REFUSAL', 'BUSY' or 'NOANSWER' eventually.
  • Classifier - Used in export only. Customer will get classifier based on CallResult eventually.
  • Amount - Used in export only. Customer might get monetary value if outbound UI supports such thing.
  • CallCount - Used in export only. CallCount tells approximately how many times customer has been called. BUSY and NOANSWER will increment CallCount, while REDIAL will not.
  • AgentNumber - Used in export only. This column will get the agent phone number in export.
  • Delete - Should be empty. Value 'D' will delete the customer from campaign.
  • Any other field: Customer attribute, such as Name or Company.

An example of import file in tab-delimited text/plain format (.txt):

ExternalId    Phone1    Name
1    +5550001    Name1
2    005550002    Name2

Creates a new import job that adds or updates customers to an outbound campaign.

Fields for outbound customer:

  • ExternalId - Required, must be unique within campaign.
  • Phone1, Phone2, Phone3 - Each customer can have up to 3 phone numbers. Phone1 is required.
  • Priority - Optional integer value. Smaller priority is handled first. Otherwise customers are handled in ExternalId order.
  • TimeZone - TimeZone for the customer (like 'Europe/Helsinki'). By default the campaign or system TimeZone is used.
  • AgentLogin - Which agent should handle this customer. By default any agent.
  • Date - When this customer should be handled (in UTC). Formats: "yyyy-MM-dd HH:mm:ss.SSS", "yyyy-MM-dd HH:mm:ss", "yyyy-MM-dd HH:mm", "yyyy-MM-dd". By default empty, so that customer can be called at any time.
  • Result - Used in export only. New customer will get 'CALL' result by default. Customer will get result such as 'SUCCESS' or 'REFUSAL' eventually.
  • CallResult - Used in export only. Customer will get call result such as 'SUCCESS', 'REFUSAL', 'BUSY' or 'NOANSWER' eventually.
  • Classifier - Used in export only. Customer will get classifier based on CallResult eventually.
  • Amount - Used in export only. Customer might get monetary value if outbound UI supports such thing.
  • CallCount - Used in export only. CallCount tells approximately how many times customer has been called. BUSY and NOANSWER will increment CallCount, while REDIAL will not.
  • AgentNumber - Used in export only. This column will get the agent phone number in export.
  • Delete - Should be empty. Value 'D' will delete the customer from campaign.
  • Any other field: Customer attribute, such as Name or Company.

An example of import file in tab-delimited text/plain format (.txt):

ExternalId    Phone1    Name
1    +5550001    Name1
2    005550002    Name2

Query Parameters

  • campaignId: (string)

    Add customers to this campaign.

    Example:

    campaignId=8108B8FF0BC145C2B3FE0400247EB52F
  • campaignName: (string)

    Add customers to this campaign. Create this campaign if it does not exist already. When creating new campaign, then copyFromId or copyFromName parameters are used.

    Example:

    campaignName=New campaign
  • copyFromId: (string)

    Copy campaign parameters from another campaign using campaign ID.

    Example:

    copyFromId=8108B8FF0BC145C2B3FE0400247EB52F
  • copyFromName: (string)

    Copy campaign parameters from another campaign using campaign name.

    Example:

    copyFromName=Existing campaign
  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job for configuration, which can include any other import:

  • Directory
  • UserGroup
  • Roles
  • UserGroupHierarchy
  • Queues
  • Calendar
  • Skills
  • Presence
  • OutboundCampaign
  • OutboundBlockedNumbers
  • Scripts
  • Rights

Configuration supports only Excel files:

  • .xls - application/vnd.ms-excel
  • .xlsx - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Worksheet name must match one of the supported imports (listed above). Each worksheet will be imported in left to right order.

The following query parameters are not supported:

  • validateOnly (CHECK)
  • continueOnError (CONTINUEONERROR)
  • importLanguage (LANGUAGE)

Instead these parameters can be given at the beginning of each Excel worksheet. First rows are considered parameters, if the first column is empty. Then the second column contains the parameter name, and the third column can contain the parameter value, if parameter can have a value. For example:

Column#1    Column#2        Column#3
(empty)     LANGUAGE        EN
(empty)     CHECK           (empty)
(empty)     CONTINUEONERROR (empty)

Boolean parameters like CHECK and CONTINUEONERROR get value '1' (true) if value is not given. '0' is false (default value, if parameter is not given at all).

Some imports need to have parameters defined:

  • Directory - either ID (directoryGroupId) or NAME (directoryGroupName) must be given
  • UserGroup - either ID (userGroupId) or NAME (userGroupName) can be given, or alternatively UserGroup can be given in each row
  • Queues - either ID (queueGroupId) or NAME (queueGroupName) can be given, or alternatively QueueGroup can be given in each row
  • OutboundCampaign - either ID (campaignId) or NAME (campaignName) must be given

First row that has non-empty column#1 must have the column names for the actual import data.

Creates a new import job for configuration, which can include any other import:

  • Directory
  • UserGroup
  • Roles
  • UserGroupHierarchy
  • Queues
  • Calendar
  • Skills
  • Presence
  • OutboundCampaign
  • OutboundBlockedNumbers
  • Scripts
  • Rights

Configuration supports only Excel files:

  • .xls - application/vnd.ms-excel
  • .xlsx - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Worksheet name must match one of the supported imports (listed above). Each worksheet will be imported in left to right order.

The following query parameters are not supported:

  • validateOnly (CHECK)
  • continueOnError (CONTINUEONERROR)
  • importLanguage (LANGUAGE)

Instead these parameters can be given at the beginning of each Excel worksheet. First rows are considered parameters, if the first column is empty. Then the second column contains the parameter name, and the third column can contain the parameter value, if parameter can have a value. For example:

Column#1    Column#2        Column#3
(empty)     LANGUAGE        EN
(empty)     CHECK           (empty)
(empty)     CONTINUEONERROR (empty)

Boolean parameters like CHECK and CONTINUEONERROR get value '1' (true) if value is not given. '0' is false (default value, if parameter is not given at all).

Some imports need to have parameters defined:

  • Directory - either ID (directoryGroupId) or NAME (directoryGroupName) must be given
  • UserGroup - either ID (userGroupId) or NAME (userGroupName) can be given, or alternatively UserGroup can be given in each row
  • Queues - either ID (queueGroupId) or NAME (queueGroupName) can be given, or alternatively QueueGroup can be given in each row
  • OutboundCampaign - either ID (campaignId) or NAME (campaignName) must be given

First row that has non-empty column#1 must have the column names for the actual import data.

Query Parameters

  • validateOnly: (boolean)

    NOT SUPPORTED

    Example:

    NOT SUPPORTED
  • continueOnError: required(boolean)

    NOT SUPPORTED

    Example:

    NOT SUPPORTED
  • importLanguage: (string)

    NOT SUPPORTED

    Example:

    NOT SUPPORTED
  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: NOT SUPPORTED

Media type: text/csv

Type: NOT SUPPORTED

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates consents.

Fields:

  • Number - Phone number.
  • Usage - 'recording' (default) or 'whatsapp'. Number and Usage together identify the consent.
  • Consent - 1=true, 0=false (default).
  • CreationTime - Optional datetime in format "yyyy-MM-dd HH:mm:ss[.SSS]".
  • Delete - Should be empty. Value 'D' will delete the consent.

An example of import file in semicolon-delimited text/csv format (.csv):

Number;Consent;CreationTime;Usage
+555001;1;2022-01-10 14:26:51;recording
555002;0

Creates a new import job that adds or updates consents.

Fields:

  • Number - Phone number.
  • Usage - 'recording' (default) or 'whatsapp'. Number and Usage together identify the consent.
  • Consent - 1=true, 0=false (default).
  • CreationTime - Optional datetime in format "yyyy-MM-dd HH:mm:ss[.SSS]".
  • Delete - Should be empty. Value 'D' will delete the consent.

An example of import file in semicolon-delimited text/csv format (.csv):

Number;Consent;CreationTime;Usage
+555001;1;2022-01-10 14:26:51;recording
555002;0

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates directory entries to a directory group.

Fields for directory entry:

  • Id - Can be used to update existing directory entry.
  • ExternalId - Required by default, can be used to update existing directory entry using ID from external system. The query parameter requireIdOrExternalId is true by default, but if set to false, then it is possible to import entry without Id and ExternalId, but then it will always create a new entry (so it will create duplicates, if same file is imported twice).
  • Delete - Should be empty. Value 'D' will remove the directory entry.
  • Any other field: Directory attribute, such as 'Company Name'. If field is multi-lingual, then field can contain language code, like 'Company Name:EN'. Language code must be one of the standard two-letter language codes that can be seen in SC.

An example of import file in semicolon-delimited text/csv format (.csv):

ExternalId;Company Name;Full Name;Last Name;First Name
1;Company1;Full Name 1;Last Name 1;First Name 1
2;Company2;Full Name 2;Last Name 2;First Name 1

Creates a new import job that adds or updates directory entries to a directory group.

Fields for directory entry:

  • Id - Can be used to update existing directory entry.
  • ExternalId - Required by default, can be used to update existing directory entry using ID from external system. The query parameter requireIdOrExternalId is true by default, but if set to false, then it is possible to import entry without Id and ExternalId, but then it will always create a new entry (so it will create duplicates, if same file is imported twice).
  • Delete - Should be empty. Value 'D' will remove the directory entry.
  • Any other field: Directory attribute, such as 'Company Name'. If field is multi-lingual, then field can contain language code, like 'Company Name:EN'. Language code must be one of the standard two-letter language codes that can be seen in SC.

An example of import file in semicolon-delimited text/csv format (.csv):

ExternalId;Company Name;Full Name;Last Name;First Name
1;Company1;Full Name 1;Last Name 1;First Name 1
2;Company2;Full Name 2;Last Name 2;First Name 1

Query Parameters

  • directoryGroupId: (string)

    Add directory entries to this group.

    Example:

    directoryGroupId=8108B8FF0BC145C2B3FE0400247EB52F
  • directoryGroupName: (string)

    Add directory entries to this group. Create this directory group if it does not exist already.

    Example:

    directoryGroupName=New directory group
  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates disruption items to a disruption set.

Fields:

  • DisruptionSetExternalId - Required, disruption set external ID.
  • DisruptionSetName - Optional, needed when inserting a new set.
  • Id - Internal ID, can be used to update existing disruption item.
  • ExternalId - Required, can be used to update existing disruption item.
  • Type - Disruption item type, required, one of: WHERE,WHY,WHEN.
  • Name - Disruption item name.
  • Description - Disruption item description.
  • PromptId - Optional, prompt internal ID.
  • PromptExternalId - Optional, prompt external ID. Optionally use either PromptId or PromptExternalId.
  • SayAsValue - Optional digits. Use IVRTalk instead of pre-recorded prompt.
  • SayAsDatatype - Optional, one of: number, digits, ordinal, date, time, datetime.
    number: 100 => "hundred"
digits: 100 => "one zero zero"
ordinal: 100 => "hundredth"
date: ddMM or ddMMyyyy, for example 0102 means "the first of February" or "February first"
time: HHmm, for example 1530 means "fifteen thirty"
datetime: ddMMHHmm or ddMMyyyyHHmm
  • SayAsGender - Optional integer, one of: 0 (MASCULINE), 1 (FEMININE), 2 (NEUTER).
  • SayAsDeclension - Optional integer, one of: 0 (NOMINATIVE), 1 (GENITIVE).
  • Delete - Should be empty. Value 'D' will remove the disruption item.

An example of import file in semicolon-delimited text/csv format (.csv):

Id;DisruptionSetExternalId;DisruptionSetName;Type;ExternalId;Name;Description;PromptExternalId;SayAsValue;SayAsDatatype
;002;set2;WHERE;l011;Location 1;desc 1;;00230;digits
;002;set2;WHY;c001;Cause 1;desc 2;prompt_007;;
;002;set2;WHEN;tm1500;15:00;desc 3 äöäöäö;;1500;time

Creates a new import job that adds or updates disruption items to a disruption set.

Fields:

  • DisruptionSetExternalId - Required, disruption set external ID.
  • DisruptionSetName - Optional, needed when inserting a new set.
  • Id - Internal ID, can be used to update existing disruption item.
  • ExternalId - Required, can be used to update existing disruption item.
  • Type - Disruption item type, required, one of: WHERE,WHY,WHEN.
  • Name - Disruption item name.
  • Description - Disruption item description.
  • PromptId - Optional, prompt internal ID.
  • PromptExternalId - Optional, prompt external ID. Optionally use either PromptId or PromptExternalId.
  • SayAsValue - Optional digits. Use IVRTalk instead of pre-recorded prompt.
  • SayAsDatatype - Optional, one of: number, digits, ordinal, date, time, datetime.
    number: 100 => "hundred"
digits: 100 => "one zero zero"
ordinal: 100 => "hundredth"
date: ddMM or ddMMyyyy, for example 0102 means "the first of February" or "February first"
time: HHmm, for example 1530 means "fifteen thirty"
datetime: ddMMHHmm or ddMMyyyyHHmm
  • SayAsGender - Optional integer, one of: 0 (MASCULINE), 1 (FEMININE), 2 (NEUTER).
  • SayAsDeclension - Optional integer, one of: 0 (NOMINATIVE), 1 (GENITIVE).
  • Delete - Should be empty. Value 'D' will remove the disruption item.

An example of import file in semicolon-delimited text/csv format (.csv):

Id;DisruptionSetExternalId;DisruptionSetName;Type;ExternalId;Name;Description;PromptExternalId;SayAsValue;SayAsDatatype
;002;set2;WHERE;l011;Location 1;desc 1;;00230;digits
;002;set2;WHY;c001;Cause 1;desc 2;prompt_007;;
;002;set2;WHEN;tm1500;15:00;desc 3 äöäöäö;;1500;time

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or removes outbound campaign blocked phone numbers. These numbers won't be called by outbound campaign dialer. If outbound customer does not have any other phone number, then customer result will be NO_BNUMBERS_LEFT.

Fields:

  • Number - Number to be added. Any other characters than the plus sign (+) and digits from 0 to 9 are removed from the number.
  • Delete - Should be empty. Value 'D' will remove the number.

An example of import file in semicolon-delimited text/csv format (.csv):

Number;Delete
+555001
555002;D

Creates a new import job that adds or removes outbound campaign blocked phone numbers. These numbers won't be called by outbound campaign dialer. If outbound customer does not have any other phone number, then customer result will be NO_BNUMBERS_LEFT.

Fields:

  • Number - Number to be added. Any other characters than the plus sign (+) and digits from 0 to 9 are removed from the number.
  • Delete - Should be empty. Value 'D' will remove the number.

An example of import file in semicolon-delimited text/csv format (.csv):

Number;Delete
+555001
555002;D

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates presence profiles.

Fields:

  • Id - Can be used to update existing presence profile.
  • Name - Required, identifies the presence profile if Id is not used.
  • Reason - Required, one of: BUSINESSTRIP, BUSY, CHILDCARE, DUTY, LUNCH, MEETING, NONE, OFFDUTY, OFFICIAL, OTHER, PARENTAL, TEMPOUT, TRAINING, VACATION, VISIT, SICK, DAYOFF.
  • BehaviorDefault - Required, one of: BUSY, FREEFORWARD, MOBILE, IVR, PASS, SWITCHBOARD, VOICEMAIL, USERFORWARD.
  • Type - Required, one of: PRESENCE, ABSENCE, CONFERENCE.
  • Duration - Required, one of: NONE, REST_DAY, 5_MINUTE, 10_MINUTE, 15_MINUTE, 30_MINUTE, 45_MINUTE, 1_HOUR, 2_HOUR, 3_HOUR, 4_HOUR, 5_HOUR, 6_HOUR, 7_HOUR, 8_HOUR, 9_HOUR, 10_HOUR, 11_HOUR, 12_HOUR, 1_DAY, 2_DAY, 3_DAY, 4_DAY, 5_DAY, 6_DAY, 1_WEEK, 2_WEEK, 3_WEEK, 4_WEEK.
  • Priority - Required, integer >= 0.
  • Availability - One of: AWAY, TENTATIVE, FREE.
  • QueueGroup - Queue group name (agent is logged into these queues automatically).
  • DurationRounding - Required, integer between 0 - 60 (minutes).
  • BehaviorBusy - See BehaviorDefault for possible values. Can't be used with Type=CONFERENCE.
  • BehaviorNotAnswered - See BehaviorDefault for possible values. Can't be used with Type=CONFERENCE.
  • BehaviorLoggedOut - See BehaviorDefault for possible values. Can't be used with Type=CONFERENCE.
  • FreeForwardNumber - Can't be used with Type=CONFERENCE.
  • IvrGreetingType - Can't be used with Type=CONFERENCE.
  • IvrOption1 - Can't be used with Type=CONFERENCE. Format: key;option. Because key and option are separated by ; character, then if text/csv format is used, then this column value must be quoted like "2;VOICEMAIL". Key is one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #. Option is one of: VOICEMAIL, MOBILE, SWITCHBOARD, USERFORWARD.
  • IvrOption2 - See IvrOption1.
  • IvrOption3 - See IvrOption1.
  • IvrOption4 - See IvrOption1.
  • Delete - Should be empty. Value 'D' will remove the presence profile.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Reason;BehaviorDefault;Type;Duration;Priority;Availability;QueueGroup;DurationRounding;BehaviorBusy;BehaviorNotAnswered;BehaviorLoggedOut;FreeForwardNumber;IvrGreetingType;IvrOption1;IvrOption2;IvrOption3;IvrOption4
TEST_Default;NONE;PASS;PRESENCE;NONE;100;;;0;PASS;BUSY;BUSY;;;;;;
TEST_Lunch;LUNCH;BUSY;ABSENCE;1_HOUR;100;;NOQUEUE;0;BUSY;BUSY;BUSY;;LUNCH;"1;USERFORWARD";"2;VOICEMAIL";;
TEST_Sick leave;VACATION;IVR;ABSENCE;1_DAY;100;;;0;IVR;IVR;IVR;;;;;;
TEST_Vacation;VACATION;IVR;ABSENCE;1_WEEK;100;;NOQUEUE;0;IVR;IVR;IVR;;;;;;
TEST_Conference Call;NONE;;CONFERENCE;REST_DAY;100;;;5;;;;;;;;;
TEST_Meeting;MEETING;VOICEMAIL;ABSENCE;1_HOUR;2;;;5;VOICEMAIL;VOICEMAIL;VOICEMAIL;;;;;;
TEST_Businesstrip;BUSINESSTRIP;IVR;ABSENCE;REST_DAY;100;;;5;IVR;BUSY;IVR;;BUSINESSTRIP;"1;VOICEMAIL";"2;MOBILE";"3;SWITCHBOARD";"4;USERFORWARD"
TEST_Away;TEMPOUT;IVR;PRESENCE;15_MINUTE;100;;;0;IVR;BUSY;IVR;;TEMPOUT;;;;
TEST_Lunch;LUNCH;BUSY;ABSENCE;1_HOUR;100;;NOQUEUE;0;BUSY;BUSY;BUSY;;LUNCH;"1;USERFORWARD";"2;VOICEMAIL";;
TEST_Conffis;NONE;IVR;CONFERENCE;1_HOUR;100;;;5

Creates a new import job that adds or updates presence profiles.

Fields:

  • Id - Can be used to update existing presence profile.
  • Name - Required, identifies the presence profile if Id is not used.
  • Reason - Required, one of: BUSINESSTRIP, BUSY, CHILDCARE, DUTY, LUNCH, MEETING, NONE, OFFDUTY, OFFICIAL, OTHER, PARENTAL, TEMPOUT, TRAINING, VACATION, VISIT, SICK, DAYOFF.
  • BehaviorDefault - Required, one of: BUSY, FREEFORWARD, MOBILE, IVR, PASS, SWITCHBOARD, VOICEMAIL, USERFORWARD.
  • Type - Required, one of: PRESENCE, ABSENCE, CONFERENCE.
  • Duration - Required, one of: NONE, REST_DAY, 5_MINUTE, 10_MINUTE, 15_MINUTE, 30_MINUTE, 45_MINUTE, 1_HOUR, 2_HOUR, 3_HOUR, 4_HOUR, 5_HOUR, 6_HOUR, 7_HOUR, 8_HOUR, 9_HOUR, 10_HOUR, 11_HOUR, 12_HOUR, 1_DAY, 2_DAY, 3_DAY, 4_DAY, 5_DAY, 6_DAY, 1_WEEK, 2_WEEK, 3_WEEK, 4_WEEK.
  • Priority - Required, integer >= 0.
  • Availability - One of: AWAY, TENTATIVE, FREE.
  • QueueGroup - Queue group name (agent is logged into these queues automatically).
  • DurationRounding - Required, integer between 0 - 60 (minutes).
  • BehaviorBusy - See BehaviorDefault for possible values. Can't be used with Type=CONFERENCE.
  • BehaviorNotAnswered - See BehaviorDefault for possible values. Can't be used with Type=CONFERENCE.
  • BehaviorLoggedOut - See BehaviorDefault for possible values. Can't be used with Type=CONFERENCE.
  • FreeForwardNumber - Can't be used with Type=CONFERENCE.
  • IvrGreetingType - Can't be used with Type=CONFERENCE.
  • IvrOption1 - Can't be used with Type=CONFERENCE. Format: key;option. Because key and option are separated by ; character, then if text/csv format is used, then this column value must be quoted like "2;VOICEMAIL". Key is one of: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #. Option is one of: VOICEMAIL, MOBILE, SWITCHBOARD, USERFORWARD.
  • IvrOption2 - See IvrOption1.
  • IvrOption3 - See IvrOption1.
  • IvrOption4 - See IvrOption1.
  • Delete - Should be empty. Value 'D' will remove the presence profile.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Reason;BehaviorDefault;Type;Duration;Priority;Availability;QueueGroup;DurationRounding;BehaviorBusy;BehaviorNotAnswered;BehaviorLoggedOut;FreeForwardNumber;IvrGreetingType;IvrOption1;IvrOption2;IvrOption3;IvrOption4
TEST_Default;NONE;PASS;PRESENCE;NONE;100;;;0;PASS;BUSY;BUSY;;;;;;
TEST_Lunch;LUNCH;BUSY;ABSENCE;1_HOUR;100;;NOQUEUE;0;BUSY;BUSY;BUSY;;LUNCH;"1;USERFORWARD";"2;VOICEMAIL";;
TEST_Sick leave;VACATION;IVR;ABSENCE;1_DAY;100;;;0;IVR;IVR;IVR;;;;;;
TEST_Vacation;VACATION;IVR;ABSENCE;1_WEEK;100;;NOQUEUE;0;IVR;IVR;IVR;;;;;;
TEST_Conference Call;NONE;;CONFERENCE;REST_DAY;100;;;5;;;;;;;;;
TEST_Meeting;MEETING;VOICEMAIL;ABSENCE;1_HOUR;2;;;5;VOICEMAIL;VOICEMAIL;VOICEMAIL;;;;;;
TEST_Businesstrip;BUSINESSTRIP;IVR;ABSENCE;REST_DAY;100;;;5;IVR;BUSY;IVR;;BUSINESSTRIP;"1;VOICEMAIL";"2;MOBILE";"3;SWITCHBOARD";"4;USERFORWARD"
TEST_Away;TEMPOUT;IVR;PRESENCE;15_MINUTE;100;;;0;IVR;BUSY;IVR;;TEMPOUT;;;;
TEST_Lunch;LUNCH;BUSY;ABSENCE;1_HOUR;100;;NOQUEUE;0;BUSY;BUSY;BUSY;;LUNCH;"1;USERFORWARD";"2;VOICEMAIL";;
TEST_Conffis;NONE;IVR;CONFERENCE;1_HOUR;100;;;5

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates queues to a queue group.

Fields grouped same way as in SC. If setting is only used with certain queue type, then there is (phone), (email) or (chat).

Basics:

  • Type - One of: Phone, Email, Chat. Type can't be changed for existing queue.
  • Name - Identifies the queue if Id is not used. Creates new if does not exist already.
  • Description - Queue description.
  • Ordinal - Integer.
  • Language - Prompt language, one of supported two letter language codes or a custom language configured in SC.
  • TimeZone - One of supported time zones like 'Europe/Helsinki'.
  • CriticalTime - Integer seconds, email critical time (email).
  • LoginType - One of: AutoAllocation (default), HuntGroup.
  • WarningTime - Integer seconds, email warning time (email).
  • Id - Can be used to update existing queue.
  • RingbackTime - Integer seconds, phone ringing time (phone).
  • (Script not supported)
  • (Opening Type not supported)
  • Synchronised - Is this queue synchronized to directory, one of: 1 (true), 0 (false).

Numbers/Addresses:

  • Address - Queue can have multiple addresses (there can be multiple Address columns). Phone queue address can contain only digits. Email queue address must be a valid email address. Chat queue address must contain @ character. Address is used as identifier, so it can't be modified. Changing address will add another address to queue, unless REPLACEADDRESSES=1 parameter is given, in which case the old address is removed (default).

Contact Management:

  • Priority - Integer.
  • QueueLength - Integer, queue size.
  • MaxPickTimeout - Integer milliseconds, timeout for contacts to be picked or rejected, default value 120000 (2 minutes).
  • EarlyQueuing - 1 (on, default) or 0 (off) (phone).
  • ClearOldSkills - 1 or 0. Recording (phone):
  • ServerRecording - Record queue calls (phone): 0 (off), 1 (on)
  • RecordingConsentOption - Recording behavior with consents (phone): 0 (ignore consents), 1 (ask for and follow customer consent, default)
  • RecordingConsentNumber - Consent IVR number (phone).

Forwarding:

  • DefaultQueue - Address of other queue.
  • MaxWaitTimeInQueue - Integer seconds.
  • QueueFullIfNoDest - One of: MaxWaitingTime, NoServingAgents, NoFreeAgents.
  • ForwardOnServiceClosed - Address of other queue (phone).
  • LetScheduleClosed - 1 or 0, Routing to Closed Overflow Queue (phone).
  • LeaveVoiceMessageChar - DTMF character for forwarding (phone).
  • ForwardOnUserInput - Forwarding number after DTMF character (phone).
  • ForwardOnServiceClosing - Forwarding destination for scheduled queue close, address of other queue.
  • QCBQueueNumber - Callback queue number (phone).
  • ForwardEnabled - Enable instant forwarding (phone), one of: 1 (true), 0 (false).
  • ForwardNumber - Instant forwarding number (phone).

Contact Management continues:

  • IfNoAnsAddToRejNbrs - Block rejected contact from agent (phone) (chat), one of: 1 (yes, default), -2 (never), 0 (no blocking if contact redirected after max waiting time).
  • IfNoAnsAddToRejNbrs - Block rejected contact from agent (email), one of: 0 (no, default), 1 (yes).
  • BusyWhenWrapUp - Busy during wrap-up (chat): 0 (off, default), 1 (on).
  • QueueLenSlope - Number of agents affect queue size, default 0.0 (phone).
  • MaxPrefOperWait - Integer milliseconds, max. waiting time for preferred agent, default 40000 (phone).
  • QueUseEntryTime - Reference timestamp for calculating queuing time (phone), one of: ORIG_CC (call enters contact center first time, default), ORIG (CEM receives call information), CURR_APP (call's last entry to contact center), CURR (call enters queue)
  • QueLWTDDependencies - Queues used for long-term waiting time (phone).
  • ExtAgentShowCaller - Original source number shown to external agents and MTD devices (phone), one of: 0 (off, default), 1 (on).

Transfer (phone):

  • HoldTransferWhenBusy - Enable transfer-on-hold when busy (phone), one of: 0 (no transfer-on-hold if target is busy) 1 (transfer-on-hold if target is mobile) 2 (always enable transfer-on-hold, default)
  • HoldTransferTimeout - Integer milliseconds, default 3600000 (1 hour), timeout for transfer-on-hold (phone).
  • UseJoinTransfer - Enable join transfer, 0 (no, default), 1 (use when transferring to external number) (phone).
  • JoinTransferTimeout - Integer milliseconds, default 30000 (phone).
  • UseInternalTransferBarring - Enable barring of internal transfers (phone), one of: 0 (off, default), 1 (on).

Opt-in IVR settings (phone):

  • OptInActive - Activate opt-in IVR (phone): 0 (off), 1 (on).
  • OptInNumber - Opt-in IVR number (phone).

Contact Management continues:

  • OverrideEmails - Allow other contacts while email open (email), one of: 0 (no, default), 1 (yes).
  • ExtraDataWhenAllocated - Extra data included when e-mail allocated (email).

Weight Value Settings:

  • QuePriorityWeightLocalCall - Float, importance of contact when on same CEM as agent, default 1.00, one of: 1.00, 1.05, 1.10, 1.15, 1.20, 1.25, 1.30.
  • QuePriorityWeightLocalOper - Float, importance of agent when on same CEM as contact, default 1.00, one of: 1.00, 1.05, 1.10, 1.15, 1.20, 1.25, 1.30.

E-Mail Settings (email):

  • DefaultEmailReplyAddress - Default sender address (email).
  • Ch_AcceptTimeLimit - Integer seconds, default 62, (email).
  • UseRequiredAgent - Use required agent instead of preferred agent (email): 0 (off), 1 (on).
  • RequiredAgentExpiryTime - Integer seconds, default 60, default expiry time for required agent (email).
  • Ch_PrefAgent - Preferred agent, one of: 0 (off), 1 (on, default) (email).
  • AllowPickingReqRefEmails - Allow picking by other Communication Panel agents (email): 0 (off), 1 (on).
  • Ch_DoCreateTask - Block e-mail from addresses (email).
  • DisableMailChannel - Close e-mail queue (email), one of: 0 (no, default), 1 (yes).
  • Ch_CustInfo - Customer information, (email).
  • Ch_Language - Language definition method, (email).
  • Ch_Priority - Priority definition method (email).
  • DeleteOldMailsAfterDays - Integer days, old e-mails deleted after (email), default -1 (disabled).
  • MaxMailSizeKb - Integer kilobytes, max. size of incoming email (email)

Reporting and monitoring:

  • FalseAttemptTime - Integer seconds, false-attempt limit, default 5.
  • AnsweredOnTime - Integer seconds, answered-on-time limit, default 20.
  • AnsweredOnTimeCBR - Integer seconds, answered-on-time limit for callback requests (phone).
  • FalseAttemptTimeCBR - Integer seconds, false-attempt limit for callback requests (phone).
  • MaxTalkTime - Integer seconds, max. handling time, default 36000 (10 hours).
  • MaxWaitTime - Integer seconds, max. waiting time, default 18000 (5 hours).

Prompts (phone) (chat):

  • QuePositionPromptWeight - Queue position multiplier (phone) (chat).
  • EstWaitTimePromptWeight - Waiting time multiplier (phone) (chat).
  • MaxCountQueueFullMessages - No. of times QueueFull is played (phone).
  • MaxCountServiceClosedMessages - No. of times ServiceClosed is played (phone).
  • EstWaitTimePromptLimits - Limit values for waiting time (phone) (chat). Format: "min,max", where both min and max are integers (min < max, min >= 0).
  • QuePositionPromptLimits - Limit values for queue position (phone) (chat). Format: "min,max", where both min and max are integers (min < max, min >= 0).
  • ServingAgentsPromptLimits - Limit values for agents serving in queue (phone) (chat). Format: "min,max", where both min and max are integers (min < max, min >= 0).

Queue Groups:

  • QueueGroup - Queue can be added to another groups as well. There can be multiple QueueGroup columns. If parameter REPLACE_GROUPS=1, then queue is removed from other groups not included in this import.

Skills:

  • Skill - Queue can have multiple skill requirements (columns). Each requirement is in format: skill=value. Value is integer, 0 means that requirement is deleted.

Skill Reduction:

  • DisableSkillAdjustment - Use absolut waiting time: 0 (off), 1 (on, default).

Voicemail and Notification Call Settings (phone):

  • Voicemail - Voice mail number (phone).
  • VoiceMailInQueueFull - Transfer to voicemail if queue is full: 0 (off, default), 1 (on).

External Agent (phone):

  • ExtAgentMaxAnswerWaitTime - Integer milliseconds, default 30000, max. answer waiting time (phone).
  • ExtAgentPlayAcceptQuestion - Require confirmation (phone), one of: 1 (on default), 0 (off).
  • ExtAgentMaxDTMFWaitTime - Integer milliseconds, default 15000, max. waiting time for confirmation (phone).
  • ExtAgentAcceptChar - Accepting character, default # (phone).
  • ExtAgentRejectChar - Rejecting character, default 3 (phone).

CDT Settings:

  • AfterworkUsage - Activate wrap-up status automatically: 0 (off), 1 (on).
  • AutoPaperwork - Activate not-ready status after rejecting contact: 0 (off), 1 (on).
  • AutoPWTime - Integer seconds, wrap-up time.
  • UseRestingAfterScripting - Use rest time after scripting: 0 (off), 1 (on).
  • (AnswerTemplate not supported (Default reply template) (email) (chat))
  • TalkTimeLimit - Integer seconds, handling time limit.
  • SearchGroup - Target directory for searches.
  • AnswerInfo - Queue contact information.

Integration Settings:

  • OII - Enable OII integration: 0 (off), 1 (on, default).
  • CrmCodUrl - SAP Service Cloud (C4C) integration URL.
  • CrmLink - Launch application or URL (phone).

Threshold Values for Queue Statistics:

  • MaxWaitTimeCriticalLevel - Integer seconds, critical level of queuing time.
  • MaxWaitTimeWarningLevel - Integer seconds, warning level of queuing time.
  • InteractionsCriticalLevel - Integer, critical level of queuing conversations.
  • InteractionsWarningLevel - Integer, warning level of queuing conversations.
  • ServiceLevelCriticalLevel - Integer, critical level of service level.
  • ServiceLevelWarningLevel - Integer, warning level of service level.
  • ServingAgentCriticalLevel - Integer, critical level of serving agents.
  • ServingAgentWarningLevel - Integer, warning level of serving agents.
  • FreeAgentCriticalLevel - Integer, critical level of free agents.
  • FreeAgentWarningLevel - Integer, warning level of free agents.

Personal Data Retention Time

  • PersonalDataRetention - Integer days, must be less than channel level setting (which must be configured).

Other fields:

  • Any other queue parameter, listed separately below.
  • Any other field: Valid directory field (if Synchronized=1). Name is synchronized to "Queue Name" automatically by BJS.
  • Delete - Should be empty. Value 'D' will remove the queue.

Additional queue parameters:

  • MaxTotalUnhandledTasks - Integer, max. handled of unhandled e-mails (email). Only available as email channel parameter in SC.
  • ChatIdleTimeout - Integer seconds, default 600, timeout for idle chats. Only available as chat channel parameter in SC.

An example of import file in semicolon-delimited text/csv format (.csv):

Type;Name;Address
Phone;Test phone queue;50000

Creates a new import job that adds or updates queues to a queue group.

Fields grouped same way as in SC. If setting is only used with certain queue type, then there is (phone), (email) or (chat).

Basics:

  • Type - One of: Phone, Email, Chat. Type can't be changed for existing queue.
  • Name - Identifies the queue if Id is not used. Creates new if does not exist already.
  • Description - Queue description.
  • Ordinal - Integer.
  • Language - Prompt language, one of supported two letter language codes or a custom language configured in SC.
  • TimeZone - One of supported time zones like 'Europe/Helsinki'.
  • CriticalTime - Integer seconds, email critical time (email).
  • LoginType - One of: AutoAllocation (default), HuntGroup.
  • WarningTime - Integer seconds, email warning time (email).
  • Id - Can be used to update existing queue.
  • RingbackTime - Integer seconds, phone ringing time (phone).
  • (Script not supported)
  • (Opening Type not supported)
  • Synchronised - Is this queue synchronized to directory, one of: 1 (true), 0 (false).

Numbers/Addresses:

  • Address - Queue can have multiple addresses (there can be multiple Address columns). Phone queue address can contain only digits. Email queue address must be a valid email address. Chat queue address must contain @ character. Address is used as identifier, so it can't be modified. Changing address will add another address to queue, unless REPLACEADDRESSES=1 parameter is given, in which case the old address is removed (default).

Contact Management:

  • Priority - Integer.
  • QueueLength - Integer, queue size.
  • MaxPickTimeout - Integer milliseconds, timeout for contacts to be picked or rejected, default value 120000 (2 minutes).
  • EarlyQueuing - 1 (on, default) or 0 (off) (phone).
  • ClearOldSkills - 1 or 0. Recording (phone):
  • ServerRecording - Record queue calls (phone): 0 (off), 1 (on)
  • RecordingConsentOption - Recording behavior with consents (phone): 0 (ignore consents), 1 (ask for and follow customer consent, default)
  • RecordingConsentNumber - Consent IVR number (phone).

Forwarding:

  • DefaultQueue - Address of other queue.
  • MaxWaitTimeInQueue - Integer seconds.
  • QueueFullIfNoDest - One of: MaxWaitingTime, NoServingAgents, NoFreeAgents.
  • ForwardOnServiceClosed - Address of other queue (phone).
  • LetScheduleClosed - 1 or 0, Routing to Closed Overflow Queue (phone).
  • LeaveVoiceMessageChar - DTMF character for forwarding (phone).
  • ForwardOnUserInput - Forwarding number after DTMF character (phone).
  • ForwardOnServiceClosing - Forwarding destination for scheduled queue close, address of other queue.
  • QCBQueueNumber - Callback queue number (phone).
  • ForwardEnabled - Enable instant forwarding (phone), one of: 1 (true), 0 (false).
  • ForwardNumber - Instant forwarding number (phone).

Contact Management continues:

  • IfNoAnsAddToRejNbrs - Block rejected contact from agent (phone) (chat), one of: 1 (yes, default), -2 (never), 0 (no blocking if contact redirected after max waiting time).
  • IfNoAnsAddToRejNbrs - Block rejected contact from agent (email), one of: 0 (no, default), 1 (yes).
  • BusyWhenWrapUp - Busy during wrap-up (chat): 0 (off, default), 1 (on).
  • QueueLenSlope - Number of agents affect queue size, default 0.0 (phone).
  • MaxPrefOperWait - Integer milliseconds, max. waiting time for preferred agent, default 40000 (phone).
  • QueUseEntryTime - Reference timestamp for calculating queuing time (phone), one of: ORIG_CC (call enters contact center first time, default), ORIG (CEM receives call information), CURR_APP (call's last entry to contact center), CURR (call enters queue)
  • QueLWTDDependencies - Queues used for long-term waiting time (phone).
  • ExtAgentShowCaller - Original source number shown to external agents and MTD devices (phone), one of: 0 (off, default), 1 (on).

Transfer (phone):

  • HoldTransferWhenBusy - Enable transfer-on-hold when busy (phone), one of: 0 (no transfer-on-hold if target is busy) 1 (transfer-on-hold if target is mobile) 2 (always enable transfer-on-hold, default)
  • HoldTransferTimeout - Integer milliseconds, default 3600000 (1 hour), timeout for transfer-on-hold (phone).
  • UseJoinTransfer - Enable join transfer, 0 (no, default), 1 (use when transferring to external number) (phone).
  • JoinTransferTimeout - Integer milliseconds, default 30000 (phone).
  • UseInternalTransferBarring - Enable barring of internal transfers (phone), one of: 0 (off, default), 1 (on).

Opt-in IVR settings (phone):

  • OptInActive - Activate opt-in IVR (phone): 0 (off), 1 (on).
  • OptInNumber - Opt-in IVR number (phone).

Contact Management continues:

  • OverrideEmails - Allow other contacts while email open (email), one of: 0 (no, default), 1 (yes).
  • ExtraDataWhenAllocated - Extra data included when e-mail allocated (email).

Weight Value Settings:

  • QuePriorityWeightLocalCall - Float, importance of contact when on same CEM as agent, default 1.00, one of: 1.00, 1.05, 1.10, 1.15, 1.20, 1.25, 1.30.
  • QuePriorityWeightLocalOper - Float, importance of agent when on same CEM as contact, default 1.00, one of: 1.00, 1.05, 1.10, 1.15, 1.20, 1.25, 1.30.

E-Mail Settings (email):

  • DefaultEmailReplyAddress - Default sender address (email).
  • Ch_AcceptTimeLimit - Integer seconds, default 62, (email).
  • UseRequiredAgent - Use required agent instead of preferred agent (email): 0 (off), 1 (on).
  • RequiredAgentExpiryTime - Integer seconds, default 60, default expiry time for required agent (email).
  • Ch_PrefAgent - Preferred agent, one of: 0 (off), 1 (on, default) (email).
  • AllowPickingReqRefEmails - Allow picking by other Communication Panel agents (email): 0 (off), 1 (on).
  • Ch_DoCreateTask - Block e-mail from addresses (email).
  • DisableMailChannel - Close e-mail queue (email), one of: 0 (no, default), 1 (yes).
  • Ch_CustInfo - Customer information, (email).
  • Ch_Language - Language definition method, (email).
  • Ch_Priority - Priority definition method (email).
  • DeleteOldMailsAfterDays - Integer days, old e-mails deleted after (email), default -1 (disabled).
  • MaxMailSizeKb - Integer kilobytes, max. size of incoming email (email)

Reporting and monitoring:

  • FalseAttemptTime - Integer seconds, false-attempt limit, default 5.
  • AnsweredOnTime - Integer seconds, answered-on-time limit, default 20.
  • AnsweredOnTimeCBR - Integer seconds, answered-on-time limit for callback requests (phone).
  • FalseAttemptTimeCBR - Integer seconds, false-attempt limit for callback requests (phone).
  • MaxTalkTime - Integer seconds, max. handling time, default 36000 (10 hours).
  • MaxWaitTime - Integer seconds, max. waiting time, default 18000 (5 hours).

Prompts (phone) (chat):

  • QuePositionPromptWeight - Queue position multiplier (phone) (chat).
  • EstWaitTimePromptWeight - Waiting time multiplier (phone) (chat).
  • MaxCountQueueFullMessages - No. of times QueueFull is played (phone).
  • MaxCountServiceClosedMessages - No. of times ServiceClosed is played (phone).
  • EstWaitTimePromptLimits - Limit values for waiting time (phone) (chat). Format: "min,max", where both min and max are integers (min < max, min >= 0).
  • QuePositionPromptLimits - Limit values for queue position (phone) (chat). Format: "min,max", where both min and max are integers (min < max, min >= 0).
  • ServingAgentsPromptLimits - Limit values for agents serving in queue (phone) (chat). Format: "min,max", where both min and max are integers (min < max, min >= 0).

Queue Groups:

  • QueueGroup - Queue can be added to another groups as well. There can be multiple QueueGroup columns. If parameter REPLACE_GROUPS=1, then queue is removed from other groups not included in this import.

Skills:

  • Skill - Queue can have multiple skill requirements (columns). Each requirement is in format: skill=value. Value is integer, 0 means that requirement is deleted.

Skill Reduction:

  • DisableSkillAdjustment - Use absolut waiting time: 0 (off), 1 (on, default).

Voicemail and Notification Call Settings (phone):

  • Voicemail - Voice mail number (phone).
  • VoiceMailInQueueFull - Transfer to voicemail if queue is full: 0 (off, default), 1 (on).

External Agent (phone):

  • ExtAgentMaxAnswerWaitTime - Integer milliseconds, default 30000, max. answer waiting time (phone).
  • ExtAgentPlayAcceptQuestion - Require confirmation (phone), one of: 1 (on default), 0 (off).
  • ExtAgentMaxDTMFWaitTime - Integer milliseconds, default 15000, max. waiting time for confirmation (phone).
  • ExtAgentAcceptChar - Accepting character, default # (phone).
  • ExtAgentRejectChar - Rejecting character, default 3 (phone).

CDT Settings:

  • AfterworkUsage - Activate wrap-up status automatically: 0 (off), 1 (on).
  • AutoPaperwork - Activate not-ready status after rejecting contact: 0 (off), 1 (on).
  • AutoPWTime - Integer seconds, wrap-up time.
  • UseRestingAfterScripting - Use rest time after scripting: 0 (off), 1 (on).
  • (AnswerTemplate not supported (Default reply template) (email) (chat))
  • TalkTimeLimit - Integer seconds, handling time limit.
  • SearchGroup - Target directory for searches.
  • AnswerInfo - Queue contact information.

Integration Settings:

  • OII - Enable OII integration: 0 (off), 1 (on, default).
  • CrmCodUrl - SAP Service Cloud (C4C) integration URL.
  • CrmLink - Launch application or URL (phone).

Threshold Values for Queue Statistics:

  • MaxWaitTimeCriticalLevel - Integer seconds, critical level of queuing time.
  • MaxWaitTimeWarningLevel - Integer seconds, warning level of queuing time.
  • InteractionsCriticalLevel - Integer, critical level of queuing conversations.
  • InteractionsWarningLevel - Integer, warning level of queuing conversations.
  • ServiceLevelCriticalLevel - Integer, critical level of service level.
  • ServiceLevelWarningLevel - Integer, warning level of service level.
  • ServingAgentCriticalLevel - Integer, critical level of serving agents.
  • ServingAgentWarningLevel - Integer, warning level of serving agents.
  • FreeAgentCriticalLevel - Integer, critical level of free agents.
  • FreeAgentWarningLevel - Integer, warning level of free agents.

Personal Data Retention Time

  • PersonalDataRetention - Integer days, must be less than channel level setting (which must be configured).

Other fields:

  • Any other queue parameter, listed separately below.
  • Any other field: Valid directory field (if Synchronized=1). Name is synchronized to "Queue Name" automatically by BJS.
  • Delete - Should be empty. Value 'D' will remove the queue.

Additional queue parameters:

  • MaxTotalUnhandledTasks - Integer, max. handled of unhandled e-mails (email). Only available as email channel parameter in SC.
  • ChatIdleTimeout - Integer seconds, default 600, timeout for idle chats. Only available as chat channel parameter in SC.

An example of import file in semicolon-delimited text/csv format (.csv):

Type;Name;Address
Phone;Test phone queue;50000

Query Parameters

  • queueGroupId: (string)

    Add queues to this group.

    Example:

    queueGroupId=8108B8FF0BC145C2B3FE0400247EB52F
  • queueGroupName: (string)

    Add queues to this group. Create this queue group if it does not exist already.

    Example:

    queueGroupName=New queue group
  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds, updates or deletes rights. Right is deleted if there are no enabled access types.

Fields:

  • SubjectType - Required, one of: User, Role, UserGroup
  • SubjectName - Required, name of the subject (User/Role/UserGroup)
  • ObjectType - Required, one of system API object names, like: User, Queue, QueueGroup, UserService, UserSettingsProfile.
  • ObjectName - Required, name of the object, or "(ALL)" if class level right, or "(SELF)" if self right.
  • Predicate - Usually empty, but can contain ObjectType, for example if ObjectType=User, then Predicate can be LoginAuthenticationInfo. Multiple predicates are separated by comma.
  • Type - Required, one of: ACCESS, GRANT
  • Id - Can be used to identify existing right. Otherwise the right is identified by: subject, object, Type, Predicate.
  • SubjectId - With SubjectType, can be used to identify subject. Otherwise the subject is identified by SubjectName.
  • ObjectId - With ObjectType, can be used to identify the object. Otherwise the object is identified by ObjectName.

Access types are enabled by having value X. If value is empty, then that access type is disabled.

  • View - View object.
  • Modify - Modify object.
  • Create - Create object.
  • Delete - Delete object.
  • Use - Use object.
  • ManageRights - Manage rights
  • ManageMembers - Manage members.
  • Serve - Serve in queue.
  • ControlContact - Control contact (supervisor).
  • BargeIn - Barge-in (supervisor).
  • Listen - Listen (supervisor).
  • Coach - Coach (supervisor).
  • LogOnToQueues - Log on agents to queues (supervisor).
  • StatisticsSummary - Statistics summary.
  • StatisticsDetails - Statistics details.
  • ListenToRecording - Listen to recording.
  • ManageContactHistory - Manage contact history.
  • ManageVoicemails - Manage voicemails.
  • ManagePresence - Manage presence.
  • Messaging - Messaging.

An example of import file in semicolon-delimited text/csv format (.csv):

SubjectType;SubjectName;ObjectType;ObjectName;Predicate;Type;View;Modify;Create;Delete
Role;Advanced Monitoring User;Skill;(ALL);;ACCESS;X;;;

This example adds only View right for "Advanced Monitoring User" role to all skills (other possible access types for this right are removed, even those not listed in header).

Creates a new import job that adds, updates or deletes rights. Right is deleted if there are no enabled access types.

Fields:

  • SubjectType - Required, one of: User, Role, UserGroup
  • SubjectName - Required, name of the subject (User/Role/UserGroup)
  • ObjectType - Required, one of system API object names, like: User, Queue, QueueGroup, UserService, UserSettingsProfile.
  • ObjectName - Required, name of the object, or "(ALL)" if class level right, or "(SELF)" if self right.
  • Predicate - Usually empty, but can contain ObjectType, for example if ObjectType=User, then Predicate can be LoginAuthenticationInfo. Multiple predicates are separated by comma.
  • Type - Required, one of: ACCESS, GRANT
  • Id - Can be used to identify existing right. Otherwise the right is identified by: subject, object, Type, Predicate.
  • SubjectId - With SubjectType, can be used to identify subject. Otherwise the subject is identified by SubjectName.
  • ObjectId - With ObjectType, can be used to identify the object. Otherwise the object is identified by ObjectName.

Access types are enabled by having value X. If value is empty, then that access type is disabled.

  • View - View object.
  • Modify - Modify object.
  • Create - Create object.
  • Delete - Delete object.
  • Use - Use object.
  • ManageRights - Manage rights
  • ManageMembers - Manage members.
  • Serve - Serve in queue.
  • ControlContact - Control contact (supervisor).
  • BargeIn - Barge-in (supervisor).
  • Listen - Listen (supervisor).
  • Coach - Coach (supervisor).
  • LogOnToQueues - Log on agents to queues (supervisor).
  • StatisticsSummary - Statistics summary.
  • StatisticsDetails - Statistics details.
  • ListenToRecording - Listen to recording.
  • ManageContactHistory - Manage contact history.
  • ManageVoicemails - Manage voicemails.
  • ManagePresence - Manage presence.
  • Messaging - Messaging.

An example of import file in semicolon-delimited text/csv format (.csv):

SubjectType;SubjectName;ObjectType;ObjectName;Predicate;Type;View;Modify;Create;Delete
Role;Advanced Monitoring User;Skill;(ALL);;ACCESS;X;;;

This example adds only View right for "Advanced Monitoring User" role to all skills (other possible access types for this right are removed, even those not listed in header).

Query Parameters

  • createMissingRolesAndGroups: (string)

    Create subjects by name if they don't exist already (roles and user groups only).

    Example:

    createMissingRolesAndGroups=true
  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates roles.

Fields:

  • Name - Required.
  • Description
  • Delete - Should be empty. Value 'D' will remove the role.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Description
Role name;Role description

Creates a new import job that adds or updates roles.

Fields:

  • Name - Required.
  • Description
  • Delete - Should be empty. Value 'D' will remove the role.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Description
Role name;Role description

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates scripts. Each row is one of the following:

  • Script - If row has Name, it identifies the script.
  • Question - If row has Ordinal, it identifies the question for the previous script.
  • Answer - If row has AnswerOrdinal, it identifies the answer for the previous question.

Fields for script:

  • Name - Required for script row, identifies the script.
  • Type - Required for script row, one of: STATIC, INTERACTIVE, CALLBACK.
  • Remarks - Script remarks.
  • LockFirstQuestion - Show first question always on top: 0 (off), 1 (on).

Fields for question:

  • Ordinal - Required for question row, identifies the question within the previous script.
  • Question - Required for question row. Text for the actual question.
  • NextOrdinal - Next question ordinal. Can be used only in INTERACTIVE scripts.
  • ControlType - Required for question row, one of: INFO, RADIOBUTTON, CHECKBOX, DROPDOWNLIST, COMBOBOX, INPUTTEXT, TEXTAREA, DROPDOWNCHECKBOX
  • DataType - Can only be used for COMBOBOX, INPUTTEXT or TEXTAREA control types, one of: TEXT, INTEGER, FLOATING, DATETIME, CURRENCY
  • Prefill - Integer, max. number of answers.
  • Mandatory - Is it mandatory to answer this question: 0 (no), 1 (yes).
  • IsAmount - Is the answer used in amount calculations: 0 (no), 1 (yes).
  • Width - View setting for question width in pixels.
  • Height - View setting for question height in pixels.

Fields for answer:

  • AnswerOrdinal - Required for answer row, identifies the answer within the previous question. The following question types can have answers: RADIOBUTTON, CHECKBOX, DROPDOWNLIST, COMBOBOX, DROPDOWNCHECKBOX
  • Answer - Answer text.
  • Amount - Float, can only be used if question IsAmount=1.
  • Recording - Start recording: 0 (no), 1 (yes).
  • NextQuestion - Next question ordinal in INTERACTIVE scripts.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Type;Remarks;LockFirstQuestion;Ordinal;Question;NextOrdinal;ControlType;DataType;Prefill;Mandatory;IsAmount;Width;Height;AnswerOrdinal;Answer;Amount;Recording;NextQuestion
Script name;STATIC;;0;;;;;;;;;;;;;;;
;;;;10;Question text;;CHECKBOX;;;0;0;;;;;;;
;;;;;;;;;;;;;;1;Yes;;0;
;;;;;;;;;;;;;;2;No;;0

Creates a new import job that adds or updates scripts. Each row is one of the following:

  • Script - If row has Name, it identifies the script.
  • Question - If row has Ordinal, it identifies the question for the previous script.
  • Answer - If row has AnswerOrdinal, it identifies the answer for the previous question.

Fields for script:

  • Name - Required for script row, identifies the script.
  • Type - Required for script row, one of: STATIC, INTERACTIVE, CALLBACK.
  • Remarks - Script remarks.
  • LockFirstQuestion - Show first question always on top: 0 (off), 1 (on).

Fields for question:

  • Ordinal - Required for question row, identifies the question within the previous script.
  • Question - Required for question row. Text for the actual question.
  • NextOrdinal - Next question ordinal. Can be used only in INTERACTIVE scripts.
  • ControlType - Required for question row, one of: INFO, RADIOBUTTON, CHECKBOX, DROPDOWNLIST, COMBOBOX, INPUTTEXT, TEXTAREA, DROPDOWNCHECKBOX
  • DataType - Can only be used for COMBOBOX, INPUTTEXT or TEXTAREA control types, one of: TEXT, INTEGER, FLOATING, DATETIME, CURRENCY
  • Prefill - Integer, max. number of answers.
  • Mandatory - Is it mandatory to answer this question: 0 (no), 1 (yes).
  • IsAmount - Is the answer used in amount calculations: 0 (no), 1 (yes).
  • Width - View setting for question width in pixels.
  • Height - View setting for question height in pixels.

Fields for answer:

  • AnswerOrdinal - Required for answer row, identifies the answer within the previous question. The following question types can have answers: RADIOBUTTON, CHECKBOX, DROPDOWNLIST, COMBOBOX, DROPDOWNCHECKBOX
  • Answer - Answer text.
  • Amount - Float, can only be used if question IsAmount=1.
  • Recording - Start recording: 0 (no), 1 (yes).
  • NextQuestion - Next question ordinal in INTERACTIVE scripts.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Type;Remarks;LockFirstQuestion;Ordinal;Question;NextOrdinal;ControlType;DataType;Prefill;Mandatory;IsAmount;Width;Height;AnswerOrdinal;Answer;Amount;Recording;NextQuestion
Script name;STATIC;;0;;;;;;;;;;;;;;;
;;;;10;Question text;;CHECKBOX;;;0;0;;;;;;;
;;;;;;;;;;;;;;1;Yes;;0;
;;;;;;;;;;;;;;2;No;;0

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates skills.

Fields:

  • Id - Can be used to update existing skill.
  • Name - Required. If Id is not used, then ExternalName or Name will identify the skill.
  • Description
  • ExternalName - Can be used to identify the skill if Id is not used.
  • Delete - Should be empty. Value 'D' will delete the skill.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Description;ExternalName
Skill name;Skill description;

Creates a new import job that adds or updates skills.

Fields:

  • Id - Can be used to update existing skill.
  • Name - Required. If Id is not used, then ExternalName or Name will identify the skill.
  • Description
  • ExternalName - Can be used to identify the skill if Id is not used.
  • Delete - Should be empty. Value 'D' will delete the skill.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Description;ExternalName
Skill name;Skill description;

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that updates user group hierarchy.

Fields:

  • Name - Required, user group name.
  • Description - User group description.
  • Parent - Parent user group name. Can have multiple columns to have multiple parents.
  • Role - Role names. Can have multiple columns to have multiple roles.
  • Delete - Should be empty. Value 'D' will delete the user group.

Optional parameters (only possible to give in Configuration import):

  • REPLACE_ROLES - If 1, then other roles not included in this import will be removed from user group (by default 0). If there are no Role values included in this import, then no roles are removed.
  • REPLACE_PARENTS - If 1, then other parents not included in this import will be removed from user group (by default 0). If there are no Parent values included in this import, then no parents are removed.
  • CREATE_MISSING_GROUPS - If 1 (default), then user groups and roles not existing already in the system will be created.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Description;Parent;Parent;Role;Role
Parent1name;Parent1description
Parent2name;Parent2description
Child1Name;Child1description;Parent1Name;Parent2Name;Role1;Role2
Child2Name;Child2description;Parent2Name;;Role2
Child3Name;Child3description;Child1Name

Creates a new import job that updates user group hierarchy.

Fields:

  • Name - Required, user group name.
  • Description - User group description.
  • Parent - Parent user group name. Can have multiple columns to have multiple parents.
  • Role - Role names. Can have multiple columns to have multiple roles.
  • Delete - Should be empty. Value 'D' will delete the user group.

Optional parameters (only possible to give in Configuration import):

  • REPLACE_ROLES - If 1, then other roles not included in this import will be removed from user group (by default 0). If there are no Role values included in this import, then no roles are removed.
  • REPLACE_PARENTS - If 1, then other parents not included in this import will be removed from user group (by default 0). If there are no Parent values included in this import, then no parents are removed.
  • CREATE_MISSING_GROUPS - If 1 (default), then user groups and roles not existing already in the system will be created.

An example of import file in semicolon-delimited text/csv format (.csv):

Name;Description;Parent;Parent;Role;Role
Parent1name;Parent1description
Parent2name;Parent2description
Child1Name;Child1description;Parent1Name;Parent2Name;Role1;Role2
Child2Name;Child2description;Parent2Name;;Role2
Child3Name;Child3description;Child1Name

Query Parameters

  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

post

post

Creates a new import job that adds or updates users.

Fields:

  • Id - Can be used to update existing user.
  • ExternalId - Can be used to identify the user.
  • Login - Login name for the user. Identifies the user if Id and ExternalId fields are empty.
  • CRM - SAP CRM name for the user (uppercase).
  • PresenceId - Presence ID for the user.
  • UILanguage - User interface language, one of standard two letter system languages that can be seen in SC.
  • PromptLanguage - Prompt language, can contain also custom languages defined in SC.
  • FirstName - First name.
  • Surname - Last name.
  • TimeZone - Time zone like 'Europe/Helsinki'.
  • Phone - Internal phone number, digits only.
  • MobilePhone - External mobile phone number.
  • Voicemail - Voicemail number.
  • EMail - Email address.
  • Chat - Chat address, must contain @ character.
  • ChatName - Chat name shown to customers.
  • Settings - User settings template.
  • Role - Role for the user. There can be multiple Role columns.
  • Skill - Skill and value for the user. Format: skill=value. If value is empty or 0, then skill is deleted from this user. There can be multiple Skill columns.
  • Subject - Certificate subject. Certificates are identified by both subject and issuer. There can be multiple Subject columns.
  • Issuer - Certificate issuer. There should be same amount of Issuer columns as Subject columns.
  • Synchronised - 1 if this user should be synchronized to directory.
  • ReportingGroup - Reporting group.
  • UserGroup - User group. There can be multiple UserGroup columns.
  • ForwardNumber - Personal forwarding number.
  • DefaultQueue - Number of switchboard queue.
  • Priority - Float.
  • ExternalAgentNumber - External agent number.
  • MaxCallsWaiting - Maximum number of waiting calls.
  • Delete - Should be empty. Value 'D' will delete the user.

Optional parameters (possible to give in Configuration import):

  • REPLACEROLES - If 1, then other roles not included in this import will be removed from user (by default 0). If there are no Role values included in this import, then no roles are removed.
  • REPLACE_USER_GROUPS - If 1, then other user groups not included in this import will be removed from user (by default 0). If there are no UserGroup values included in this import, then no user groups are removed.
  • CREATE_MISSING_GROUPS - If 1 (default), then user groups and roles not existing already in the system will be created.

An example of import file in semicolon-delimited text/csv format (.csv):

Login;Surname;FirstName;TimeZone
Test1;Last name;First name;Europe/Helsinki

Creates a new import job that adds or updates users.

Fields:

  • Id - Can be used to update existing user.
  • ExternalId - Can be used to identify the user.
  • Login - Login name for the user. Identifies the user if Id and ExternalId fields are empty.
  • CRM - SAP CRM name for the user (uppercase).
  • PresenceId - Presence ID for the user.
  • UILanguage - User interface language, one of standard two letter system languages that can be seen in SC.
  • PromptLanguage - Prompt language, can contain also custom languages defined in SC.
  • FirstName - First name.
  • Surname - Last name.
  • TimeZone - Time zone like 'Europe/Helsinki'.
  • Phone - Internal phone number, digits only.
  • MobilePhone - External mobile phone number.
  • Voicemail - Voicemail number.
  • EMail - Email address.
  • Chat - Chat address, must contain @ character.
  • ChatName - Chat name shown to customers.
  • Settings - User settings template.
  • Role - Role for the user. There can be multiple Role columns.
  • Skill - Skill and value for the user. Format: skill=value. If value is empty or 0, then skill is deleted from this user. There can be multiple Skill columns.
  • Subject - Certificate subject. Certificates are identified by both subject and issuer. There can be multiple Subject columns.
  • Issuer - Certificate issuer. There should be same amount of Issuer columns as Subject columns.
  • Synchronised - 1 if this user should be synchronized to directory.
  • ReportingGroup - Reporting group.
  • UserGroup - User group. There can be multiple UserGroup columns.
  • ForwardNumber - Personal forwarding number.
  • DefaultQueue - Number of switchboard queue.
  • Priority - Float.
  • ExternalAgentNumber - External agent number.
  • MaxCallsWaiting - Maximum number of waiting calls.
  • Delete - Should be empty. Value 'D' will delete the user.

Optional parameters (possible to give in Configuration import):

  • REPLACEROLES - If 1, then other roles not included in this import will be removed from user (by default 0). If there are no Role values included in this import, then no roles are removed.
  • REPLACE_USER_GROUPS - If 1, then other user groups not included in this import will be removed from user (by default 0). If there are no UserGroup values included in this import, then no user groups are removed.
  • CREATE_MISSING_GROUPS - If 1 (default), then user groups and roles not existing already in the system will be created.

An example of import file in semicolon-delimited text/csv format (.csv):

Login;Surname;FirstName;TimeZone
Test1;Last name;First name;Europe/Helsinki

Query Parameters

  • userGroupId: (string)

    Add users to this group.

    Example:

    userGroupId=8108B8FF0BC145C2B3FE0400247EB52F
  • userGroupName: (string)

    Add user to this group. Create this user group if it does not exist already.

    Example:

    userGroupName=New user group
  • replaceRoles: (boolean)

    If true, then other roles not included in this import will be removed from user (by default false).

    Example:

    replaceRoles=true
  • description: (string)

    Description for the new job. If not given, then original file name will be used.

  • validateOnly: (boolean)

    By default false, meaning that import is really done instead of just validating import file format.

    Example:

    validateOnly=true
  • continueOnError: required(boolean)

    By default false, meaning that import will stop on first error.

    Example:

    continueOnError=true
  • importLanguage: (string)

    Defines the language for language attributes, by default uses system default language.

    Example:

    importLanguage=EN
  • when: (datetime)

    Defines when the import should be run. By default it is run immediately, or when this parameter is in the past.

    Example:

    when=2021-12-20T07:25:20Z

Body

Media type: text/plain

Type: Tab-delimited text file format, same as .txt in SC import.

Media type: text/csv

Type: Semicolon ; separated text file, same as .csv in SC import.

Media type: multipart/form-data

Type:

Must contain <file> part, which should have the embedded file, supported media types are:
* "text/plain" - as above
* "text/csv" - as above
* "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" - Excel file in .xlsx format
* "application/vnd.ms-excel" - Excel file in old .xls format

HTTP status code 201

Returns the created job id.

Body

Media type: text/plain

Type: string

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

/emergencyLocations

Collection of emergencyLocations.

get post

get

Get a list of emergencyLocations.

post

Add new EmergencyLocation. When adding Custom EmergencyLocation, then logged in user is used for "userId".

Add new EmergencyLocation. When adding Custom EmergencyLocation, then logged in user is used for "userId".

Body

Media type: application/json

Type: object

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

    ID.

  • name: required(string)

    Name.

  • type: required(one of Common, Custom)

    Common or Custom, Custom must have userId.

  • userId: (string - minLength: 32 - maxLength: 32)

    User ID when type=Custom.

  • userName: (string)

    User name when type=Custom.

  • details: (string)

    Details.

  • address: required(object)

    Address, containing callbackNumber and parsedAddress.

    • streetNum: required(string)

      Street number.

    • streetName: required(string)

      Street name.

    • city: required(string)

      City.

    • state: required(string)

      State.

    • postalCode: required(string)

      Postal code.

    • country: required(string)

      Country, default USA.

    • callbackNumber: required(string)

      Callback number.

    • parsedAddress: (object)

      Parsed address. Not used in request while posting new EmergencyLocation.

      • streetNum: required(string)

        Street number.

      • preDirectional: (string)

        Street name pre-directional.

      • streetName: required(string)

        Street name.

      • streetSuffix: (string)

        Street suffix.

      • postDirectional: (string)

        Street name post-directional.

      • city: required(string)

        City.

      • state: required(string)

        State.

      • postalCode: required(string)

        Postal code.

      • country: required(string)

        Country, default USA.

Example:

{
  "name": "test",
  "type": "Common",
  "address": {
    "streetNum": "318",
    "streetName": "8th",
    "city": "Tucson",
    "state": "AZ",
    "postalCode": "85713",
    "callbackNumber": "01234"
  },
  "details": "..."
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

HTTP status code 400

Returns the error message from validation and possible corrected addresses.

Body

Media type: application/json

Type: object

Properties
  • statusCode: required(integer)

    HTTP status code from validation, normally 400 (bad request).

  • statusDetails: required(string)

    Error message from validation.

  • correctedAddress: (array of EmergencyLocationCorrectedAddress)

    Array of corrected address candidates.

    Items: EmergencyLocationCorrectedAddress

    • streetNum: required(string)

      Street number.

    • streetName: required(string)

      Street name.

    • city: required(string)

      City.

    • state: required(string)

      State.

    • postalCode: required(string)

      Postal code.

    • country: required(string)

      Country, default USA.

Example:

{
  "statusCode": 400,
  "statusDetails": "Invalid address - no correction found|Changed address component|Corrected ZIP Code|primary number (e.g., house number) is invalid|Address is Invalid",
  "correctedAddress": [
    {
      "streetNum": "318",
      "streetName": "E 8th St",
      "city": "Tucson",
      "state": "AZ",
      "postalCode": "85705",
      "country": "USA"
    }
  ]
}

get delete

Entity representing a emergencyLocation.

get

Get the emergencyLocation with emergencyLocationId = {emergencyLocationId}.

delete

Delete emergency location.

Get the emergencyLocation with emergencyLocationId = {emergencyLocationId}.

URI Parameters

  • emergencyLocationId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    ID.

  • name: required(string)

    Name.

  • type: required(one of Common, Custom)

    Common or Custom, Custom must have userId.

  • userId: (string - minLength: 32 - maxLength: 32)

    User ID when type=Custom.

  • userName: (string)

    User name when type=Custom.

  • details: (string)

    Details.

  • address: required(object)

    Address, containing callbackNumber and parsedAddress.

    • streetNum: required(string)

      Street number.

    • streetName: required(string)

      Street name.

    • city: required(string)

      City.

    • state: required(string)

      State.

    • postalCode: required(string)

      Postal code.

    • country: required(string)

      Country, default USA.

    • callbackNumber: required(string)

      Callback number.

    • parsedAddress: (object)

      Parsed address. Not used in request while posting new EmergencyLocation.

      • streetNum: required(string)

        Street number.

      • preDirectional: (string)

        Street name pre-directional.

      • streetName: required(string)

        Street name.

      • streetSuffix: (string)

        Street suffix.

      • postDirectional: (string)

        Street name post-directional.

      • city: required(string)

        City.

      • state: required(string)

        State.

      • postalCode: required(string)

        Postal code.

      • country: required(string)

        Country, default USA.

Example:

{
  "name": "test",
  "type": "Common",
  "address": {
    "streetNum": "550",
    "streetName": "W Adams St",
    "city": "Chicago",
    "state": "IL",
    "postalCode": "60661",
    "country": "USA",
    "callbackNumber": "01234",
    "parsedAddress": {
      "streetNum": "550",
      "preDirectional": "W",
      "streetName": "Adams",
      "streetSuffix": "St",
      "city": "Chicago",
      "state": "IL",
      "postalCode": "60661",
      "country": "USA"
    }
  },
  "details": "any text",
  "id": "285CF3CCBEC7407BB25E075F0738D66D"
}

Delete emergency location.

URI Parameters

  • emergencyLocationId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/userEmergencyLocations

Collection of userEmergencyLocations.

get post

get

Get a list of userEmergencyLocations.

post

Add new userEmergencyLocation. If user already has one, then it is updated with the given location. Can use "me" as userId for logged in user.

Add new userEmergencyLocation. If user already has one, then it is updated with the given location. Can use "me" as userId for logged in user.

Body

Media type: application/json

Type: object

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

    ID.

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

    User ID.

  • userName: (string)

    User name.

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

    Emergency location ID.

  • locationName: (string)

    Emergency location name.

Example:

{
  "locationId": "AE06C73027B24739A1893B995CF67184",
  "userId": "me"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

get delete

Entity representing a userEmergencyLocation.

get

Get the userEmergencyLocation with userEmergencyLocationId = {userEmergencyLocationId}.

delete

Delete emergency location from user. Emergency location itself is not deleted.

Get the userEmergencyLocation with userEmergencyLocationId = {userEmergencyLocationId}.

URI Parameters

  • userEmergencyLocationId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

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

    ID.

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

    User ID.

  • userName: (string)

    User name.

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

    Emergency location ID.

  • locationName: (string)

    Emergency location name.

Example:

{
  "locationId": "AE06C73027B24739A1893B995CF67184",
  "locationName": "test",
  "userId": "30BAC5C8C39A4CA5A5B1C5509EE4F12B",
  "userName": "Surname, First Name",
  "id": "C2704D2DB51B4C299DC4431B1E3DC7C1"
}

Delete emergency location from user. Emergency location itself is not deleted.

URI Parameters

  • userEmergencyLocationId: required(string)

HTTP status code 204

No content - The server has successfully fulfilled the request and there is no additional content to send in the response payload body.

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found