Sinch Contact Center Restful Directory and Presence Interface (DPI) API documentation 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)
  • accessType: (integer)

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

  • attrs: required(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: required(string)

      Textual value.

    • binary: required(string)

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

  • groups: required(array of Group)

    Items: Group

    • id: required(string - minLength: 32 - maxLength: 32)
    • name: required(string)
    • 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.

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)
  • accessType: (integer)

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

  • attrs: required(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: required(string)

      Textual value.

    • binary: required(string)

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

  • groups: required(array of Group)

    Items: Group

    • id: required(string - minLength: 32 - maxLength: 32)
    • name: required(string)
    • 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.

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)
  • accessType: (integer)

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

  • attrs: required(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: required(string)

      Textual value.

    • binary: required(string)

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

  • groups: required(array of Group)

    Items: Group

    • id: required(string - minLength: 32 - maxLength: 32)
    • name: required(string)
    • 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.

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

HTTP status code 404

Not Found

Body

Media type: text/plain

Type: any

Example:

HTTP 404 Not Found

/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.