Категории

Виды запросов

Содержание


Внимание. Если вы используете коробочную версию Юздеска на собственном сервере, URL методов у вас будет отличаться. Уточните URL для работы с API у поддержки — support@usedesk.ru.


Создание запроса

При создании запроса система отправляет вебхук, который содержит:

Параметр Значение

secret

id приложения

id

id запроса
status_id

id статуса запроса.

Перечень возможных статусов:

  • 1 (открыт)
  • 2 (выполнен)
  • 3 (закрыт)
  • 4 (удален)
  • 5 (на удержании)
  • 6 (в ожидании)
  • 7 (спам)
  • 8 (новый)
  • 9 (рассылка)
  • 10 (объединён)
subject

Тема запроса

client_id id клиента
assignee_id id исполнителя (агента)
group id группы исполнителя
last_updated_at Дата последнего изменения запроса
channel_id id канала
email Почта клиента, с которой он написал
published_at Дата создания запроса
company_id id компании (аккаунта), из которой пришел вебхук
additional_id Дополнительный идентификатор запроса
message Текст сообщения клиента
files Ссылка на файл, прикреплённый к сообщению или отправленный как сообщение
client

Информация о клиенте. Содержит параметры:

  • id
  • name – имя
  • avatar – аватар
  • note – заметка
  • emails – почта
  • phones —телефон
  • additional_ids – дополнительный идентификатор
custom_fields

Список полей и их значения. Отправляется только при изменении хотя бы одного из доп. полей.

Содержит параметры:

  • id — id доп. поля
  • name — название доп. поля
  • value — значение доп. поля
custom_blocks

Список доп. блоков системы, который содержит параметры:

  • name — название блока
  • url — url блока
  • secret_key — секретный токен блока

Пример ответа от сервера 
{
    "secret": "0e8f678d8327eb3292a28c8165957b282a1b2f8b",
    "ticket": {
        "id": 2261907,
        "status_id": 1,
        "subject": "First msg",
        "client_id": 242630,
        "assignee_id": null,
        "group": "0",
        "last_updated_at": "2016-12-17 14:07:33",
        "channel_id": 1234,
        "email": "jon@bonjovi.com",
        "published_at": "2016-12-17 14:07:33",
        "company_id": 153561,
        "additional_id": 123Ca344,
        "message": "Test",
        "files": [
      "https://secure.usedesk.ru/v2/files/153712/68977353/249358488/get-file?key=RGh1WDRMNGRzSVQ0VzJVT0NTYW5kdz09Ojoh7gEtjMrY29NOBS8QyIHQ&filter_name=0"
    ]
    },
        "client": {
        "id": 32917577,
        "name": "Юля Шовгеня",
        "avatar": "/upload/avatars/123.jpg",
        "note": "есть кредит",
        "emails": [
          {
            "email": "shy@usedesk.ru",
            "client_id": 32917577
          },
          {
            "email": "ylia-8322247@mail.ru",
            "client_id": 32917577
          }
        ],
        "phones": [
          {
            "phone": "79254697403",
            "type": "home",
            "client_id": 32917577
          },
          {
            "phone": "",
            "type": "home",
            "client_id": 32917577
          }
         ],
         "additional_ids": [
          {
            "value": "99999",
            "client_id": 32917577
          }
         ]
    },
    "custom_fields":[
        {
            "id": 54,
            "name": "new item 2",
            "value": null
        }
    ],
    "custom_blocks": [
        {
            "name": "Test",
            "url": "https://usedesk.ru/",
            "secret_key": "dsf4354f=-213sdfasdsa"
        }
    ]
}


Изменение запроса

При изменении запроса система отправляет вебхук, который содержит:

ПараметрЗначение

secret

id приложения

id

id события изменения запроса
trigger_id

id правила, которое изменило запрос

Если "null" — значит, запрос изменил пользователь

user_id

id пользователя, который изменил запрос

Если "null" — значит, запрос изменило правило

ticket_idid запроса
data

Массив изменений, которые были применены к запросу, содержит параметры:

  • target — какое поле было изменено
  • value — на какое значение было изменено поле
  • old_value — с какого значения было изменено поле
changed_at

Дата изменения

old_statusid предыдущего статуса запроса
new_statusid нового статуса запроса
company_idid компании (аккаунта), из которой пришел вебхук
custom_fields

Список полей и их значения. Отправляется только при изменении хотя бы одного из доп. полей.

Содержит параметры:

  • id — id доп. поля
  • name — название доп. поля
  • value — значение доп. поля
custom_blocks

Список доп. блоков системы, который содержит параметры:

  • name — название блока
  • url — url блока
  • secret_key — секретный токен блока
assignee_idid исполнителя (агента)
client

Информация о клиенте. Содержит параметры:

  • id
  • name – имя
  • avatar – аватар
  • note – заметка
  • emails – почта
  • phones — телефон
  • additional_ids – дополнительный идентификатор
