Management API

Введение

GET /connections/

Получение списка подключений. Для итерации используются GET-параметры: limit, offset
1
{
2
"count": 2,
3
"connections": [
4
{
5
"id": 1,
6
"type": "amocrm",
7
"params": {
8
"radist_token": "40202c9b-fbc2-48d3-8144-b37c854d25d9",
9
"message_first_enabled": null,
10
"pipeline_send_whatsapp_message_enabled": null,
11
"domain": "example.amocrm.ru",
12
"email": "[email protected]"
13
}
14
},
15
{
16
"id": 2,
17
"type": "whatsapp",
18
"params": {
19
"radist_token": "c13c1205-5914-481c-8fa1-96784d410b59",
20
"phone": null
21
}
22
}
23
]
24
}
Copied!

GET /connections/{id}

Получение информации о подключении по его id.
1
{
2
"id": 1,
3
"type": "amocrm",
4
"params": {
5
"radist_token": "40202c9b-fbc2-48d3-8144-b37c854d25d9",
6
"message_first_enabled": null,
7
"pipeline_send_whatsapp_message_enabled": null,
8
"domain": "example.amocrm.ru",
9
"email": "[email protected]"
10
}
11
}
Copied!

POST /connections/

Создание нового подключения.
Тело запроса:
required
name
type
allowed
+
type
string
whatsapp
1
{
2
"success": true,
3
"connection": {
4
"id": 2816,
5
"type": "whatsapp",
6
"params": {
7
"radist_token": "b3ffb35a-68a0-40f4-adb9-3db95bc9960c",
8
"phone": null
9
}
10
}
11
}
Copied!

GET /integrations/

Получение списка интеграций. Для итерации используются query-параметры: limit, offset
1
{
2
"count": 3,
3
"integrations": [
4
{
5
"id": 1,
6
"type": "whatsapp_amocrm",
7
"name": "radist test",
8
"status": "enabled",
9
"params": {}
10
},
11
{
12
"id": 1396,
13
"type": "webhook",
14
"name": "",
15
"status": "disabled",
16
"params": {}
17
},
18
{
19
"id": 1398,
20
"type": "webhook",
21
"name": "test",
22
"status": "disabled",
23
"params": {}
24
}
25
]
26
}
Copied!

GET /integrations/{id}

Получение информации об интеграции по id.
1
{
2
"id": 1404,
3
"type": "webhook",
4
"name": "test",
5
"status": "disabled",
6
"tags": null,
7
"params": {
8
"webhook_url": "https://example.com/"
9
},
10
"connected": [2]
11
}
Copied!

POST /integrations/

Создание новой интеграции.
Тело запроса:
required
name
type
allowed
+
type
string
webhook
+
name
string
1
{
2
"success": true,
3
"integration": {
4
"id": 1403,
5
"type": "webhook",
6
"name": "test 1",
7
"status": "disabled",
8
"params": {}
9
}
10
}
Copied!

POST /integrations/{id}/bind

Добавление подключения к интеграции. Доступно только для интеграций типа webhook.
Тело запроса:
required
name
type
allowed
+
connection_id
int
1
{
2
"success": true,
3
"message": "bound"
4
}
Copied!

POST /integrations/{id}/unbind

Отсоединение подключения от интеграции. Доступно только для интеграций типа webhook.
Тело запроса:
required
name
type
allowed
+
connection_id
int
1
{
2
"success": true,
3
"message": "unbound"
4
}
Copied!

POST /integrations/{id}/settings

Обновление настроек интеграции. Доступно только для интеграций типа webhook.
Сервер по адресу webhook_url должен ответить статусом HTTP 200 на POST-запрос с JSON-телом {"radist_webhook": "test"}
Тело запроса:
required
name
type
allowed
+
webhook_url
string

POST /integrations/{id}/enable

Перевести интеграцию в статус “Включена”.

POST /integrations/{id}/disable

Перевести интеграцию в статус “Отключена”.

POST /integrations/{id}/delete

Удалить интеграцию.
Last modified 4mo ago