Sinch Contact Center Restful Directory and Presence Interface (DPI) version v1

http://localhost:8080/RI/dpi

Description

This interface provides directory data, and for internal users and queues also presence information.

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.

/entries

Collection of entries.

get post

get

Get a list of entries.

post

Add a new entry. Currently binary attributes are not supported. New entry is added to the given groups.

Add a new entry. Currently binary attributes are not supported. New entry is added to the given groups.

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)
  • sourceType: (one of User, Queue)
  • sourceId: (string)
  • accessType: (integer)

    Combination of rights that the user has to this entry: VIEW=1, MODIFY=2

  • attrs: (array of EntryAttribute)

    Items: EntryAttribute

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

      Master ID. Values can be fetched using /template resource.

    • language: required(string)

      Two letter language code like EN, FI.

    • value: (string)

      Textual value.

    • binary: (string)

      Base64 encoded binary value, for example image. value can contain the original file name in this case.

  • groups: (array of Group)

    Items: Group

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

      User group ID if synchronized from user group.

    • accessType: (integer)

      Combination of rights that the user has to this group: VIEW=1, MODIFY=2, CREATE=4, DELETE=8, MANAGE_MEMBERS=0x80 Used only in /groups resource.

    • memberCount: (integer)

      Number of directory entries in this group.

    • groupCount: (integer)

      Number of sub-groups in this group.

Example:

{
  "attrs": [
    {
      "id": "10D9AF6DC16440928BCDA741BF748784",
      "language": "EN",
      "value": "Entry name"
    },
    {
      "id": "9A55749A60F54F9CB0C8AEE662681E3E",
      "language": "EN",
      "value": "email@address.com"
    }
  ],
  "groups": [
    {
      "id": "7418024D395347338BB1BC2483EE7983",
      "name": "Directory group name"
    }
  ]
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

F5168FBDD6914C8DB1C6D0BD64563A39

put delete get

Entity representing a entry.

put

Update the entry with id = {entryId}. Binary attributes are not currently supported.

delete

Removes entry from the given group. If entry does not have any groups left, then it will be permanently deleted.

get

Get the entry with entryId = {entryId}.

Update the entry with id = {entryId}. Binary attributes are not currently supported.

URI Parameters

  • entryId: required(string)

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)
  • sourceType: (one of User, Queue)
  • sourceId: (string)
  • accessType: (integer)

    Combination of rights that the user has to this entry: VIEW=1, MODIFY=2

  • attrs: (array of EntryAttribute)

    Items: EntryAttribute

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

      Master ID. Values can be fetched using /template resource.

    • language: required(string)

      Two letter language code like EN, FI.

    • value: (string)

      Textual value.

    • binary: (string)

      Base64 encoded binary value, for example image. value can contain the original file name in this case.

Example:

{
  "id": "A7D627C26A2A458A99D127C5E207A020",
  "attrs": [
    {
      "id": "10D9AF6DC16440928BCDA741BF748784",
      "language": "EN",
      "value": "Entry name modified"
    },
    {
      "id": "9A55749A60F54F9CB0C8AEE662681E3E",
      "language": "EN",
      "value": "email.modified@address.com"
    }
  ]
}

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.

Removes entry from the given group. If entry does not have any groups left, then it will be permanently deleted.

URI Parameters

  • entryId: required(string)

Query Parameters

  • groupId: required(string)

    User needs to have MANAGE_MEMBERS right to this group.

    Example:

    ?groupId=7418024D395347338BB1BC2483EE7983

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.

Get the entry with entryId = {entryId}.

URI Parameters

  • entryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • id: required(string - minLength: 32 - maxLength: 32)
  • sourceType: (one of User, Queue)
  • sourceId: (string)
  • accessType: (integer)

    Combination of rights that the user has to this entry: VIEW=1, MODIFY=2

  • attrs: (array of EntryAttribute)

    Items: EntryAttribute

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

      Master ID. Values can be fetched using /template resource.

    • language: required(string)

      Two letter language code like EN, FI.

    • value: (string)

      Textual value.

    • binary: (string)

      Base64 encoded binary value, for example image. value can contain the original file name in this case.

  • groups: (array of Group)

    Items: Group

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

      User group ID if synchronized from user group.

    • accessType: (integer)

      Combination of rights that the user has to this group: VIEW=1, MODIFY=2, CREATE=4, DELETE=8, MANAGE_MEMBERS=0x80 Used only in /groups resource.

    • memberCount: (integer)

      Number of directory entries in this group.

    • groupCount: (integer)

      Number of sub-groups in this group.

Example:

{
  "id": "A7D627C26A2A458A99D127C5E207A020",
  "accessType": 3,
  "attrs": [
    {
      "id": "10D9AF6DC16440928BCDA741BF748784",
      "language": "EN",
      "value": "Entry name"
    },
    {
      "id": "9A55749A60F54F9CB0C8AEE662681E3E",
      "language": "EN",
      "value": "email@address.com"
    }
  ],
  "groups": [
    {
      "id": "7418024D395347338BB1BC2483EE7983",
      "name": "Directory group name"
    }
  ]
}

get post

Collection of groups.

get

Get a list of groups for entry.

post

Add entry to group.

Get a list of groups for entry.

URI Parameters

  • entryId: required(string)

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: groups

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

    User group ID if synchronized from user group.

  • accessType: (integer)

    Combination of rights that the user has to this group: VIEW=1, MODIFY=2, CREATE=4, DELETE=8, MANAGE_MEMBERS=0x80 Used only in /groups resource.

  • memberCount: (integer)

    Number of directory entries in this group.

  • groupCount: (integer)

    Number of sub-groups in this group.

Example:

[
    {
        "id": "49325A3754164AC0AA066BB2161B0E0F",
        "name": "A directory group",
        "accessType": 5
    },
    {
        "id": "87EC5C19000F44F285842766FDADB3DA",
        "name": "CCtr-queues",
        "accessType": 7
    },
    {
        "id": "7418024D395347338BB1BC2483EE7983",
        "name": "A personal group where user can create new entries",
        "accessType": 143
    },
    {
        "id": "01847173EE7B441689AF95A91EF18892",
        "name": "CCtr-users",
        "accessType": 7
    },
    {
        "id": "39EAFCD45D1345C8A6A2E3C4090B4F07",
        "name": "HelpDesk",
        "accessType": 5,
        "sourceId": "27A817A5E23C487F94AB46FC0B0B2581"
    }
]

Add entry to group.

URI Parameters

  • entryId: required(string)

Body

Media type: application/json

Type: object

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

Example:

{
  "id": "49325A3754164AC0AA066BB2161B0E0F"
}

HTTP status code 201

Returns the created id.

Body

Media type: text/html

Type: any

Example:

49325A3754164AC0AA066BB2161B0E0F

/entryDetails

Collection of entryDetails.

get

get

Get a list of entryDetails. Binary attributes and groups are not returned to make the operation faster and result smaller. Only VIEW=1 right is returned for the entries. Use GET /entries/:id to get single entryDetails with binary attributes and groups, and possible MODIFY=2 right.

/groups

Collection of groups.

get

get

Get a list of groups.

/template

Entity representing a template.

get

get

Get the currently logged-in user's directory view template with containers and masters.