Пример ответа от сервера 
{
    "secret": "0e8f678d8327eb3292a28c8165957b282a1b2f8b",
    "trigger": {
        "id": 204232 ,
        "trigger_id": null,
        "user_id": 2,
        "ticket_id": 2261907,
        "data":[
            {
                "target": "subject",
                "value": "POST UPDATE"
            },
            {
                "target": "status_id",
                "value": "2"
            },
            {
                "target": "priority",
                "value": "medium"
            },
            {
                "target": "type",
                "value": "task"
            }
        ],
        "changed_at": "2016-12-17 14:11:53",
        "old_status": 1,
        "new_status": 2,
        "company_id": 153561
    },
    "custom_fields":[
        {
            "id": 54,
            "name": "new item 2",
            "value": null
        }
    ],
    "custom_blocks":[
        {
            "name": "Test",
            "url": "https://usedesk.ru/",
            "secret_key": "dsf4354f=-213sdfasdsa"
        }
    ],
    "client": {
        "id": 32917577,
        "name": "Юля Шовгеня",
        "avatar": "/upload/avatars/123.jpg",
        "note": "есть кредит",
        "emails": [
          {
            "email": "shy@usedesk.ru",
            "client_id": 32917577
          }
        ],
        "phones": [
          {
            "phone": "79254697403",
            "type": "home",
            "client_id": 32917577
          }
         ],
         "additional_ids": [
          {
            "value": "99999",
            "client_id": 32917577
          }
        ]
    }
}


Создание комментария

При написании комментария в запроса система отправляет вебхук, который содержит:

ПараметрЗначение

secret

id приложения
idid комментария
messageТекст сообщения, которое отправили
filesСсылка на файл, прикреплённый к сообщению или отправленный как сообщение
type

Тип сообщения

  • private — внутренний
  • public — публичный
from

От лица кого было написано сообщение

  • user — агент
  • client — клиент

Важно: если сообщение отправлено через правило (бота), вебхук о новом сообщении отправлен не будет. Будет отправлен вебхук об изменении запроса.

user_id

id пользователя, который написал сообщение

Если "null" — значит, комментарий написал клиент

client_id

id клиента, который написал сообщение

Если "null" — значит, комментарий написал пользователь

ticket_idid запроса, в котором был написан комментарий
is_first

1 — если комментарий первый в запросе

0 — если комментарий не первый в запросе

deliveredДоставлено ли сообщение (пока не реализовано)
readedПрочитано ли сообщение (пока не реализовано)
published_atДата создания комментария
custom_fields

Список полей и их значения. Содержит параметры:

  • id — id доп. поля
  • name — название доп. поля
  • value — значение доп. поля
assignee_idid исполнителя (агента)
client

Информация о клиенте. Содержит параметры:

  • id
  • name – имя
  • avatar – аватар
  • note – заметка
  • emails – почта
  • phones — телефон
  • additional_ids – дополнительный идентификатор
Пример ответа от сервера 
{
    "secret":"0e8f678d8327eb3292a28c8165957b282a1b2f8b",
    "comment":{
        "id": 2652657,
        "message":"New message text",
        "type": "public",
        "from":"user",
        "user_id": 545,
        "client_id":null,
        "ticket_id": 2261907,
        "is_first": 0,
        "delivered": 0,
        "readed": 0,
        "published_at":"2016-12-17 14:14:37",
        "files": [
      "https://secure.usedesk.ru/v2/files/153712/68976191/249357540/get-file?key=SElTYjlZTjdYbmxXSUtxZnA3WncvZz09OjoPNc7adhZDzLDloMRpX%252BxC&filter_name=0"
    ]
    },
    "custom_fields":[
        {
            "id": 54,
            "name": "new item 2",
            "value": null
        }
    ],
    "custom_blocks":[
        {
            "name": "Test",
            "url": "https://usedesk.ru/",
            "secret_key": "dsf4354f=-213sdfasdsa"
        }
    ],
    "client": {
        "id": 32917577,
        "name": "Юля Шовгеня",
        "avatar": "/upload/avatars/123.jpg",
        "note": "есть кредит",
        "emails": [
          {
            "email": "shy@usedesk.ru",
            "client_id": 32917577
          },
          {
            "email": "ylia-8322247@mail.ru",
            "client_id": 32917577
          }
        ],
        "phones": [
          {
            "phone": "79254697403",
            "type": "home",
            "client_id": 32917577
          },
          {
            "phone": "",
            "type": "home",
            "client_id": 32917577
          }
         ],
         "additional_ids": [
          {
            "value": "99999",
            "client_id": 32917577
          }
         ]
     }
 }


Оценка

При получении оценки в запросе система отправляет вебхук, который содержит:

ПараметрЗначение

secret

id приложения
idid оценки
client_idid клиента
ticket_idid запроса
rating

Оценка, которую поставил клиент

1 — хорошо

2 — нормально

3 — плохо

company_idid компании (аккаунта), из которой пришел вебхук
ticket_comment_idid комментария к оценке
commentКомментарий к оценке
created_atДата создания оценки
updated_atДата обновления оценки
user_idid исполнителя запроса
Пример ответа от сервера 
{
    "secret": "0e8f678d8327eb3292a28c8165957b282a1b2f8b",
    "csi":{
        "id": 2652657,
        "user_id": 545,
        "client_id": 123213,
        "ticket_id": 2261907,
        "rating": 3,
        "company_id": 456,
        "ticket_comment_id": 2321,
        "comment": "New message text",
        "created_at": "2016-12-17 14:14:37",
        "updated_at": "2016-12-17 14:14:37"
    }
}