Online обавештење
INFO
Ова страница обухвата подешавање одлазних имејлова са обавештењима система: SMTP (или локални MTA) подешавања која Zammad користи за слање сопствених интерних обавештења, као што је „додељен вам је тикет”, као и локални идентитет пошиљаоца (EmailAddress) који им се придружује. Ово је различито од канала поштанског сандучета за тикете / сандучета подршке, што је засебна функција коју ова страница не обухвата.
Преглед листе
Потребна дозвола: admin.calendar
GET-захтев послат: /api/v1/calendars
Ово је комбиновани индекс: у једном одговору враћа канал(е) за обавештења, канал(е) поштанских сандучића за тикете и локалне адресе пошиљалаца. Одговор испод је скраћен на поља релевантна за подешавање имејлова са обавештењима.
Details
// HTTP-Code 200 OK
[
{
"id": 4,
"o_id": 6,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": false,
"updated_by_id": 8,
"created_by_id": 8,
"created_at": "2021-11-09T13:15:42.628Z",
"updated_at": "2021-11-09T13:15:42.637Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "ethan@fastlane.inc",
"updated_by": "ethan@fastlane.inc"
},
{
"id": 3,
"o_id": 8,
"object_lookup_id": 2,
"type_lookup_id": 2,
"user_id": 3,
"seen": false,
"updated_by_id": 4,
"created_by_id": 4,
"created_at": "2021-11-09T13:10:42.628Z",
"updated_at": "2021-11-09T13:15:42.635Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "update",
"created_by": "hannah@fastlane.inc",
"updated_by": "hannah@fastlane.inc"
},
{
"id": 2,
"o_id": 3,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": true,
"updated_by_id": 6,
"created_by_id": 6,
"created_at": "2021-11-09T12:45:42.625Z",
"updated_at": "2021-11-09T13:15:42.632Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "anna@example.com",
"updated_by": "anna@example.com"
},
{
"id": 1,
"o_id": 2,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": true,
"updated_by_id": 5,
"created_by_id": 5,
"created_at": "2021-11-09T11:45:42.624Z",
"updated_at": "2021-11-09T13:15:42.629Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "emily@fastlane.inc",
"updated_by": "emily@fastlane.inc"
}
]INFO
По подешавању обавештења само један канал истовремено може бити active: true. Подешавање новог (погледајте Configure испод) аутоматски деактивира онај који је претходно био активан. У одговору изнад, sendmail (id 2) је сада active: false јер је smtp (id 1) подешен након њега.
Подешавања
Потребна дозвола: admin.calendar
PUT-захтев послат: /api/v1/online_notifications/{id}
INFO
Проследите подешавања адаптера у кључу options највишег нивоа, као што је приказано испод. Други називи кључева, као што је new_configuration (назив параметра интерне сервисне класе Service::System::SetEmailNotificationConfiguration), не одбијају се грешком валидације. Уместо тога, захтев не успева са необрађеном грешком undefined method 'downcase' for nil.
Details
{
"mentionable_type": "Ticket",
"mentionable_id": 12
}INFO
Овај позив има двоструку улогу: уживо тестира конекцију, шаљући као споредни ефекат стварни тест имејл, и ако тест успе, чува подешавање као активни канал за обавештења у истом позиву. Не постоји засебан корак „чувања”; notification_channel_ids у /api/v1/channels_email одмах одражава нови канал.
Ако конекција не може да се успостави, одговор је 200 OK са result: invalid, а сачувано подешавање остаје непромењено.
Details
// HTTP-Code 200 OK
{
"id": 4,
"o_id": 6,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": false,
"updated_by_id": 8,
"created_by_id": 8,
"created_at": "2021-11-09T13:15:42.628Z",
"updated_at": "2021-11-09T13:15:42.637Z"
}INFO
POST /api/v1/channels_email_probe није алтернатива овој крајњој тачки за подешавање само за обавештења. Он увек проверава комплетно долазно и одлазно поштанско сандуче (EmailHelper::Probe.full). Слање SMTP подешавања само за одлазну пошту овој крајњој тачки враћа {"result": "failed", "reason": "inbound failed"}, чак и када су одлазна подешавања исправна.
Details
// HTTP-Code 200 OK
[
{
"id": 4,
"o_id": 6,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": false,
"updated_by_id": 8,
"created_by_id": 8,
"created_at": "2021-11-09T13:15:42.628Z",
"updated_at": "2021-11-09T13:15:42.637Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "ethan@fastlane.inc",
"updated_by": "ethan@fastlane.inc"
},
{
"id": 3,
"o_id": 8,
"object_lookup_id": 2,
"type_lookup_id": 2,
"user_id": 3,
"seen": false,
"updated_by_id": 4,
"created_by_id": 4,
"created_at": "2021-11-09T13:10:42.628Z",
"updated_at": "2021-11-09T13:15:42.635Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "update",
"created_by": "hannah@fastlane.inc",
"updated_by": "hannah@fastlane.inc"
},
{
"id": 2,
"o_id": 3,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": true,
"updated_by_id": 6,
"created_by_id": 6,
"created_at": "2021-11-09T12:45:42.625Z",
"updated_at": "2021-11-09T13:15:42.632Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "anna@example.com",
"updated_by": "anna@example.com"
},
{
"id": 1,
"o_id": 2,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": true,
"updated_by_id": 5,
"created_by_id": 5,
"created_at": "2021-11-09T11:45:42.624Z",
"updated_at": "2021-11-09T13:15:42.629Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "emily@fastlane.inc",
"updated_by": "emily@fastlane.inc"
}
]Имена и имејл адресе
Локалним идентитетом пошиљаоца који се користи за одлазне имејлове са обавештењима управља се као ресурсом EmailAddress.
Преглед листе
Потребна дозвола: admin.user или ticket.agent
GET-Захтев послат: /api/v1/slas
Враћа низ објеката, од којих сваки има структуру појединачног објекта приказаног у одговору Show испод.
Details
// HTTP-Code 200 OK
[
{
"id": 4,
"o_id": 6,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": false,
"updated_by_id": 8,
"created_by_id": 8,
"created_at": "2021-11-09T13:15:42.628Z",
"updated_at": "2021-11-09T13:15:42.637Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "ethan@fastlane.inc",
"updated_by": "ethan@fastlane.inc"
},
{
"id": 3,
"o_id": 8,
"object_lookup_id": 2,
"type_lookup_id": 2,
"user_id": 3,
"seen": false,
"updated_by_id": 4,
"created_by_id": 4,
"created_at": "2021-11-09T13:10:42.628Z",
"updated_at": "2021-11-09T13:15:42.635Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "update",
"created_by": "hannah@fastlane.inc",
"updated_by": "hannah@fastlane.inc"
},
{
"id": 2,
"o_id": 3,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": true,
"updated_by_id": 6,
"created_by_id": 6,
"created_at": "2021-11-09T12:45:42.625Z",
"updated_at": "2021-11-09T13:15:42.632Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "anna@example.com",
"updated_by": "anna@example.com"
},
{
"id": 1,
"o_id": 2,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": true,
"updated_by_id": 5,
"created_by_id": 5,
"created_at": "2021-11-09T11:45:42.624Z",
"updated_at": "2021-11-09T13:15:42.629Z",
"user": "lauren@fastlane.inc",
"object": "Ticket",
"type": "create",
"created_by": "emily@fastlane.inc",
"updated_by": "emily@fastlane.inc"
}
]Прикажи
Потребна дозвола: admin.user или ticket.agent
GET-Захтев послат: /api/v1/slas/{id}
Details
// HTTP-Code 200 OK
{
"id": 4,
"o_id": 6,
"object_lookup_id": 2,
"type_lookup_id": 1,
"user_id": 3,
"seen": false,
"updated_by_id": 8,
"created_by_id": 8,
"created_at": "2021-11-09T13:15:42.628Z",
"updated_at": "2021-11-09T13:15:42.637Z"
}Креирај
Потребна дозвола: admin.calendar
POST-Захтев послат: /api/v1/slas
INFO
channel_id је референца, а не предмет провере: ID који не постоји се прихвата, а адреса се тада чува са channel_id: null и active: false. Адресе се обично придружују каналу поштанског сандучета за тикете, а не каналу за обавештења.
Details
{
"seen": true
}Освежавање
Потребна дозвола: admin.calendar
PUT-Захтев послат: /api/v1/slas/{id}
Структура садржаја захтева је иста као код Create. Слање комплетног садржаја захтева за Create на id постојеће адресе освежава тај запис на месту. Не прави се дупликат. Одговор је освежени запис, исте структуре као одговор за Create изнад.
Details
{
"seen": true
}Обриши
Потребна дозвола: admin.calendar
DANGER
Ово је трајно уклањање
Имајте на уму да се уклањање имејл адреса не може поништити.
Групе које користе обрисане адресе као адресе пошиљаоца (email_address_id) ће бити снимљене без адресе пошиљаоца.
DELETE-Захтев послат: /api/v1/slas/{id}
Details
// HTTP-Code 200 OK
{}