v1.0.0

Communigate Pro API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Вспомогательные методы API в дополнение к интерфейсу XIMSS

Servers

http://localhost:8100

---

Аутентификация

Операции управления аутентификацией: создание, проверка и отзыв.

Operations

GET/api/v1/authPOST/api/v1/authDELETE/api/v1/auth

---

Проверка аутентификации

GET

/api/v1/auth

Проверяет действительность cookie AID и статус текущей аутентификации. Используется для валидации текущего сеанса. Тело ответа отсутствует.

Parameters

Responses

Аутентифицирован.

GET

/api/v1/auth

Playground

Samples

cURL

JavaScript

PHP

Python

---

Cоздание аутентификации

POST

/api/v1/auth

Принимает поля формы username и password. При успехе устанавливает cookie AID в формате account#verificationCode. Тело ответа отсутствует.

Request Body

application/x-www-form-urlencoded

object

Имя пользователя

Пароль пользователя

Responses

Создано. Установлена cookie AID.

POST

/api/v1/auth

Playground

Body

username*

password*

Samples

cURL

JavaScript

PHP

Python

---

Отзыв аутентификации

DELETE

/api/v1/auth

Отзывает текущее состояние аутентификации и очищает cookie AID. Тело ответа отсутствует.

Parameters

Responses

Выполнено.

DELETE

/api/v1/auth

Playground

Samples

cURL

JavaScript

PHP

Python

---

vcs

Operations

GET/Session/{sessionId}/api/v1/vcsGET/Session/{sessionId}/api/v1/vcs/{vcs}POST/Session/{sessionId}/api/v1/vcs/{vcs}

---

List all available VCS services

GET

/Session/{sessionId}/api/v1/vcs

Parameters

Path Parameters

sessionId*

User session id

Typestring

Required

Responses

List of available VCS services

Content-Type

application/json

[

{

"id": "string",

"title": "string",

"iconUrl": "string"

}

]

GET

/Session/{sessionId}/api/v1/vcs

Playground

Variables

Key

Value

sessionId*

Samples

cURL

JavaScript

PHP

Python

---

Get VCS service info

GET

/Session/{sessionId}/api/v1/vcs/{vcs}

Parameters

Path Parameters

sessionId*

User session id

Typestring

Required

vcs*

Name of VCS service

Typestring

Required

Responses

VCS info

Content-Type

application/json

{

"id": "string",

"title": "string",

"iconUrl": "string"

}

GET

/Session/{sessionId}/api/v1/vcs/{vcs}

Playground

Variables

Key

Value

sessionId*

vcs*

Samples

cURL

JavaScript

PHP

Python

---

Create a conference

POST

/Session/{sessionId}/api/v1/vcs/{vcs}

Parameters

Path Parameters

sessionId*

User session id

Typestring

Required

vcs*

Name of VCS service

Typestring

Required

Request Body

application/json

{

"topic": "string",

"description": "string",

"participants": [

{

"name": "string",

"peer": "string"

}

]

}

Responses

Created conference info

Content-Type

application/json

{

"cid": "string",

"clientURL": ""

}

POST

/Session/{sessionId}/api/v1/vcs/{vcs}

Playground

Variables

Key

Value

sessionId*

vcs*

Body

Samples

cURL

JavaScript

PHP

Python

---

resource

Operations

GET/Session/{sessionId}/api/v1/resources

---

List all available Resource mailboxes

GET

/Session/{sessionId}/api/v1/resources

Parameters

Path Parameters

sessionId*

User session id

Typestring

Required

Responses

List of available Resource mailboxes

Content-Type

application/json

[

{

"EMail": "string",

"Name": "string"

}

]

GET

/Session/{sessionId}/api/v1/resources

Playground

Variables

Key

Value

sessionId*

Samples

cURL

JavaScript

PHP

Python

---

ldap

Operations

POST/Session/{sessionId}/api/v1/ldap/search

---

Search LDAP Directory records

POST

/Session/{sessionId}/api/v1/ldap/search

Retrieves records from the Directory starting from one or more base DNs.

Parameters

Path Parameters

sessionId*

User session id

Typestring

Required

Request Body

application/json

{

"baseDNs": [

"string"

],

"fields": [

"string"

],

"filter": "string",

"scope": "one",

"limit": 100,

"sortFields": [

"string"

],

"sortOrder": "string"

}

Responses

Directory records successfully retrieved.

Content-Type

application/json

{

"records": [

{

"additionalProperties": "string"

}

]

}

POST

/Session/{sessionId}/api/v1/ldap/search

Playground

Variables

Key

Value

sessionId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Публичный доступ к календарю

Operations

POST/Session/{sessionId}/pubcalperms.wcgp

---

Управление публичным доступом к пользовательскому календарю

POST

/Session/{sessionId}/pubcalperms.wcgp

Parameters

Path Parameters

sessionId*

Идентификатор сессии

Typestring

Required

Request Body

application/json

{

"operation": "create",

"calendar": "My Calendar"

}

Responses

Текущий код доступа получен.

Content-Type

application/json

{

"user": "user@cgp.local",

"calendar": "My Calendar",

"code": "4f5698a23"

}

POST

/Session/{sessionId}/pubcalperms.wcgp

Playground

Variables

Key

Value

sessionId*

Body

Samples

cURL

JavaScript

PHP

Python

---

Получение рабочего времени пользователя

Operations

GET/Session/{sessionId}/api/v1/~{account}/worktime

---

Get account work time information

GET

/Session/{sessionId}/api/v1/~{account}/worktime

Parameters

Path Parameters

sessionId*

User session id

Typestring

Required

account*

Full account name

Typestring

Required

Responses

Account work time information

Content-Type

{

"TimeZone": "(+0300) Saudi Arabia",

"WorkDayStart": 28800,

"WorkDayEnd": 61200,

"WorkDays": [

"string"

]

}

GET

/Session/{sessionId}/api/v1/~{account}/worktime

Playground

Variables

Key

Value

sessionId*

account*

Samples

cURL

JavaScript

PHP

Python

---