data.attachments[] |
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.attachments[][id] |
integer |
* |
The unique ID. |
data.attachments[][ticket] |
integer id (Ticket) |
* |
Ticket this attachment belongs to.
|
data.attachments[][person] |
integer id (Person) |
* |
Who created the attachment. |
data.attachments[][blob] |
object (Blob) |
* |
Actual attachment. |
data.attachments[][blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.attachments[][blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.attachments[][blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.attachments[][blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.attachments[][blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.attachments[][blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.attachments[][blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.attachments[][blob][authcode]
|
string |
* |
|
data.attachments[][blob][blob_hash]
|
string |
* |
|
data.attachments[][blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.attachments[][blob][title] |
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.attachments[][blob][dim_w] |
integer |
* |
If this type of file has dimentions,
the width.
|
data.attachments[][blob][dim_h] |
integer |
* |
If this type of file has dimentions,
the height.
|
data.attachments[][blob][date_created]
|
DateTime |
* |
|
data.attachments[][blob][is_temp]
|
boolean |
* |
|
data.attachments[][blob][source_ref]
|
string |
* |
|
data.attachments[][blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.attachments[][blob][labels][][blob]
|
object (Blob) |
* |
|
data.attachments[][message] |
integer id (TicketMessage) |
* |
Message - holder of this attachment.
|
data.attachments[][is_agent_note]
|
boolean |
* |
True if this attachmen just a note.
|
data.attachments[][is_inline] |
boolean |
* |
Is this attachment is embed in
message.
|
data.snippet_use_logs[] |
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.snippet_use_logs[][id] |
integer |
* |
The unique ID. |
data.snippet_use_logs[][snippet]
|
object (SnippetV2) |
* |
Snippet used. |
data.snippet_use_logs[][snippet][id]
|
integer |
* |
|
data.snippet_use_logs[][snippet][title]
|
string |
* |
|
data.snippet_use_logs[][snippet][author]
|
object (Person) |
* |
|
data.snippet_use_logs[][snippet][is_private]
|
boolean |
* |
|
data.snippet_use_logs[][snippet][avatar]
|
object (Blob) |
* |
|
data.snippet_use_logs[][snippet][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][snippet][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][snippet][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][snippet][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][snippet][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][snippet][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][snippet][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][snippet][avatar][authcode]
|
string |
* |
|
data.snippet_use_logs[][snippet][avatar][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][snippet][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][snippet][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][snippet][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][snippet][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][snippet][avatar][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][snippet][avatar][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][snippet][avatar][source_ref]
|
string |
* |
|
data.snippet_use_logs[][snippet][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][snippet][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][snippet][status]
|
string |
* |
|
data.snippet_use_logs[][snippet][shortcut_codes]
|
array |
* |
|
data.snippet_use_logs[][snippet][inline_translations]
|
array |
* |
|
data.snippet_use_logs[][snippet][translations][]
|
array of objects
(SnippetV2Translation)
|
* |
|
data.snippet_use_logs[][snippet][translations][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][snippet][translations][][snippet]
|
object (SnippetV2) |
* |
Snippet translated. |
data.snippet_use_logs[][snippet][translations][][language]
|
object (Language) |
* |
|
data.snippet_use_logs[][snippet][translations][][language][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][snippet][translations][][language][sys_name]
|
string |
* |
The unique sys name assigned to the
language.
|
data.snippet_use_logs[][snippet][translations][][language][title]
|
string |
* |
Title of the language. |
data.snippet_use_logs[][snippet][translations][][language][title_local]
|
string |
* |
Title of the language. |
data.snippet_use_logs[][snippet][translations][][language][base_filepath]
|
string |
* |
The base filepath for default phrases
for this lang.
|
data.snippet_use_logs[][snippet][translations][][language][locale]
|
string |
* |
The locale code. |
data.snippet_use_logs[][snippet][translations][][language][flag_image]
|
string |
* |
String path to image. |
data.snippet_use_logs[][snippet][translations][][language][is_rtl]
|
boolean |
* |
True if this is a right-to-left
language.
|
data.snippet_use_logs[][snippet][translations][][language][has_user]
|
boolean |
* |
True if has user. |
data.snippet_use_logs[][snippet][translations][][language][has_agent]
|
boolean |
* |
True if has agent. |
data.snippet_use_logs[][snippet][translations][][language][has_admin]
|
boolean |
* |
True if has admin. |
data.snippet_use_logs[][snippet][translations][][language][plural_categories][]
|
array of strings |
* |
|
data.snippet_use_logs[][snippet][translations][][language][plural_formula]
|
string |
* |
A formula using "n" being an integer.
This formula should be compatible with
most C-based languages that support
ternary operators. Booleans should be
cast to an integer (i.e. true = 1,
false = 0). Given an integer n, this
formular returns the plural form to
use for that number. The plural form
can be used as the index to find the
category name.
|
data.snippet_use_logs[][snippet][translations][][language][flag_urn]
|
string |
* |
Used in new admin to set custom flag
icon in the format:
`urn:deskpro:flag:$countryCode`
|
data.snippet_use_logs[][snippet][translations][][content]
|
array |
* |
Snippet content. |
data.snippet_use_logs[][snippet][translations][][blobs][]
|
array of objects (Blob) |
* |
|
data.snippet_use_logs[][snippet][categories][]
|
array of objects (SnippetV2Category)
|
* |
|
data.snippet_use_logs[][snippet][categories][][id]
|
integer |
* |
|
data.snippet_use_logs[][snippet][categories][][title]
|
string |
* |
|
data.snippet_use_logs[][snippet][categories][][is_global]
|
boolean |
* |
|
data.snippet_use_logs[][snippet][categories][][display_order]
|
integer |
* |
|
data.snippet_use_logs[][snippet][categories][][parent]
|
object (SnippetV2Category) |
* |
|
data.snippet_use_logs[][snippet][categories][][agent_teams][]
|
array of objects (AgentTeam) |
* |
|
data.snippet_use_logs[][snippet][categories][][agent_teams][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][snippet][categories][][agent_teams][][name]
|
string |
* |
The name of agent team. |
data.snippet_use_logs[][snippet][categories][][agent_teams][][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.snippet_use_logs[][snippet][display_order]
|
integer |
* |
|
data.snippet_use_logs[][snippet][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message]
|
object (TicketMessage) |
* |
Ticket Message where the snippet was
used.
|
data.snippet_use_logs[][ticket_message][id]
|
integer |
* |
The unique id of message. |
data.snippet_use_logs[][ticket_message][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.snippet_use_logs[][ticket_message][ticket][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][auth]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][parent_ticket]
|
object (Ticket) |
* |
Parent ticket. |
data.snippet_use_logs[][ticket_message][ticket][children_tickets][]
|
array of objects (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][language]
|
object (Language) |
* |
The language the ticket is in. |
data.snippet_use_logs[][ticket_message][ticket][language][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][language][sys_name]
|
string |
* |
The unique sys name assigned to the
language.
|
data.snippet_use_logs[][ticket_message][ticket][language][title]
|
string |
* |
Title of the language. |
data.snippet_use_logs[][ticket_message][ticket][language][title_local]
|
string |
* |
Title of the language. |
data.snippet_use_logs[][ticket_message][ticket][language][base_filepath]
|
string |
* |
The base filepath for default phrases
for this lang.
|
data.snippet_use_logs[][ticket_message][ticket][language][locale]
|
string |
* |
The locale code. |
data.snippet_use_logs[][ticket_message][ticket][language][flag_image]
|
string |
* |
String path to image. |
data.snippet_use_logs[][ticket_message][ticket][language][is_rtl]
|
boolean |
* |
True if this is a right-to-left
language.
|
data.snippet_use_logs[][ticket_message][ticket][language][has_user]
|
boolean |
* |
True if has user. |
data.snippet_use_logs[][ticket_message][ticket][language][has_agent]
|
boolean |
* |
True if has agent. |
data.snippet_use_logs[][ticket_message][ticket][language][has_admin]
|
boolean |
* |
True if has admin. |
data.snippet_use_logs[][ticket_message][ticket][language][plural_categories][]
|
array of strings |
* |
|
data.snippet_use_logs[][ticket_message][ticket][language][plural_formula]
|
string |
* |
A formula using "n" being an integer.
This formula should be compatible with
most C-based languages that support
ternary operators. Booleans should be
cast to an integer (i.e. true = 1,
false = 0). Given an integer n, this
formular returns the plural form to
use for that number. The plural form
can be used as the index to find the
category name.
|
data.snippet_use_logs[][ticket_message][ticket][language][flag_urn]
|
string |
* |
Used in new admin to set custom flag
icon in the format:
`urn:deskpro:flag:$countryCode`
|
data.snippet_use_logs[][ticket_message][ticket][brand]
|
object (Brand) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][brand][name]
|
string |
* |
The brand name. |
data.snippet_use_logs[][ticket_message][ticket][brand][slug]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][url]
|
string |
* |
The brand url. |
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set]
|
object (ThemeSet) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][theme_id]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][theme_set][title]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][edit_theme_set]
|
object (ThemeSet) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][]
|
array of objects (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][parent]
|
object (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][children][]
|
array of objects (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][title]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][user_title]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][is_tickets_enabled]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][is_chat_enabled]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][display_order]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][authcode]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][source_ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][brands][]
|
array of objects (Brand) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][department]
|
integer id (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][name]
|
string |
* |
The name of the permission. |
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][permissions][][is_active]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue]
|
object (UserChatQueue) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][name]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][routing_model]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][answer_timeout]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][is_all_agents]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][departments][]
|
array of objects (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][departments][][chat_queue][max_queue_size]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][brand][theme_sets][]
|
array of objects (ThemeSet) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department]
|
object (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][parent]
|
object (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][children][]
|
array of objects (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][title]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][user_title]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][is_tickets_enabled]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][is_chat_enabled]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][display_order]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][authcode]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][source_ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.snippet_use_logs[][ticket_message][ticket][department][brands][]
|
array of objects (Brand) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][department]
|
integer id (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][name]
|
string |
* |
The name of the permission. |
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.snippet_use_logs[][ticket_message][ticket][department][permissions][][is_active]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue]
|
object (UserChatQueue) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][name]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][routing_model]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][answer_timeout]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][is_all_agents]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][departments][]
|
array of objects (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][department][chat_queue][max_queue_size]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][category]
|
object (TicketCategory) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][category][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][category][parent]
|
integer id (TicketCategory) |
* |
This category parent. |
data.snippet_use_logs[][ticket_message][ticket][category][title]
|
string |
* |
Category title. |
data.snippet_use_logs[][ticket_message][ticket][category][display_order]
|
integer |
* |
Obviously it's display order for
lists.
|
data.snippet_use_logs[][ticket_message][ticket][priority]
|
object (TicketPriority) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][priority][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][priority][title]
|
string |
* |
Priority title. |
data.snippet_use_logs[][ticket_message][ticket][priority][priority]
|
integer |
* |
The priority itself. |
data.snippet_use_logs[][ticket_message][ticket][workflow]
|
object (TicketWorkflow) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][workflow][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][workflow][title]
|
string |
* |
Workflow title. |
data.snippet_use_logs[][ticket_message][ticket][workflow][display_order]
|
integer |
* |
Workflow display order. |
data.snippet_use_logs[][ticket_message][ticket][product]
|
object (Product) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][product][parent]
|
integer id (Product) |
* |
Parent of the product. |
data.snippet_use_logs[][ticket_message][ticket][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][person_email]
|
object (PersonEmail) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][person_email][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][person_email][person]
|
integer id (Person) |
* |
Person owner of email. |
data.snippet_use_logs[][ticket_message][ticket][person_email][email]
|
string |
* |
The email address. |
data.snippet_use_logs[][ticket_message][ticket][person_email][email_domain]
|
string |
* |
The email address domain. |
data.snippet_use_logs[][ticket_message][ticket][person_email][is_validated]
|
boolean |
* |
True if validation passed. |
data.snippet_use_logs[][ticket_message][ticket][person_email][date_created]
|
DateTime |
* |
The original time the email was
created.
|
data.snippet_use_logs[][ticket_message][ticket][agent]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][agent_team]
|
object (AgentTeam) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][agent_team][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][agent_team][name]
|
string |
* |
The name of agent team. |
data.snippet_use_logs[][ticket_message][ticket][agent_team][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.snippet_use_logs[][ticket_message][ticket][organization]
|
object (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob]
|
object (Blob) |
* |
The org picture. |
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][authcode]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][source_ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][picture_blob][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property]
|
object (IconProperty) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property][urn]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][icon_property][options]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][name]
|
string |
* |
The organization name. |
data.snippet_use_logs[][ticket_message][ticket][organization][summary]
|
string |
* |
The summary field as filled in by
agents.
|
data.snippet_use_logs[][ticket_message][ticket][organization][importance]
|
integer |
* |
The org importance. |
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][]
|
array of objects
(CustomDataOrganization)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][organization]
|
object (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field]
|
object (CustomDefOrganization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field][parent]
|
object (CustomDefOrganization) |
* |
Field`s parent. |
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][field][children][]
|
array of objects
(CustomDefOrganization)
|
* |
Field children. |
data.snippet_use_logs[][ticket_message][ticket][organization][custom_data][][root_field]
|
object (CustomDefOrganization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][]
|
array of objects (Usergroup) |
* |
Usergroups the user belongs to. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][id]
|
integer |
* |
The unique ID, DB-generated. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][title]
|
string |
* |
Title of the usergroup. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][note]
|
string |
* |
A note or description about the
usergroup.
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][is_agent_group]
|
boolean |
* |
Is this an agent group? |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][sys_name]
|
string |
* |
When non-null, the group is a special
system group (hidden from most
interfaces).
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][is_enabled]
|
boolean |
* |
Is the group enabled? |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][]
|
array of objects (Permission) |
* |
Usergroup permissions. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][name]
|
string |
* |
The name of the permission. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][permissions][][is_active]
|
boolean |
* |
True means this permission record is
active for normal use with the
permission resolver. When a $person
permission is used but the $person in
question is also part of a usergroup,
then this record might be superfluous:
If the ug grants the perm, and this
record grants the perm, then we have
two records that both grant the perm.
This isn't harmful usually but if you
have many many agents defined and they
all have these duplicative perms, then
you end up with many thousands of
extra rows, which are all fetched and
processed with the permission
resolver. So we turn these extra perms
"off" so the resolver doesn't fetch
them. That means if a hd with many
agent uses groups instead of
overrides, permission resolving is
much much faster.
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][department]
|
integer id (Department) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][name]
|
string |
* |
The name of the permission. |
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][department_permissions][][is_active]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][usergroups][][people][]
|
array of objects (Person) |
* |
Usergroup members. |
data.snippet_use_logs[][ticket_message][ticket][organization][auto_cc_people][]
|
array of objects (Person) |
* |
Users who are set to automatically be
added to tickets and other org things.
|
data.snippet_use_logs[][ticket_message][ticket][organization][labels][]
|
array of objects (LabelOrganization)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][labels][][organization]
|
object (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][contact_data][]
|
array of objects
(OrganizationContactData)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][emails][]
|
array of objects (OrganizationEmail)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][id]
|
integer |
* |
The unique log id. |
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][organization]
|
object (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][email]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][emails][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][]
|
array of objects
(OrganizationEmailDomain)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][][domain]
|
string |
* |
The email domain. |
data.snippet_use_logs[][ticket_message][ticket][organization][email_domains][][organization]
|
object (Organization) |
* |
The users organization. |
data.snippet_use_logs[][ticket_message][ticket][organization][date_created]
|
DateTime |
* |
The date the org was inserted into the
system.
|
data.snippet_use_logs[][ticket_message][ticket][organization][members][]
|
array of objects (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][parent]
|
object (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][children][]
|
array of objects (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][tickets][]
|
array of objects (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][]
|
array of objects (OrganizationMember)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][person]
|
integer id (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][organization]
|
integer id (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][is_manager]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][position]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][created_at]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][organization][organization_members][][updated_at]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat]
|
object (ChatConversation) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][id]
|
integer |
* |
The unique id of chat conversation.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][department]
|
object (Department) |
* |
Department which chat was assigned.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][brand]
|
object (Brand) |
* |
Department which chat was assigned.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][task_id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][labels][]
|
array of objects
(LabelChatConversation)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][labels][][chat]
|
object (ChatConversation) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][subject]
|
string |
* |
Subject of the chat conversation.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][status]
|
string |
* |
Status of the chat conversation.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][agent]
|
object (Person) |
* |
If this is a user conversation, this
is the agent assigned.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][agent_team]
|
object (AgentTeam) |
* |
If this is a team chat, the team it
is.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person]
|
object (Person) |
* |
If this is a user conversation, this
is the user who started the chat.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session]
|
object (Session) |
* |
If this is a user convo, this is the
users session.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][auth]
|
string |
* |
The authcode for the session to verify
an id.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][interface]
|
string |
* |
The Interface the session is for.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][user_agent]
|
string |
* |
The users user agent string. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][visitor_id]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][ip_address]
|
string |
* |
The users IP address. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][data]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_person]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_bot]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_helpdesk]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][active_status]
|
string |
* |
(Agents) Status (available or away).
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][is_chat_available]
|
boolean |
* |
(Agents) Wehn status is available, if
they are available for chat.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_last]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][session][date_last_page]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][visitor_id]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person_name]
|
string |
* |
User chat: The users name, if they
arent a person.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][person_email]
|
string |
* |
User chat: The users email, if they
aren`t a person.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][participants][]
|
array of objects (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][]
|
array of objects (ChatMessage) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author_id]
|
integer |
* |
Author id (legacy). |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author_type]
|
string |
* |
Author type (legacy). |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][conversation_id]
|
integer |
* |
Conversation id (legacy). |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][author]
|
integer id (Person) |
* |
Person who created the message. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][content]
|
string |
* |
The message. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_sys]
|
boolean |
* |
Is this a system message? (ended,
joined, etc).
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_user]
|
boolean |
* |
Is this an user's message? (send from
the widget).
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][is_html]
|
boolean |
* |
Is the content an HTML message? |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][metadata]
|
array |
* |
Additional data. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][date_created]
|
DateTime |
* |
Date message was created. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][messages][][date_received]
|
DateTime |
* |
Date message was received. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][]
|
array of objects (CustomDataChat)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][conversation]
|
object (ChatConversation) |
* |
The conversation the message belongs
to.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field]
|
object (CustomDefChat) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field][parent]
|
object (CustomDefChat) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][field][children][]
|
array of objects (CustomDefChat)
|
* |
Field children. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][custom_data][][root_field]
|
object (CustomDefChat) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_response_time]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_overall]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][rating_comment]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][is_agent]
|
boolean |
* |
Is this an agent chat. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][is_window]
|
boolean |
* |
If the chat is popped out into a
window. This is used to make sure the
JS widget on pages doesn't load again.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_created]
|
DateTime |
* |
Date when chat was started. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_user_waiting]
|
DateTime |
* |
Since when the user has started
waiting (i.e., time the assignment was
0).
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_assigned]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_agent_typing]
|
DateTime |
* |
Date when agent typed last time.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_first_agent_message]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_ended]
|
DateTime |
* |
Date when chat was ended. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][total_to_ended]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][ended_by]
|
string |
* |
Who ended the chat. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][should_send_transcript]
|
boolean |
* |
True if transcript should be send.
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][date_transcript_sent]
|
DateTime |
* |
Date when transcript was sent. |
data.snippet_use_logs[][ticket_message][ticket][linked_chat][email_validation_code]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][email_validated]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][linked_chat][access_token]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][attachments][]
|
array of objects (TicketAttachment)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][access_codes][]
|
array of objects (TicketAccessCode)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][access_codes][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][access_codes][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][access_codes][][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][access_codes][][auth]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][messages][]
|
array of objects (TicketMessage)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][]
|
array of objects (TicketSms) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account]
|
object (SmsAccount) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][type]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][params]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][identifier]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_enabled]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_connected]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][is_tested]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][sms_account][test_code]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job]
|
object (Job) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][id]
|
integer |
* |
The unique job id. |
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][type]
|
string |
* |
The job type, used by the Job Router
to find the right Job Processor.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][status]
|
string |
* |
The status of the job. |
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][status_code]
|
string |
* |
Any code to further classify the
status.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_touch]
|
DateTime |
* |
Date the last time a process "touched"
this ticket.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_created]
|
DateTime |
* |
Date this job entered the "jobs"
table.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_last_try]
|
DateTime |
* |
Last time we processed this job.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][date_next_try]
|
DateTime |
* |
If this DateTime is in the future, it
won't be selected for execution.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][num_tries]
|
integer |
* |
The number of times this job has been
executed Job Processor (usually
indicated failures if > 1).
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][log_summary]
|
string |
* |
A human readable summary of the job's
execution.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][log]
|
string |
* |
A more verbose log. |
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][data]
|
array |
* |
An array of data, or payload, that the
job processor needs to execute this
job (stored in the db as json). This
MUST always be an array, even if its
an empty array
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][job][original_job]
|
integer |
* |
Null unless the job was created as a
retry - if so, the originating job ID
is stored here so we can query it
later. Note: You MUST specify the
originating job, do not create a
linked list of failed jobs.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][from_number]
|
string |
* |
Permanent record of the phone number
that sent this SMS. (Won't change even
if Person changes their phone number).
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][to_number]
|
string |
* |
Permanent record of the phone number
that this SMS was sent to.
|
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][message]
|
string |
* |
The SMS message. |
data.snippet_use_logs[][ticket_message][ticket][sms_messages][][direction]
|
string |
* |
Just a system flag for reporting.
|
data.snippet_use_logs[][ticket_message][ticket][topic_links][]
|
array of objects
(TicketCommunityTopicLink)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][topic_links][][id]
|
integer |
* |
The unique filter ID. |
data.snippet_use_logs[][ticket_message][ticket][topic_links][][ticket]
|
integer id (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][topic_links][][topic]
|
integer id (CommunityTopic) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][topic_links][][person]
|
integer id (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][topic_links][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][custom_data][]
|
array of objects (CustomDataTicket)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][custom_data][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field]
|
object (CustomDefTicket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field][parent]
|
object (CustomDefTicket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][custom_data][][field][children][]
|
array of objects (CustomDefTicket)
|
* |
Field children. |
data.snippet_use_logs[][ticket_message][ticket][custom_data][][root_field]
|
object (CustomDefTicket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][labels][]
|
array of objects (LabelTicket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][labels][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][sent_to_address]
|
string |
* |
The email address the ticket was sent
to if it came in via a gateway. This
is a full string (e.g., including
CC's) of the original.
|
data.snippet_use_logs[][ticket_message][ticket][email_account]
|
object (EmailAccount) |
* |
The gateway this ticket originated
from.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][account_type]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][is_enabled]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][address]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][authcode]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][source_ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][cert_blob][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account][key_blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][email_account_address]
|
string |
* |
The email address (from list of to/cc)
that matched with the email account.
|
data.snippet_use_logs[][ticket_message][ticket][creation_system]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][creation_system_option]
|
string |
* |
Optional information about the
creation system. For example, source
URL the ticket came from.
|
data.snippet_use_logs[][ticket_message][ticket][ticket_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][status]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status]
|
object (TicketStatus) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][status_type]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][status_code]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][sys_id]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][title]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][display_order]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][pending_waiting_time_mode]
|
string |
* |
Where to count time spending in
pending status. Check
PENDING_WAITING_TIME_MODE_ constants
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][children][]
|
array of objects (TicketStatus) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_status][options]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][urgency]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][feedback_rating]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_feedback_rating]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_resolved]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_archived]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_first_agent_assign]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_first_agent_reply]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_last_agent_reply]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_last_user_reply]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_agent_waiting]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_user_waiting]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_status]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_on_hold]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][total_to_first_reply]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting_wh_start]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][total_user_waiting_wh]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][total_to_first_reply_wh]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][locked_by_agent]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][date_locked]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][has_attachments]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][subject]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][original_subject]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][properties]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][count_agent_replies]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][count_user_replies]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][worst_sla_status]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][waiting_times]
|
array |
* |
Used to track ticket status changes
and how much time ticket was in status
Add new item every time status changed
This is optimisation over TicketLog.
|
data.snippet_use_logs[][ticket_message][ticket][participants][]
|
array of objects (TicketParticipant)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][participants][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][participants][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][participants][][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][participants][][access_code]
|
object (TicketAccessCode) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][participants][][person_email]
|
object (PersonEmail) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][participants][][default_on]
|
boolean |
* |
Default checkbox status of the user.
|
data.snippet_use_logs[][ticket_message][ticket][charges][]
|
array of objects (TicketCharge) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][charge_time]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][amount]
|
float |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][organization]
|
object (Organization) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][agent]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][]
|
array of objects (CustomDataBilling)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][ticket_charge]
|
object (TicketCharge) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field]
|
object (CustomDefBilling) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field][parent]
|
object (CustomDefBilling) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][field][children][]
|
array of objects (CustomDefBilling)
|
* |
Field children. |
data.snippet_use_logs[][ticket_message][ticket][charges][][custom_data][][root_field]
|
object (CustomDefBilling) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][]
|
array of objects (TicketSla) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][sla_status]
|
string |
* |
The SLA status. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][warn_date]
|
DateTime |
* |
The SLA warn date. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][fail_date]
|
DateTime |
* |
The SLA fail date. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][is_completed]
|
boolean |
* |
Is the SLA completed? |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][is_completed_set]
|
boolean |
* |
Completed by automated action. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][completed_time_taken]
|
integer |
* |
Time taken. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][ticket]
|
integer id (Ticket) |
* |
Ticket. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][sla]
|
integer id (Sla) |
* |
SLA. |
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][date_applied]
|
DateTime |
* |
time and date when SLA was applied to
the ticket.
|
data.snippet_use_logs[][ticket_message][ticket][ticket_slas][][date_completed]
|
DateTime |
* |
time when SLA status became OK. |
data.snippet_use_logs[][ticket_message][ticket][jira_issues][]
|
array of objects (JiraIssue) |
* |
linked jira issues. |
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][ticket]
|
object (Ticket) |
* |
The associated DeskPRO ticket. |
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][issue_id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][status_id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][jira_issues][][created]
|
DateTime |
* |
Export time. |
data.snippet_use_logs[][ticket_message][ticket][problems][]
|
array of objects (Problem) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][problems][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][problems][][title]
|
string |
* |
Problem title. |
data.snippet_use_logs[][ticket_message][ticket][problems][][creator]
|
integer id (Person) |
* |
Person who created the problem. |
data.snippet_use_logs[][ticket_message][ticket][problems][][created]
|
DateTime |
* |
Date when the problem was created.
|
data.snippet_use_logs[][ticket_message][ticket][problems][][is_open]
|
boolean |
* |
Is problem still has no solution?
|
data.snippet_use_logs[][ticket_message][ticket][problems][][tickets][]
|
array of integer ids (Ticket) |
* |
Tickets associated with problem.
|
data.snippet_use_logs[][ticket_message][ticket][stars][]
|
array of objects (TicketFlagged)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][stars][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][stars][][person_id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][stars][][color]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][]
|
array of objects (TicketFollowUp)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][person]
|
integer id (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][actions]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][cancel_if_user_reply]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][cancel_if_agent_reply]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][status]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_to_run]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][follow_ups][][date_did_run]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][]
|
array of objects (TicketLog) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][parent]
|
object (TicketLog) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][action_type]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][id_object]
|
integer |
* |
If the log involves a specific thing
in a ticket (eg a message that was
moved), then that is this id.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][id_before]
|
integer |
* |
The ID of the previous entity changed,
or any other numeric value.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][id_after]
|
integer |
* |
The ID of the new entity, or any other
numeric value.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][trigger_id]
|
integer |
* |
If the change was caused by a trigger,
the trigger id. Note this is the
integer ID (not a FK relation) so the
record is kept even if the trigger
itself is deleted.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][escalation_id]
|
integer |
* |
If the change was caused by an
escalation Note this is the integer ID
(not a FK relation) so the record is
kept even if the esc itself is
deleted.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][macro_id]
|
integer |
* |
If the change was caused by an v2
macro Note this is the integer ID (not
a FK relation) so the record is kept
even if the esc itself is deleted.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla]
|
object (Sla) |
* |
If the change was caused by an SLA,
the SLA.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][title]
|
string |
* |
SLA title. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][sla_type]
|
string |
* |
Type of SLA - first_response,
resolution, waiting_time.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][active_time]
|
string |
* |
Whether active all the time (all) or
during work hours only (work_hours) or
use the default ticket-wide settings
(default).
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_start]
|
integer |
* |
When the work day starts. This is
stored as the number of seconds after
00:00:00.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_end]
|
integer |
* |
When the work day ends. This is stored
as the number of seconds after
00:00:00.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_days]
|
array |
* |
Array of work days, stored with keys
corresponding to day numbers. Values
are true. 0 = Sunday, 6 = Saturday
(same as PHP, easy to convert to MySQL
which is 1 = Sunday, 7 = Saturday).
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_timezone]
|
string |
* |
Timezone for work hours/days to be
considered in.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][work_holidays]
|
array |
* |
List of work holidays. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_type]
|
string |
* |
Controls how the SLA is applied to
tickets: all, terms,
terms_before_triggers, manual.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms]
|
object (TriggerTerms) |
* |
Conditions to apply. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms][version]
|
integer |
* |
Terms version. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][apply_terms][terms]
|
array |
* |
Terms themselves. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][trigger_terms]
|
object (TriggerTerms) |
* |
Conditions to consider sla completed.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_time]
|
integer |
* |
Warn time integer. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_time_unit]
|
string |
* |
And it's unit (see warn time). |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions]
|
object (TriggerActions) |
* |
How to warn about SLA will fail.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions][version]
|
integer |
* |
Actions version. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][warn_actions][actions]
|
array |
* |
Actions array representation. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_time]
|
integer |
* |
Fail time integer. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_time_unit]
|
string |
* |
And it's measuring unit (see
fail_time).
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][fail_actions]
|
object (TriggerActions) |
* |
What to do if SLA failed. |
data.snippet_use_logs[][ticket_message][ticket][logs][][sla][exclude_ticket_statuses]
|
array |
* |
This SLA will not apply while tickets
are in these pending statuses.
|
data.snippet_use_logs[][ticket_message][ticket][logs][][sla_status]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][details]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][logs][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][chats][]
|
array of objects (ChatConversation)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][created_with_channel]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][last_channel_used]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][channels]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][]
|
array of objects
(ArticlePendingCreate)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][person]
|
integer id (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][assigned_person]
|
integer id (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][ticket]
|
integer id (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][message]
|
integer id (TicketMessage) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][comment]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][pending_articles][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket][summary]
|
object (TicketSummary) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][summary][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket][summary][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket][summary][summary]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][summary][summary_input]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket][summary][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.snippet_use_logs[][ticket_message][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.snippet_use_logs[][ticket_message][email_source][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][email_source][uuid]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][ticket_message][email_source][blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][ticket_message][email_source][blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][ticket_message][email_source][blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][ticket_message][email_source][blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][ticket_message][email_source][blob][authcode]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][ticket_message][email_source][blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][ticket_message][email_source][blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][ticket_message][email_source][blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][ticket_message][email_source][blob][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][source_ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][ticket_message][email_source][blob][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][email_source][object_type]
|
string |
* |
The type of object this is attached to
(should be the table name of the super
type, eg: tickets, people,
organizations). This typically is not
set until after the email is processed
(ie the status is 'processed').
|
data.snippet_use_logs[][ticket_message][email_source][object_id]
|
integer |
* |
The ID of the object this is attached
to.
|
data.snippet_use_logs[][ticket_message][email_source][from_email]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][email_source][status]
|
string |
* |
The current status of the message: -
inserted: Only inserted - processing:
Currently processing - complete: Fully
processed - error: Tried to process
but there was some kind of error (see
error_code).
|
data.snippet_use_logs[][ticket_message][email_source][date_status]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][email_source][error_code]
|
string |
* |
When status is error, this is the code
that describes the error.
|
data.snippet_use_logs[][ticket_message][email_source][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.snippet_use_logs[][ticket_message][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.snippet_use_logs[][ticket_message][date_created]
|
DateTime |
* |
Date when message was created. |
data.snippet_use_logs[][ticket_message][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.snippet_use_logs[][ticket_message][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.snippet_use_logs[][ticket_message][creation_system]
|
string |
* |
How this message was created. |
data.snippet_use_logs[][ticket_message][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.snippet_use_logs[][ticket_message][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.snippet_use_logs[][ticket_message][hostname]
|
string |
* |
Host from which message was left.
|
data.snippet_use_logs[][ticket_message][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.snippet_use_logs[][ticket_message][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.snippet_use_logs[][ticket_message][message_hash]
|
string |
* |
An unique hash of message. |
data.snippet_use_logs[][ticket_message][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.snippet_use_logs[][ticket_message][primary_translation][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][primary_translation][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][primary_translation][ticket_message]
|
object (TicketMessage) |
* |
|
data.snippet_use_logs[][ticket_message][primary_translation][from_lang_code]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][primary_translation][lang_code]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][primary_translation][message]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][primary_translation][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][message]
|
string |
* |
The message, will be in HTML! |
data.snippet_use_logs[][ticket_message][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.snippet_use_logs[][ticket_message][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.snippet_use_logs[][ticket_message][message_source]
|
string |
* |
The message source. |
data.snippet_use_logs[][ticket_message][message_source_type]
|
string |
* |
The message source type. |
data.snippet_use_logs[][ticket_message][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.snippet_use_logs[][ticket_message][lang_code]
|
string |
* |
The set/detected lang code. |
data.snippet_use_logs[][ticket_message][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.snippet_use_logs[][ticket_message][email_message_id][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][email_message_id][][message]
|
object (TicketMessage) |
* |
|
data.snippet_use_logs[][ticket_message][email_message_id][][email_id]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][ticket_message]
|
object (TicketMessage) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][person]
|
object (Person) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][rating]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][message]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_feedback][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][id]
|
integer |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][ticket_message]
|
object (TicketMessage) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][new_ticket]
|
object (Ticket) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][subject]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][from_email]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][tos]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][ccs]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][bccs]
|
array |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][message]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][]
|
array of objects (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][authcode]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][blob_hash]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][is_temp]
|
boolean |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][source_ref]
|
string |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.snippet_use_logs[][ticket_message][ticket_message_forwards][][date_created]
|
DateTime |
* |
|
data.snippet_use_logs[][ticket_message][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.snippet_use_logs[][ticket_message][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.snippet_use_logs[][ticket_message][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.snippet_use_logs[][ticket_message][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.snippet_use_logs[][ticket_message][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.snippet_use_logs[][chat_message]
|
object (ChatMessage) |
* |
Chat Message where the snippet was
used.
|
data.snippet_use_logs[][chat_message][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][chat_message][author_id]
|
integer |
* |
Author id (legacy). |
data.snippet_use_logs[][chat_message][author_type]
|
string |
* |
Author type (legacy). |
data.snippet_use_logs[][chat_message][conversation_id]
|
integer |
* |
Conversation id (legacy). |
data.snippet_use_logs[][chat_message][author]
|
integer id (Person) |
* |
Person who created the message. |
data.snippet_use_logs[][chat_message][content]
|
string |
* |
The message. |
data.snippet_use_logs[][chat_message][is_sys]
|
boolean |
* |
Is this a system message? (ended,
joined, etc).
|
data.snippet_use_logs[][chat_message][is_user]
|
boolean |
* |
Is this an user's message? (send from
the widget).
|
data.snippet_use_logs[][chat_message][is_html]
|
boolean |
* |
Is the content an HTML message? |
data.snippet_use_logs[][chat_message][metadata]
|
array |
* |
Additional data. |
data.snippet_use_logs[][chat_message][date_created]
|
DateTime |
* |
Date message was created. |
data.snippet_use_logs[][chat_message][date_received]
|
DateTime |
* |
Date message was received. |
data.snippet_use_logs[][language]
|
object (Language) |
* |
Snippet translated. |
data.snippet_use_logs[][language][id]
|
integer |
* |
The unique ID. |
data.snippet_use_logs[][language][sys_name]
|
string |
* |
The unique sys name assigned to the
language.
|
data.snippet_use_logs[][language][title]
|
string |
* |
Title of the language. |
data.snippet_use_logs[][language][title_local]
|
string |
* |
Title of the language. |
data.snippet_use_logs[][language][base_filepath]
|
string |
* |
The base filepath for default phrases
for this lang.
|
data.snippet_use_logs[][language][locale]
|
string |
* |
The locale code. |
data.snippet_use_logs[][language][flag_image]
|
string |
* |
String path to image. |
data.snippet_use_logs[][language][is_rtl]
|
boolean |
* |
True if this is a right-to-left
language.
|
data.snippet_use_logs[][language][has_user]
|
boolean |
* |
True if has user. |
data.snippet_use_logs[][language][has_agent]
|
boolean |
* |
True if has agent. |
data.snippet_use_logs[][language][has_admin]
|
boolean |
* |
True if has admin. |
data.snippet_use_logs[][language][plural_categories][]
|
array of strings |
* |
|
data.snippet_use_logs[][language][plural_formula]
|
string |
* |
A formula using "n" being an integer.
This formula should be compatible with
most C-based languages that support
ternary operators. Booleans should be
cast to an integer (i.e. true = 1,
false = 0). Given an integer n, this
formular returns the plural form to
use for that number. The plural form
can be used as the index to find the
category name.
|
data.snippet_use_logs[][language][flag_urn]
|
string |
* |
Used in new admin to set custom flag
icon in the format:
`urn:deskpro:flag:$countryCode`
|
data.snippet_use_logs[][person] |
object (Person) |
* |
|
data.snippet_use_logs[][rating] |
integer |
* |
|
data.snippet_use_logs[][rating_person]
|
object (Person) |
* |
|
data.snippet_use_logs[][rating_message]
|
string |
* |
|
data.snippet_use_logs[][date_created]
|
DateTime |
* |
|
data.primary_translation |
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.primary_translation[id] |
integer |
* |
|
data.primary_translation[ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][id]
|
integer |
* |
|
data.primary_translation[ticket][ref]
|
string |
* |
|
data.primary_translation[ticket][auth]
|
string |
* |
|
data.primary_translation[ticket][parent_ticket]
|
object (Ticket) |
* |
Parent ticket. |
data.primary_translation[ticket][children_tickets][]
|
array of objects (Ticket) |
* |
|
data.primary_translation[ticket][language]
|
object (Language) |
* |
The language the ticket is in. |
data.primary_translation[ticket][language][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][language][sys_name]
|
string |
* |
The unique sys name assigned to the
language.
|
data.primary_translation[ticket][language][title]
|
string |
* |
Title of the language. |
data.primary_translation[ticket][language][title_local]
|
string |
* |
Title of the language. |
data.primary_translation[ticket][language][base_filepath]
|
string |
* |
The base filepath for default phrases
for this lang.
|
data.primary_translation[ticket][language][locale]
|
string |
* |
The locale code. |
data.primary_translation[ticket][language][flag_image]
|
string |
* |
String path to image. |
data.primary_translation[ticket][language][is_rtl]
|
boolean |
* |
True if this is a right-to-left
language.
|
data.primary_translation[ticket][language][has_user]
|
boolean |
* |
True if has user. |
data.primary_translation[ticket][language][has_agent]
|
boolean |
* |
True if has agent. |
data.primary_translation[ticket][language][has_admin]
|
boolean |
* |
True if has admin. |
data.primary_translation[ticket][language][plural_categories][]
|
array of strings |
* |
|
data.primary_translation[ticket][language][plural_formula]
|
string |
* |
A formula using "n" being an integer.
This formula should be compatible with
most C-based languages that support
ternary operators. Booleans should be
cast to an integer (i.e. true = 1,
false = 0). Given an integer n, this
formular returns the plural form to
use for that number. The plural form
can be used as the index to find the
category name.
|
data.primary_translation[ticket][language][flag_urn]
|
string |
* |
Used in new admin to set custom flag
icon in the format:
`urn:deskpro:flag:$countryCode`
|
data.primary_translation[ticket][brand]
|
object (Brand) |
* |
|
data.primary_translation[ticket][brand][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][brand][name]
|
string |
* |
The brand name. |
data.primary_translation[ticket][brand][slug]
|
string |
* |
|
data.primary_translation[ticket][brand][url]
|
string |
* |
The brand url. |
data.primary_translation[ticket][brand][theme_set]
|
object (ThemeSet) |
* |
|
data.primary_translation[ticket][brand][theme_set][id]
|
integer |
* |
|
data.primary_translation[ticket][brand][theme_set][theme_id]
|
string |
* |
|
data.primary_translation[ticket][brand][theme_set][title]
|
string |
* |
|
data.primary_translation[ticket][brand][edit_theme_set]
|
object (ThemeSet) |
* |
|
data.primary_translation[ticket][brand][departments][]
|
array of objects (Department) |
* |
|
data.primary_translation[ticket][brand][departments][][id]
|
integer |
* |
|
data.primary_translation[ticket][brand][departments][][parent]
|
object (Department) |
* |
|
data.primary_translation[ticket][brand][departments][][children][]
|
array of objects (Department) |
* |
|
data.primary_translation[ticket][brand][departments][][title]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][user_title]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][is_tickets_enabled]
|
boolean |
* |
|
data.primary_translation[ticket][brand][departments][][is_chat_enabled]
|
boolean |
* |
|
data.primary_translation[ticket][brand][departments][][display_order]
|
integer |
* |
|
data.primary_translation[ticket][brand][departments][][avatar]
|
object (Blob) |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket][brand][departments][][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket][brand][departments][][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket][brand][departments][][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket][brand][departments][][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket][brand][departments][][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket][brand][departments][][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket][brand][departments][][avatar][authcode]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][blob_hash]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket][brand][departments][][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket][brand][departments][][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket][brand][departments][][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket][brand][departments][][avatar][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][source_ref]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket][brand][departments][][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][brand][departments][][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.primary_translation[ticket][brand][departments][][brands][]
|
array of objects (Brand) |
* |
|
data.primary_translation[ticket][brand][departments][][permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.primary_translation[ticket][brand][departments][][permissions][][department]
|
integer id (Department) |
* |
|
data.primary_translation[ticket][brand][departments][][permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.primary_translation[ticket][brand][departments][][permissions][][name]
|
string |
* |
The name of the permission. |
data.primary_translation[ticket][brand][departments][][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.primary_translation[ticket][brand][departments][][permissions][][is_active]
|
boolean |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue]
|
object (UserChatQueue) |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][brand][departments][][chat_queue][name]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue][routing_model]
|
string |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue][answer_timeout]
|
integer |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue][is_all_agents]
|
boolean |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue][departments][]
|
array of objects (Department) |
* |
|
data.primary_translation[ticket][brand][departments][][chat_queue][max_queue_size]
|
integer |
* |
|
data.primary_translation[ticket][brand][theme_sets][]
|
array of objects (ThemeSet) |
* |
|
data.primary_translation[ticket][department]
|
object (Department) |
* |
|
data.primary_translation[ticket][department][id]
|
integer |
* |
|
data.primary_translation[ticket][department][parent]
|
object (Department) |
* |
|
data.primary_translation[ticket][department][children][]
|
array of objects (Department) |
* |
|
data.primary_translation[ticket][department][title]
|
string |
* |
|
data.primary_translation[ticket][department][user_title]
|
string |
* |
|
data.primary_translation[ticket][department][is_tickets_enabled]
|
boolean |
* |
|
data.primary_translation[ticket][department][is_chat_enabled]
|
boolean |
* |
|
data.primary_translation[ticket][department][display_order]
|
integer |
* |
|
data.primary_translation[ticket][department][avatar]
|
object (Blob) |
* |
|
data.primary_translation[ticket][department][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket][department][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket][department][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket][department][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket][department][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket][department][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket][department][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket][department][avatar][authcode]
|
string |
* |
|
data.primary_translation[ticket][department][avatar][blob_hash]
|
string |
* |
|
data.primary_translation[ticket][department][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket][department][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket][department][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket][department][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket][department][avatar][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][department][avatar][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket][department][avatar][source_ref]
|
string |
* |
|
data.primary_translation[ticket][department][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket][department][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][department][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.primary_translation[ticket][department][brands][]
|
array of objects (Brand) |
* |
|
data.primary_translation[ticket][department][permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.primary_translation[ticket][department][permissions][][department]
|
integer id (Department) |
* |
|
data.primary_translation[ticket][department][permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.primary_translation[ticket][department][permissions][][name]
|
string |
* |
The name of the permission. |
data.primary_translation[ticket][department][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.primary_translation[ticket][department][permissions][][is_active]
|
boolean |
* |
|
data.primary_translation[ticket][department][chat_queue]
|
object (UserChatQueue) |
* |
|
data.primary_translation[ticket][department][chat_queue][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][department][chat_queue][name]
|
string |
* |
|
data.primary_translation[ticket][department][chat_queue][routing_model]
|
string |
* |
|
data.primary_translation[ticket][department][chat_queue][answer_timeout]
|
integer |
* |
|
data.primary_translation[ticket][department][chat_queue][is_all_agents]
|
boolean |
* |
|
data.primary_translation[ticket][department][chat_queue][departments][]
|
array of objects (Department) |
* |
|
data.primary_translation[ticket][department][chat_queue][max_queue_size]
|
integer |
* |
|
data.primary_translation[ticket][category]
|
object (TicketCategory) |
* |
|
data.primary_translation[ticket][category][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][category][parent]
|
integer id (TicketCategory) |
* |
This category parent. |
data.primary_translation[ticket][category][title]
|
string |
* |
Category title. |
data.primary_translation[ticket][category][display_order]
|
integer |
* |
Obviously it's display order for
lists.
|
data.primary_translation[ticket][priority]
|
object (TicketPriority) |
* |
|
data.primary_translation[ticket][priority][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][priority][title]
|
string |
* |
Priority title. |
data.primary_translation[ticket][priority][priority]
|
integer |
* |
The priority itself. |
data.primary_translation[ticket][workflow]
|
object (TicketWorkflow) |
* |
|
data.primary_translation[ticket][workflow][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][workflow][title]
|
string |
* |
Workflow title. |
data.primary_translation[ticket][workflow][display_order]
|
integer |
* |
Workflow display order. |
data.primary_translation[ticket][product]
|
object (Product) |
* |
|
data.primary_translation[ticket][product][parent]
|
integer id (Product) |
* |
Parent of the product. |
data.primary_translation[ticket][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][person_email]
|
object (PersonEmail) |
* |
|
data.primary_translation[ticket][person_email][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][person_email][person]
|
integer id (Person) |
* |
Person owner of email. |
data.primary_translation[ticket][person_email][email]
|
string |
* |
The email address. |
data.primary_translation[ticket][person_email][email_domain]
|
string |
* |
The email address domain. |
data.primary_translation[ticket][person_email][is_validated]
|
boolean |
* |
True if validation passed. |
data.primary_translation[ticket][person_email][date_created]
|
DateTime |
* |
The original time the email was
created.
|
data.primary_translation[ticket][agent]
|
object (Person) |
* |
|
data.primary_translation[ticket][agent_team]
|
object (AgentTeam) |
* |
|
data.primary_translation[ticket][agent_team][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][agent_team][name]
|
string |
* |
The name of agent team. |
data.primary_translation[ticket][agent_team][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.primary_translation[ticket][organization]
|
object (Organization) |
* |
|
data.primary_translation[ticket][organization][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][organization][picture_blob]
|
object (Blob) |
* |
The org picture. |
data.primary_translation[ticket][organization][picture_blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket][organization][picture_blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket][organization][picture_blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket][organization][picture_blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket][organization][picture_blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket][organization][picture_blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket][organization][picture_blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket][organization][picture_blob][authcode]
|
string |
* |
|
data.primary_translation[ticket][organization][picture_blob][blob_hash]
|
string |
* |
|
data.primary_translation[ticket][organization][picture_blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket][organization][picture_blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket][organization][picture_blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket][organization][picture_blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket][organization][picture_blob][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][organization][picture_blob][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket][organization][picture_blob][source_ref]
|
string |
* |
|
data.primary_translation[ticket][organization][picture_blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket][organization][picture_blob][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][organization][icon_property]
|
object (IconProperty) |
* |
|
data.primary_translation[ticket][organization][icon_property][urn]
|
string |
* |
|
data.primary_translation[ticket][organization][icon_property][options]
|
array |
* |
|
data.primary_translation[ticket][organization][name]
|
string |
* |
The organization name. |
data.primary_translation[ticket][organization][summary]
|
string |
* |
The summary field as filled in by
agents.
|
data.primary_translation[ticket][organization][importance]
|
integer |
* |
The org importance. |
data.primary_translation[ticket][organization][custom_data][]
|
array of objects
(CustomDataOrganization)
|
* |
|
data.primary_translation[ticket][organization][custom_data][][organization]
|
object (Organization) |
* |
|
data.primary_translation[ticket][organization][custom_data][][field]
|
object (CustomDefOrganization) |
* |
|
data.primary_translation[ticket][organization][custom_data][][field][parent]
|
object (CustomDefOrganization) |
* |
Field`s parent. |
data.primary_translation[ticket][organization][custom_data][][field][children][]
|
array of objects
(CustomDefOrganization)
|
* |
Field children. |
data.primary_translation[ticket][organization][custom_data][][root_field]
|
object (CustomDefOrganization) |
* |
|
data.primary_translation[ticket][organization][usergroups][]
|
array of objects (Usergroup) |
* |
Usergroups the user belongs to. |
data.primary_translation[ticket][organization][usergroups][][id]
|
integer |
* |
The unique ID, DB-generated. |
data.primary_translation[ticket][organization][usergroups][][title]
|
string |
* |
Title of the usergroup. |
data.primary_translation[ticket][organization][usergroups][][note]
|
string |
* |
A note or description about the
usergroup.
|
data.primary_translation[ticket][organization][usergroups][][is_agent_group]
|
boolean |
* |
Is this an agent group? |
data.primary_translation[ticket][organization][usergroups][][sys_name]
|
string |
* |
When non-null, the group is a special
system group (hidden from most
interfaces).
|
data.primary_translation[ticket][organization][usergroups][][is_enabled]
|
boolean |
* |
Is the group enabled? |
data.primary_translation[ticket][organization][usergroups][][permissions][]
|
array of objects (Permission) |
* |
Usergroup permissions. |
data.primary_translation[ticket][organization][usergroups][][permissions][][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][organization][usergroups][][permissions][][name]
|
string |
* |
The name of the permission. |
data.primary_translation[ticket][organization][usergroups][][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.primary_translation[ticket][organization][usergroups][][permissions][][is_active]
|
boolean |
* |
True means this permission record is
active for normal use with the
permission resolver. When a $person
permission is used but the $person in
question is also part of a usergroup,
then this record might be superfluous:
If the ug grants the perm, and this
record grants the perm, then we have
two records that both grant the perm.
This isn't harmful usually but if you
have many many agents defined and they
all have these duplicative perms, then
you end up with many thousands of
extra rows, which are all fetched and
processed with the permission
resolver. So we turn these extra perms
"off" so the resolver doesn't fetch
them. That means if a hd with many
agent uses groups instead of
overrides, permission resolving is
much much faster.
|
data.primary_translation[ticket][organization][usergroups][][department_permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.primary_translation[ticket][organization][usergroups][][department_permissions][][department]
|
integer id (Department) |
* |
|
data.primary_translation[ticket][organization][usergroups][][department_permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.primary_translation[ticket][organization][usergroups][][department_permissions][][name]
|
string |
* |
The name of the permission. |
data.primary_translation[ticket][organization][usergroups][][department_permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.primary_translation[ticket][organization][usergroups][][department_permissions][][is_active]
|
boolean |
* |
|
data.primary_translation[ticket][organization][usergroups][][people][]
|
array of objects (Person) |
* |
Usergroup members. |
data.primary_translation[ticket][organization][auto_cc_people][]
|
array of objects (Person) |
* |
Users who are set to automatically be
added to tickets and other org things.
|
data.primary_translation[ticket][organization][labels][]
|
array of objects (LabelOrganization)
|
* |
|
data.primary_translation[ticket][organization][labels][][organization]
|
object (Organization) |
* |
|
data.primary_translation[ticket][organization][contact_data][]
|
array of objects
(OrganizationContactData)
|
* |
|
data.primary_translation[ticket][organization][emails][]
|
array of objects (OrganizationEmail)
|
* |
|
data.primary_translation[ticket][organization][emails][][id]
|
integer |
* |
The unique log id. |
data.primary_translation[ticket][organization][emails][][organization]
|
object (Organization) |
* |
|
data.primary_translation[ticket][organization][emails][][email]
|
string |
* |
|
data.primary_translation[ticket][organization][emails][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][organization][email_domains][]
|
array of objects
(OrganizationEmailDomain)
|
* |
|
data.primary_translation[ticket][organization][email_domains][][domain]
|
string |
* |
The email domain. |
data.primary_translation[ticket][organization][email_domains][][organization]
|
object (Organization) |
* |
The users organization. |
data.primary_translation[ticket][organization][date_created]
|
DateTime |
* |
The date the org was inserted into the
system.
|
data.primary_translation[ticket][organization][members][]
|
array of objects (Person) |
* |
|
data.primary_translation[ticket][organization][parent]
|
object (Organization) |
* |
|
data.primary_translation[ticket][organization][children][]
|
array of objects (Organization) |
* |
|
data.primary_translation[ticket][organization][tickets][]
|
array of objects (Ticket) |
* |
|
data.primary_translation[ticket][organization][organization_members][]
|
array of objects (OrganizationMember)
|
* |
|
data.primary_translation[ticket][organization][organization_members][][id]
|
integer |
* |
|
data.primary_translation[ticket][organization][organization_members][][person]
|
integer id (Person) |
* |
|
data.primary_translation[ticket][organization][organization_members][][organization]
|
integer id (Organization) |
* |
|
data.primary_translation[ticket][organization][organization_members][][is_manager]
|
boolean |
* |
|
data.primary_translation[ticket][organization][organization_members][][position]
|
string |
* |
|
data.primary_translation[ticket][organization][organization_members][][created_at]
|
DateTime |
* |
|
data.primary_translation[ticket][organization][organization_members][][updated_at]
|
DateTime |
* |
|
data.primary_translation[ticket][linked_chat]
|
object (ChatConversation) |
* |
|
data.primary_translation[ticket][linked_chat][id]
|
integer |
* |
The unique id of chat conversation.
|
data.primary_translation[ticket][linked_chat][department]
|
object (Department) |
* |
Department which chat was assigned.
|
data.primary_translation[ticket][linked_chat][brand]
|
object (Brand) |
* |
Department which chat was assigned.
|
data.primary_translation[ticket][linked_chat][task_id]
|
integer |
* |
|
data.primary_translation[ticket][linked_chat][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][linked_chat][labels][]
|
array of objects
(LabelChatConversation)
|
* |
|
data.primary_translation[ticket][linked_chat][labels][][chat]
|
object (ChatConversation) |
* |
|
data.primary_translation[ticket][linked_chat][subject]
|
string |
* |
Subject of the chat conversation.
|
data.primary_translation[ticket][linked_chat][status]
|
string |
* |
Status of the chat conversation.
|
data.primary_translation[ticket][linked_chat][agent]
|
object (Person) |
* |
If this is a user conversation, this
is the agent assigned.
|
data.primary_translation[ticket][linked_chat][agent_team]
|
object (AgentTeam) |
* |
If this is a team chat, the team it
is.
|
data.primary_translation[ticket][linked_chat][person]
|
object (Person) |
* |
If this is a user conversation, this
is the user who started the chat.
|
data.primary_translation[ticket][linked_chat][session]
|
object (Session) |
* |
If this is a user convo, this is the
users session.
|
data.primary_translation[ticket][linked_chat][session][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][linked_chat][session][auth]
|
string |
* |
The authcode for the session to verify
an id.
|
data.primary_translation[ticket][linked_chat][session][interface]
|
string |
* |
The Interface the session is for.
|
data.primary_translation[ticket][linked_chat][session][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][linked_chat][session][user_agent]
|
string |
* |
The users user agent string. |
data.primary_translation[ticket][linked_chat][session][visitor_id]
|
string |
* |
|
data.primary_translation[ticket][linked_chat][session][ip_address]
|
string |
* |
The users IP address. |
data.primary_translation[ticket][linked_chat][session][data]
|
string |
* |
|
data.primary_translation[ticket][linked_chat][session][is_person]
|
boolean |
* |
|
data.primary_translation[ticket][linked_chat][session][is_bot]
|
boolean |
* |
|
data.primary_translation[ticket][linked_chat][session][is_helpdesk]
|
boolean |
* |
|
data.primary_translation[ticket][linked_chat][session][active_status]
|
string |
* |
(Agents) Status (available or away).
|
data.primary_translation[ticket][linked_chat][session][is_chat_available]
|
boolean |
* |
(Agents) Wehn status is available, if
they are available for chat.
|
data.primary_translation[ticket][linked_chat][session][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][linked_chat][session][date_last]
|
DateTime |
* |
|
data.primary_translation[ticket][linked_chat][session][date_last_page]
|
DateTime |
* |
|
data.primary_translation[ticket][linked_chat][visitor_id]
|
string |
* |
|
data.primary_translation[ticket][linked_chat][person_name]
|
string |
* |
User chat: The users name, if they
arent a person.
|
data.primary_translation[ticket][linked_chat][person_email]
|
string |
* |
User chat: The users email, if they
aren`t a person.
|
data.primary_translation[ticket][linked_chat][participants][]
|
array of objects (Person) |
* |
|
data.primary_translation[ticket][linked_chat][messages][]
|
array of objects (ChatMessage) |
* |
|
data.primary_translation[ticket][linked_chat][messages][][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][linked_chat][messages][][author_id]
|
integer |
* |
Author id (legacy). |
data.primary_translation[ticket][linked_chat][messages][][author_type]
|
string |
* |
Author type (legacy). |
data.primary_translation[ticket][linked_chat][messages][][conversation_id]
|
integer |
* |
Conversation id (legacy). |
data.primary_translation[ticket][linked_chat][messages][][author]
|
integer id (Person) |
* |
Person who created the message. |
data.primary_translation[ticket][linked_chat][messages][][content]
|
string |
* |
The message. |
data.primary_translation[ticket][linked_chat][messages][][is_sys]
|
boolean |
* |
Is this a system message? (ended,
joined, etc).
|
data.primary_translation[ticket][linked_chat][messages][][is_user]
|
boolean |
* |
Is this an user's message? (send from
the widget).
|
data.primary_translation[ticket][linked_chat][messages][][is_html]
|
boolean |
* |
Is the content an HTML message? |
data.primary_translation[ticket][linked_chat][messages][][metadata]
|
array |
* |
Additional data. |
data.primary_translation[ticket][linked_chat][messages][][date_created]
|
DateTime |
* |
Date message was created. |
data.primary_translation[ticket][linked_chat][messages][][date_received]
|
DateTime |
* |
Date message was received. |
data.primary_translation[ticket][linked_chat][custom_data][]
|
array of objects (CustomDataChat)
|
* |
|
data.primary_translation[ticket][linked_chat][custom_data][][conversation]
|
object (ChatConversation) |
* |
The conversation the message belongs
to.
|
data.primary_translation[ticket][linked_chat][custom_data][][field]
|
object (CustomDefChat) |
* |
|
data.primary_translation[ticket][linked_chat][custom_data][][field][parent]
|
object (CustomDefChat) |
* |
|
data.primary_translation[ticket][linked_chat][custom_data][][field][children][]
|
array of objects (CustomDefChat)
|
* |
Field children. |
data.primary_translation[ticket][linked_chat][custom_data][][root_field]
|
object (CustomDefChat) |
* |
|
data.primary_translation[ticket][linked_chat][rating_response_time]
|
integer |
* |
|
data.primary_translation[ticket][linked_chat][rating_overall]
|
integer |
* |
|
data.primary_translation[ticket][linked_chat][rating_comment]
|
string |
* |
|
data.primary_translation[ticket][linked_chat][is_agent]
|
boolean |
* |
Is this an agent chat. |
data.primary_translation[ticket][linked_chat][is_window]
|
boolean |
* |
If the chat is popped out into a
window. This is used to make sure the
JS widget on pages doesn't load again.
|
data.primary_translation[ticket][linked_chat][date_created]
|
DateTime |
* |
Date when chat was started. |
data.primary_translation[ticket][linked_chat][date_user_waiting]
|
DateTime |
* |
Since when the user has started
waiting (i.e., time the assignment was
0).
|
data.primary_translation[ticket][linked_chat][date_assigned]
|
DateTime |
* |
|
data.primary_translation[ticket][linked_chat][date_agent_typing]
|
DateTime |
* |
Date when agent typed last time.
|
data.primary_translation[ticket][linked_chat][date_first_agent_message]
|
DateTime |
* |
|
data.primary_translation[ticket][linked_chat][date_ended]
|
DateTime |
* |
Date when chat was ended. |
data.primary_translation[ticket][linked_chat][total_to_ended]
|
integer |
* |
|
data.primary_translation[ticket][linked_chat][ended_by]
|
string |
* |
Who ended the chat. |
data.primary_translation[ticket][linked_chat][should_send_transcript]
|
boolean |
* |
True if transcript should be send.
|
data.primary_translation[ticket][linked_chat][date_transcript_sent]
|
DateTime |
* |
Date when transcript was sent. |
data.primary_translation[ticket][linked_chat][email_validation_code]
|
string |
* |
|
data.primary_translation[ticket][linked_chat][email_validated]
|
boolean |
* |
|
data.primary_translation[ticket][linked_chat][access_token]
|
string |
* |
|
data.primary_translation[ticket][attachments][]
|
array of objects (TicketAttachment)
|
* |
|
data.primary_translation[ticket][access_codes][]
|
array of objects (TicketAccessCode)
|
* |
|
data.primary_translation[ticket][access_codes][][id]
|
integer |
* |
|
data.primary_translation[ticket][access_codes][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][access_codes][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][access_codes][][auth]
|
string |
* |
|
data.primary_translation[ticket][messages][]
|
array of objects (TicketMessage)
|
* |
|
data.primary_translation[ticket][messages][][id]
|
integer |
* |
The unique id of message. |
data.primary_translation[ticket][messages][][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.primary_translation[ticket][messages][][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.primary_translation[ticket][messages][][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.primary_translation[ticket][messages][][email_source][id]
|
integer |
* |
|
data.primary_translation[ticket][messages][][email_source][uuid]
|
string |
* |
|
data.primary_translation[ticket][messages][][email_source][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket][messages][][email_source][blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket][messages][][email_source][blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket][messages][][email_source][blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket][messages][][email_source][blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket][messages][][email_source][blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket][messages][][email_source][blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket][messages][][email_source][blob][authcode]
|
string |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][blob_hash]
|
string |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket][messages][][email_source][blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket][messages][][email_source][blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket][messages][][email_source][blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket][messages][][email_source][blob][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][source_ref]
|
string |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket][messages][][email_source][blob][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][messages][][email_source][object_type]
|
string |
* |
The type of object this is attached to
(should be the table name of the super
type, eg: tickets, people,
organizations). This typically is not
set until after the email is processed
(ie the status is 'processed').
|
data.primary_translation[ticket][messages][][email_source][object_id]
|
integer |
* |
The ID of the object this is attached
to.
|
data.primary_translation[ticket][messages][][email_source][from_email]
|
string |
* |
|
data.primary_translation[ticket][messages][][email_source][status]
|
string |
* |
The current status of the message: -
inserted: Only inserted - processing:
Currently processing - complete: Fully
processed - error: Tried to process
but there was some kind of error (see
error_code).
|
data.primary_translation[ticket][messages][][email_source][date_status]
|
DateTime |
* |
|
data.primary_translation[ticket][messages][][email_source][error_code]
|
string |
* |
When status is error, this is the code
that describes the error.
|
data.primary_translation[ticket][messages][][email_source][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][messages][][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.primary_translation[ticket][messages][][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.primary_translation[ticket][messages][][date_created]
|
DateTime |
* |
Date when message was created. |
data.primary_translation[ticket][messages][][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.primary_translation[ticket][messages][][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.primary_translation[ticket][messages][][creation_system]
|
string |
* |
How this message was created. |
data.primary_translation[ticket][messages][][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.primary_translation[ticket][messages][][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.primary_translation[ticket][messages][][hostname]
|
string |
* |
Host from which message was left.
|
data.primary_translation[ticket][messages][][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.primary_translation[ticket][messages][][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.primary_translation[ticket][messages][][message_hash]
|
string |
* |
An unique hash of message. |
data.primary_translation[ticket][messages][][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.primary_translation[ticket][messages][][message]
|
string |
* |
The message, will be in HTML! |
data.primary_translation[ticket][messages][][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.primary_translation[ticket][messages][][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.primary_translation[ticket][messages][][message_source]
|
string |
* |
The message source. |
data.primary_translation[ticket][messages][][message_source_type]
|
string |
* |
The message source type. |
data.primary_translation[ticket][messages][][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.primary_translation[ticket][messages][][lang_code]
|
string |
* |
The set/detected lang code. |
data.primary_translation[ticket][messages][][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.primary_translation[ticket][messages][][email_message_id][][id]
|
integer |
* |
|
data.primary_translation[ticket][messages][][email_message_id][][message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket][messages][][email_message_id][][email_id]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][id]
|
integer |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][rating]
|
integer |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][message]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_feedback][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][id]
|
integer |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][new_ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][subject]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][from_email]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][tos]
|
array |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][ccs]
|
array |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][bccs]
|
array |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][message]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][]
|
array of objects (Blob) |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][authcode]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][blob_hash]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][source_ref]
|
string |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][messages][][ticket_message_forwards][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][messages][][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.primary_translation[ticket][messages][][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.primary_translation[ticket][messages][][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.primary_translation[ticket][messages][][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.primary_translation[ticket][messages][][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.primary_translation[ticket][sms_messages][]
|
array of objects (TicketSms) |
* |
|
data.primary_translation[ticket][sms_messages][][id]
|
integer |
* |
|
data.primary_translation[ticket][sms_messages][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][sms_messages][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account]
|
object (SmsAccount) |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][sms_messages][][sms_account][type]
|
string |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][params]
|
array |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][identifier]
|
string |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][is_enabled]
|
boolean |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][is_connected]
|
boolean |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][is_tested]
|
boolean |
* |
|
data.primary_translation[ticket][sms_messages][][sms_account][test_code]
|
string |
* |
|
data.primary_translation[ticket][sms_messages][][job]
|
object (Job) |
* |
|
data.primary_translation[ticket][sms_messages][][job][id]
|
integer |
* |
The unique job id. |
data.primary_translation[ticket][sms_messages][][job][type]
|
string |
* |
The job type, used by the Job Router
to find the right Job Processor.
|
data.primary_translation[ticket][sms_messages][][job][status]
|
string |
* |
The status of the job. |
data.primary_translation[ticket][sms_messages][][job][status_code]
|
string |
* |
Any code to further classify the
status.
|
data.primary_translation[ticket][sms_messages][][job][date_touch]
|
DateTime |
* |
Date the last time a process "touched"
this ticket.
|
data.primary_translation[ticket][sms_messages][][job][date_created]
|
DateTime |
* |
Date this job entered the "jobs"
table.
|
data.primary_translation[ticket][sms_messages][][job][date_last_try]
|
DateTime |
* |
Last time we processed this job.
|
data.primary_translation[ticket][sms_messages][][job][date_next_try]
|
DateTime |
* |
If this DateTime is in the future, it
won't be selected for execution.
|
data.primary_translation[ticket][sms_messages][][job][num_tries]
|
integer |
* |
The number of times this job has been
executed Job Processor (usually
indicated failures if > 1).
|
data.primary_translation[ticket][sms_messages][][job][log_summary]
|
string |
* |
A human readable summary of the job's
execution.
|
data.primary_translation[ticket][sms_messages][][job][log]
|
string |
* |
A more verbose log. |
data.primary_translation[ticket][sms_messages][][job][data]
|
array |
* |
An array of data, or payload, that the
job processor needs to execute this
job (stored in the db as json). This
MUST always be an array, even if its
an empty array
|
data.primary_translation[ticket][sms_messages][][job][original_job]
|
integer |
* |
Null unless the job was created as a
retry - if so, the originating job ID
is stored here so we can query it
later. Note: You MUST specify the
originating job, do not create a
linked list of failed jobs.
|
data.primary_translation[ticket][sms_messages][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][sms_messages][][from_number]
|
string |
* |
Permanent record of the phone number
that sent this SMS. (Won't change even
if Person changes their phone number).
|
data.primary_translation[ticket][sms_messages][][to_number]
|
string |
* |
Permanent record of the phone number
that this SMS was sent to.
|
data.primary_translation[ticket][sms_messages][][message]
|
string |
* |
The SMS message. |
data.primary_translation[ticket][sms_messages][][direction]
|
string |
* |
Just a system flag for reporting.
|
data.primary_translation[ticket][topic_links][]
|
array of objects
(TicketCommunityTopicLink)
|
* |
|
data.primary_translation[ticket][topic_links][][id]
|
integer |
* |
The unique filter ID. |
data.primary_translation[ticket][topic_links][][ticket]
|
integer id (Ticket) |
* |
|
data.primary_translation[ticket][topic_links][][topic]
|
integer id (CommunityTopic) |
* |
|
data.primary_translation[ticket][topic_links][][person]
|
integer id (Person) |
* |
|
data.primary_translation[ticket][topic_links][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][custom_data][]
|
array of objects (CustomDataTicket)
|
* |
|
data.primary_translation[ticket][custom_data][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][custom_data][][field]
|
object (CustomDefTicket) |
* |
|
data.primary_translation[ticket][custom_data][][field][parent]
|
object (CustomDefTicket) |
* |
|
data.primary_translation[ticket][custom_data][][field][children][]
|
array of objects (CustomDefTicket)
|
* |
Field children. |
data.primary_translation[ticket][custom_data][][root_field]
|
object (CustomDefTicket) |
* |
|
data.primary_translation[ticket][labels][]
|
array of objects (LabelTicket) |
* |
|
data.primary_translation[ticket][labels][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][sent_to_address]
|
string |
* |
The email address the ticket was sent
to if it came in via a gateway. This
is a full string (e.g., including
CC's) of the original.
|
data.primary_translation[ticket][email_account]
|
object (EmailAccount) |
* |
The gateway this ticket originated
from.
|
data.primary_translation[ticket][email_account][id]
|
integer |
* |
|
data.primary_translation[ticket][email_account][account_type]
|
string |
* |
|
data.primary_translation[ticket][email_account][is_enabled]
|
boolean |
* |
|
data.primary_translation[ticket][email_account][address]
|
string |
* |
|
data.primary_translation[ticket][email_account][cert_blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][email_account][cert_blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket][email_account][cert_blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket][email_account][cert_blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket][email_account][cert_blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket][email_account][cert_blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket][email_account][cert_blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket][email_account][cert_blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket][email_account][cert_blob][authcode]
|
string |
* |
|
data.primary_translation[ticket][email_account][cert_blob][blob_hash]
|
string |
* |
|
data.primary_translation[ticket][email_account][cert_blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket][email_account][cert_blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket][email_account][cert_blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket][email_account][cert_blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket][email_account][cert_blob][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][email_account][cert_blob][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket][email_account][cert_blob][source_ref]
|
string |
* |
|
data.primary_translation[ticket][email_account][cert_blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket][email_account][cert_blob][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][email_account][key_blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket][email_account_address]
|
string |
* |
The email address (from list of to/cc)
that matched with the email account.
|
data.primary_translation[ticket][creation_system]
|
string |
* |
|
data.primary_translation[ticket][creation_system_option]
|
string |
* |
Optional information about the
creation system. For example, source
URL the ticket came from.
|
data.primary_translation[ticket][ticket_hash]
|
string |
* |
|
data.primary_translation[ticket][status]
|
string |
* |
|
data.primary_translation[ticket][ticket_status]
|
object (TicketStatus) |
* |
|
data.primary_translation[ticket][ticket_status][id]
|
integer |
* |
|
data.primary_translation[ticket][ticket_status][status_type]
|
string |
* |
|
data.primary_translation[ticket][ticket_status][status_code]
|
string |
* |
|
data.primary_translation[ticket][ticket_status][sys_id]
|
string |
* |
|
data.primary_translation[ticket][ticket_status][title]
|
string |
* |
|
data.primary_translation[ticket][ticket_status][display_order]
|
integer |
* |
|
data.primary_translation[ticket][ticket_status][pending_waiting_time_mode]
|
string |
* |
Where to count time spending in
pending status. Check
PENDING_WAITING_TIME_MODE_ constants
|
data.primary_translation[ticket][ticket_status][children][]
|
array of objects (TicketStatus) |
* |
|
data.primary_translation[ticket][ticket_status][options]
|
array |
* |
|
data.primary_translation[ticket][urgency]
|
integer |
* |
|
data.primary_translation[ticket][feedback_rating]
|
integer |
* |
|
data.primary_translation[ticket][date_feedback_rating]
|
DateTime |
* |
|
data.primary_translation[ticket][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][date_resolved]
|
DateTime |
* |
|
data.primary_translation[ticket][date_archived]
|
DateTime |
* |
|
data.primary_translation[ticket][date_first_agent_assign]
|
DateTime |
* |
|
data.primary_translation[ticket][date_first_agent_reply]
|
DateTime |
* |
|
data.primary_translation[ticket][date_last_agent_reply]
|
DateTime |
* |
|
data.primary_translation[ticket][date_last_user_reply]
|
DateTime |
* |
|
data.primary_translation[ticket][date_agent_waiting]
|
DateTime |
* |
|
data.primary_translation[ticket][date_user_waiting]
|
DateTime |
* |
|
data.primary_translation[ticket][date_status]
|
DateTime |
* |
|
data.primary_translation[ticket][date_on_hold]
|
DateTime |
* |
|
data.primary_translation[ticket][total_user_waiting]
|
integer |
* |
|
data.primary_translation[ticket][total_to_first_reply]
|
integer |
* |
|
data.primary_translation[ticket][total_user_waiting_wh_start]
|
DateTime |
* |
|
data.primary_translation[ticket][total_user_waiting_wh]
|
integer |
* |
|
data.primary_translation[ticket][total_to_first_reply_wh]
|
integer |
* |
|
data.primary_translation[ticket][locked_by_agent]
|
object (Person) |
* |
|
data.primary_translation[ticket][date_locked]
|
DateTime |
* |
|
data.primary_translation[ticket][has_attachments]
|
boolean |
* |
|
data.primary_translation[ticket][subject]
|
string |
* |
|
data.primary_translation[ticket][original_subject]
|
string |
* |
|
data.primary_translation[ticket][properties]
|
array |
* |
|
data.primary_translation[ticket][count_agent_replies]
|
integer |
* |
|
data.primary_translation[ticket][count_user_replies]
|
integer |
* |
|
data.primary_translation[ticket][worst_sla_status]
|
string |
* |
|
data.primary_translation[ticket][waiting_times]
|
array |
* |
Used to track ticket status changes
and how much time ticket was in status
Add new item every time status changed
This is optimisation over TicketLog.
|
data.primary_translation[ticket][participants][]
|
array of objects (TicketParticipant)
|
* |
|
data.primary_translation[ticket][participants][][id]
|
integer |
* |
|
data.primary_translation[ticket][participants][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][participants][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][participants][][access_code]
|
object (TicketAccessCode) |
* |
|
data.primary_translation[ticket][participants][][person_email]
|
object (PersonEmail) |
* |
|
data.primary_translation[ticket][participants][][default_on]
|
boolean |
* |
Default checkbox status of the user.
|
data.primary_translation[ticket][charges][]
|
array of objects (TicketCharge) |
* |
|
data.primary_translation[ticket][charges][][id]
|
integer |
* |
|
data.primary_translation[ticket][charges][][charge_time]
|
integer |
* |
|
data.primary_translation[ticket][charges][][amount]
|
float |
* |
|
data.primary_translation[ticket][charges][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][charges][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][charges][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][charges][][organization]
|
object (Organization) |
* |
|
data.primary_translation[ticket][charges][][agent]
|
object (Person) |
* |
|
data.primary_translation[ticket][charges][][custom_data][]
|
array of objects (CustomDataBilling)
|
* |
|
data.primary_translation[ticket][charges][][custom_data][][ticket_charge]
|
object (TicketCharge) |
* |
|
data.primary_translation[ticket][charges][][custom_data][][field]
|
object (CustomDefBilling) |
* |
|
data.primary_translation[ticket][charges][][custom_data][][field][parent]
|
object (CustomDefBilling) |
* |
|
data.primary_translation[ticket][charges][][custom_data][][field][children][]
|
array of objects (CustomDefBilling)
|
* |
Field children. |
data.primary_translation[ticket][charges][][custom_data][][root_field]
|
object (CustomDefBilling) |
* |
|
data.primary_translation[ticket][ticket_slas][]
|
array of objects (TicketSla) |
* |
|
data.primary_translation[ticket][ticket_slas][][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][ticket_slas][][sla_status]
|
string |
* |
The SLA status. |
data.primary_translation[ticket][ticket_slas][][warn_date]
|
DateTime |
* |
The SLA warn date. |
data.primary_translation[ticket][ticket_slas][][fail_date]
|
DateTime |
* |
The SLA fail date. |
data.primary_translation[ticket][ticket_slas][][is_completed]
|
boolean |
* |
Is the SLA completed? |
data.primary_translation[ticket][ticket_slas][][is_completed_set]
|
boolean |
* |
Completed by automated action. |
data.primary_translation[ticket][ticket_slas][][completed_time_taken]
|
integer |
* |
Time taken. |
data.primary_translation[ticket][ticket_slas][][ticket]
|
integer id (Ticket) |
* |
Ticket. |
data.primary_translation[ticket][ticket_slas][][sla]
|
integer id (Sla) |
* |
SLA. |
data.primary_translation[ticket][ticket_slas][][date_applied]
|
DateTime |
* |
time and date when SLA was applied to
the ticket.
|
data.primary_translation[ticket][ticket_slas][][date_completed]
|
DateTime |
* |
time when SLA status became OK. |
data.primary_translation[ticket][jira_issues][]
|
array of objects (JiraIssue) |
* |
linked jira issues. |
data.primary_translation[ticket][jira_issues][][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][jira_issues][][ticket]
|
object (Ticket) |
* |
The associated DeskPRO ticket. |
data.primary_translation[ticket][jira_issues][][issue_id]
|
integer |
* |
|
data.primary_translation[ticket][jira_issues][][status_id]
|
integer |
* |
|
data.primary_translation[ticket][jira_issues][][created]
|
DateTime |
* |
Export time. |
data.primary_translation[ticket][problems][]
|
array of objects (Problem) |
* |
|
data.primary_translation[ticket][problems][][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][problems][][title]
|
string |
* |
Problem title. |
data.primary_translation[ticket][problems][][creator]
|
integer id (Person) |
* |
Person who created the problem. |
data.primary_translation[ticket][problems][][created]
|
DateTime |
* |
Date when the problem was created.
|
data.primary_translation[ticket][problems][][is_open]
|
boolean |
* |
Is problem still has no solution?
|
data.primary_translation[ticket][problems][][tickets][]
|
array of integer ids (Ticket) |
* |
Tickets associated with problem.
|
data.primary_translation[ticket][stars][]
|
array of objects (TicketFlagged)
|
* |
|
data.primary_translation[ticket][stars][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][stars][][person_id]
|
integer |
* |
|
data.primary_translation[ticket][stars][][color]
|
string |
* |
|
data.primary_translation[ticket][follow_ups][]
|
array of objects (TicketFollowUp)
|
* |
|
data.primary_translation[ticket][follow_ups][][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][follow_ups][][person]
|
integer id (Person) |
* |
|
data.primary_translation[ticket][follow_ups][][actions]
|
array |
* |
|
data.primary_translation[ticket][follow_ups][][cancel_if_user_reply]
|
boolean |
* |
|
data.primary_translation[ticket][follow_ups][][cancel_if_agent_reply]
|
boolean |
* |
|
data.primary_translation[ticket][follow_ups][][status]
|
string |
* |
|
data.primary_translation[ticket][follow_ups][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][follow_ups][][date_to_run]
|
DateTime |
* |
|
data.primary_translation[ticket][follow_ups][][date_did_run]
|
DateTime |
* |
|
data.primary_translation[ticket][logs][]
|
array of objects (TicketLog) |
* |
|
data.primary_translation[ticket][logs][][id]
|
integer |
* |
|
data.primary_translation[ticket][logs][][parent]
|
object (TicketLog) |
* |
|
data.primary_translation[ticket][logs][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][logs][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket][logs][][action_type]
|
string |
* |
|
data.primary_translation[ticket][logs][][id_object]
|
integer |
* |
If the log involves a specific thing
in a ticket (eg a message that was
moved), then that is this id.
|
data.primary_translation[ticket][logs][][id_before]
|
integer |
* |
The ID of the previous entity changed,
or any other numeric value.
|
data.primary_translation[ticket][logs][][id_after]
|
integer |
* |
The ID of the new entity, or any other
numeric value.
|
data.primary_translation[ticket][logs][][trigger_id]
|
integer |
* |
If the change was caused by a trigger,
the trigger id. Note this is the
integer ID (not a FK relation) so the
record is kept even if the trigger
itself is deleted.
|
data.primary_translation[ticket][logs][][escalation_id]
|
integer |
* |
If the change was caused by an
escalation Note this is the integer ID
(not a FK relation) so the record is
kept even if the esc itself is
deleted.
|
data.primary_translation[ticket][logs][][macro_id]
|
integer |
* |
If the change was caused by an v2
macro Note this is the integer ID (not
a FK relation) so the record is kept
even if the esc itself is deleted.
|
data.primary_translation[ticket][logs][][sla]
|
object (Sla) |
* |
If the change was caused by an SLA,
the SLA.
|
data.primary_translation[ticket][logs][][sla][id]
|
integer |
* |
The unique ID. |
data.primary_translation[ticket][logs][][sla][title]
|
string |
* |
SLA title. |
data.primary_translation[ticket][logs][][sla][sla_type]
|
string |
* |
Type of SLA - first_response,
resolution, waiting_time.
|
data.primary_translation[ticket][logs][][sla][active_time]
|
string |
* |
Whether active all the time (all) or
during work hours only (work_hours) or
use the default ticket-wide settings
(default).
|
data.primary_translation[ticket][logs][][sla][work_start]
|
integer |
* |
When the work day starts. This is
stored as the number of seconds after
00:00:00.
|
data.primary_translation[ticket][logs][][sla][work_end]
|
integer |
* |
When the work day ends. This is stored
as the number of seconds after
00:00:00.
|
data.primary_translation[ticket][logs][][sla][work_days]
|
array |
* |
Array of work days, stored with keys
corresponding to day numbers. Values
are true. 0 = Sunday, 6 = Saturday
(same as PHP, easy to convert to MySQL
which is 1 = Sunday, 7 = Saturday).
|
data.primary_translation[ticket][logs][][sla][work_timezone]
|
string |
* |
Timezone for work hours/days to be
considered in.
|
data.primary_translation[ticket][logs][][sla][work_holidays]
|
array |
* |
List of work holidays. |
data.primary_translation[ticket][logs][][sla][apply_type]
|
string |
* |
Controls how the SLA is applied to
tickets: all, terms,
terms_before_triggers, manual.
|
data.primary_translation[ticket][logs][][sla][apply_terms]
|
object (TriggerTerms) |
* |
Conditions to apply. |
data.primary_translation[ticket][logs][][sla][apply_terms][version]
|
integer |
* |
Terms version. |
data.primary_translation[ticket][logs][][sla][apply_terms][terms]
|
array |
* |
Terms themselves. |
data.primary_translation[ticket][logs][][sla][trigger_terms]
|
object (TriggerTerms) |
* |
Conditions to consider sla completed.
|
data.primary_translation[ticket][logs][][sla][warn_time]
|
integer |
* |
Warn time integer. |
data.primary_translation[ticket][logs][][sla][warn_time_unit]
|
string |
* |
And it's unit (see warn time). |
data.primary_translation[ticket][logs][][sla][warn_actions]
|
object (TriggerActions) |
* |
How to warn about SLA will fail.
|
data.primary_translation[ticket][logs][][sla][warn_actions][version]
|
integer |
* |
Actions version. |
data.primary_translation[ticket][logs][][sla][warn_actions][actions]
|
array |
* |
Actions array representation. |
data.primary_translation[ticket][logs][][sla][fail_time]
|
integer |
* |
Fail time integer. |
data.primary_translation[ticket][logs][][sla][fail_time_unit]
|
string |
* |
And it's measuring unit (see
fail_time).
|
data.primary_translation[ticket][logs][][sla][fail_actions]
|
object (TriggerActions) |
* |
What to do if SLA failed. |
data.primary_translation[ticket][logs][][sla][exclude_ticket_statuses]
|
array |
* |
This SLA will not apply while tickets
are in these pending statuses.
|
data.primary_translation[ticket][logs][][sla_status]
|
string |
* |
|
data.primary_translation[ticket][logs][][details]
|
array |
* |
|
data.primary_translation[ticket][logs][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][chats][]
|
array of objects (ChatConversation)
|
* |
|
data.primary_translation[ticket][created_with_channel]
|
string |
* |
|
data.primary_translation[ticket][last_channel_used]
|
string |
* |
|
data.primary_translation[ticket][channels]
|
array |
* |
|
data.primary_translation[ticket][pending_articles][]
|
array of objects
(ArticlePendingCreate)
|
* |
|
data.primary_translation[ticket][pending_articles][][id]
|
integer |
* |
|
data.primary_translation[ticket][pending_articles][][person]
|
integer id (Person) |
* |
|
data.primary_translation[ticket][pending_articles][][assigned_person]
|
integer id (Person) |
* |
|
data.primary_translation[ticket][pending_articles][][ticket]
|
integer id (Ticket) |
* |
|
data.primary_translation[ticket][pending_articles][][message]
|
integer id (TicketMessage) |
* |
|
data.primary_translation[ticket][pending_articles][][comment]
|
string |
* |
|
data.primary_translation[ticket][pending_articles][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket][summary]
|
object (TicketSummary) |
* |
|
data.primary_translation[ticket][summary][id]
|
integer |
* |
|
data.primary_translation[ticket][summary][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket][summary][summary]
|
string |
* |
|
data.primary_translation[ticket][summary][summary_input]
|
string |
* |
|
data.primary_translation[ticket][summary][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket_message][id]
|
integer |
* |
The unique id of message. |
data.primary_translation[ticket_message][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.primary_translation[ticket_message][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.primary_translation[ticket_message][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.primary_translation[ticket_message][email_source][id]
|
integer |
* |
|
data.primary_translation[ticket_message][email_source][uuid]
|
string |
* |
|
data.primary_translation[ticket_message][email_source][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket_message][email_source][blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket_message][email_source][blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket_message][email_source][blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket_message][email_source][blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket_message][email_source][blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket_message][email_source][blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket_message][email_source][blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket_message][email_source][blob][authcode]
|
string |
* |
|
data.primary_translation[ticket_message][email_source][blob][blob_hash]
|
string |
* |
|
data.primary_translation[ticket_message][email_source][blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket_message][email_source][blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket_message][email_source][blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket_message][email_source][blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket_message][email_source][blob][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket_message][email_source][blob][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket_message][email_source][blob][source_ref]
|
string |
* |
|
data.primary_translation[ticket_message][email_source][blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket_message][email_source][blob][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket_message][email_source][object_type]
|
string |
* |
The type of object this is attached to
(should be the table name of the super
type, eg: tickets, people,
organizations). This typically is not
set until after the email is processed
(ie the status is 'processed').
|
data.primary_translation[ticket_message][email_source][object_id]
|
integer |
* |
The ID of the object this is attached
to.
|
data.primary_translation[ticket_message][email_source][from_email]
|
string |
* |
|
data.primary_translation[ticket_message][email_source][status]
|
string |
* |
The current status of the message: -
inserted: Only inserted - processing:
Currently processing - complete: Fully
processed - error: Tried to process
but there was some kind of error (see
error_code).
|
data.primary_translation[ticket_message][email_source][date_status]
|
DateTime |
* |
|
data.primary_translation[ticket_message][email_source][error_code]
|
string |
* |
When status is error, this is the code
that describes the error.
|
data.primary_translation[ticket_message][email_source][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket_message][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.primary_translation[ticket_message][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.primary_translation[ticket_message][date_created]
|
DateTime |
* |
Date when message was created. |
data.primary_translation[ticket_message][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.primary_translation[ticket_message][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.primary_translation[ticket_message][creation_system]
|
string |
* |
How this message was created. |
data.primary_translation[ticket_message][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.primary_translation[ticket_message][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.primary_translation[ticket_message][hostname]
|
string |
* |
Host from which message was left.
|
data.primary_translation[ticket_message][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.primary_translation[ticket_message][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.primary_translation[ticket_message][message_hash]
|
string |
* |
An unique hash of message. |
data.primary_translation[ticket_message][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.primary_translation[ticket_message][message]
|
string |
* |
The message, will be in HTML! |
data.primary_translation[ticket_message][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.primary_translation[ticket_message][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.primary_translation[ticket_message][message_source]
|
string |
* |
The message source. |
data.primary_translation[ticket_message][message_source_type]
|
string |
* |
The message source type. |
data.primary_translation[ticket_message][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.primary_translation[ticket_message][lang_code]
|
string |
* |
The set/detected lang code. |
data.primary_translation[ticket_message][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.primary_translation[ticket_message][email_message_id][][id]
|
integer |
* |
|
data.primary_translation[ticket_message][email_message_id][][message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket_message][email_message_id][][email_id]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.primary_translation[ticket_message][ticket_feedback][][id]
|
integer |
* |
|
data.primary_translation[ticket_message][ticket_feedback][][ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket_message][ticket_feedback][][ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket_message][ticket_feedback][][person]
|
object (Person) |
* |
|
data.primary_translation[ticket_message][ticket_feedback][][rating]
|
integer |
* |
|
data.primary_translation[ticket_message][ticket_feedback][][message]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_feedback][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][id]
|
integer |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][new_ticket]
|
object (Ticket) |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][subject]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][from_email]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][tos]
|
array |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][ccs]
|
array |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][bccs]
|
array |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][message]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][]
|
array of objects (Blob) |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][authcode]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][blob_hash]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][is_temp]
|
boolean |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][source_ref]
|
string |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.primary_translation[ticket_message][ticket_message_forwards][][date_created]
|
DateTime |
* |
|
data.primary_translation[ticket_message][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.primary_translation[ticket_message][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.primary_translation[ticket_message][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.primary_translation[ticket_message][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.primary_translation[ticket_message][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.primary_translation[ticket_message][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.primary_translation[ticket_message][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.primary_translation[ticket_message][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.primary_translation[ticket_message][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.primary_translation[ticket_message][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.primary_translation[ticket_message][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.primary_translation[from_lang_code]
|
string |
* |
|
data.primary_translation[lang_code]
|
string |
* |
|
data.primary_translation[message]
|
string |
* |
|
data.primary_translation[date_created]
|
DateTime |
* |
|
data.id |
integer |
* |
The unique id of message. |
data.ticket |
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.ticket[id] |
integer |
* |
|
data.ticket[ref] |
string |
* |
|
data.ticket[auth] |
string |
* |
|
data.ticket[parent_ticket] |
object (Ticket) |
* |
Parent ticket. |
data.ticket[children_tickets][] |
array of objects (Ticket) |
* |
|
data.ticket[language] |
object (Language) |
* |
The language the ticket is in. |
data.ticket[language][id] |
integer |
* |
The unique ID. |
data.ticket[language][sys_name] |
string |
* |
The unique sys name assigned to the
language.
|
data.ticket[language][title] |
string |
* |
Title of the language. |
data.ticket[language][title_local]
|
string |
* |
Title of the language. |
data.ticket[language][base_filepath]
|
string |
* |
The base filepath for default phrases
for this lang.
|
data.ticket[language][locale] |
string |
* |
The locale code. |
data.ticket[language][flag_image]
|
string |
* |
String path to image. |
data.ticket[language][is_rtl] |
boolean |
* |
True if this is a right-to-left
language.
|
data.ticket[language][has_user] |
boolean |
* |
True if has user. |
data.ticket[language][has_agent]
|
boolean |
* |
True if has agent. |
data.ticket[language][has_admin]
|
boolean |
* |
True if has admin. |
data.ticket[language][plural_categories][]
|
array of strings |
* |
|
data.ticket[language][plural_formula]
|
string |
* |
A formula using "n" being an integer.
This formula should be compatible with
most C-based languages that support
ternary operators. Booleans should be
cast to an integer (i.e. true = 1,
false = 0). Given an integer n, this
formular returns the plural form to
use for that number. The plural form
can be used as the index to find the
category name.
|
data.ticket[language][flag_urn] |
string |
* |
Used in new admin to set custom flag
icon in the format:
`urn:deskpro:flag:$countryCode`
|
data.ticket[brand] |
object (Brand) |
* |
|
data.ticket[brand][id] |
integer |
* |
The unique ID. |
data.ticket[brand][name] |
string |
* |
The brand name. |
data.ticket[brand][slug] |
string |
* |
|
data.ticket[brand][url] |
string |
* |
The brand url. |
data.ticket[brand][theme_set] |
object (ThemeSet) |
* |
|
data.ticket[brand][theme_set][id]
|
integer |
* |
|
data.ticket[brand][theme_set][theme_id]
|
string |
* |
|
data.ticket[brand][theme_set][title]
|
string |
* |
|
data.ticket[brand][theme_set][options]
|
|
* |
|
data.ticket[brand][edit_theme_set]
|
object (ThemeSet) |
* |
|
data.ticket[brand][departments][]
|
array of objects (Department) |
* |
|
data.ticket[brand][departments][][id]
|
integer |
* |
|
data.ticket[brand][departments][][parent]
|
object (Department) |
* |
|
data.ticket[brand][departments][][children][]
|
array of objects (Department) |
* |
|
data.ticket[brand][departments][][title]
|
string |
* |
|
data.ticket[brand][departments][][user_title]
|
string |
* |
|
data.ticket[brand][departments][][is_tickets_enabled]
|
boolean |
* |
|
data.ticket[brand][departments][][is_chat_enabled]
|
boolean |
* |
|
data.ticket[brand][departments][][display_order]
|
integer |
* |
|
data.ticket[brand][departments][][avatar]
|
object (Blob) |
* |
|
data.ticket[brand][departments][][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[brand][departments][][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[brand][departments][][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[brand][departments][][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[brand][departments][][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[brand][departments][][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[brand][departments][][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[brand][departments][][avatar][authcode]
|
string |
* |
|
data.ticket[brand][departments][][avatar][blob_hash]
|
string |
* |
|
data.ticket[brand][departments][][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[brand][departments][][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[brand][departments][][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[brand][departments][][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[brand][departments][][avatar][date_created]
|
DateTime |
* |
|
data.ticket[brand][departments][][avatar][is_temp]
|
boolean |
* |
|
data.ticket[brand][departments][][avatar][source_ref]
|
string |
* |
|
data.ticket[brand][departments][][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[brand][departments][][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[brand][departments][][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.ticket[brand][departments][][brands][]
|
array of objects (Brand) |
* |
|
data.ticket[brand][departments][][permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.ticket[brand][departments][][permissions][][department]
|
integer id (Department) |
* |
|
data.ticket[brand][departments][][permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.ticket[brand][departments][][permissions][][name]
|
string |
* |
The name of the permission. |
data.ticket[brand][departments][][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.ticket[brand][departments][][permissions][][is_active]
|
boolean |
* |
|
data.ticket[brand][departments][][chat_queue]
|
object (UserChatQueue) |
* |
|
data.ticket[brand][departments][][chat_queue][id]
|
integer |
* |
The unique ID. |
data.ticket[brand][departments][][chat_queue][name]
|
string |
* |
|
data.ticket[brand][departments][][chat_queue][routing_model]
|
string |
* |
|
data.ticket[brand][departments][][chat_queue][answer_timeout]
|
integer |
* |
|
data.ticket[brand][departments][][chat_queue][is_all_agents]
|
boolean |
* |
|
data.ticket[brand][departments][][chat_queue][departments][]
|
array of objects (Department) |
* |
|
data.ticket[brand][departments][][chat_queue][max_queue_size]
|
integer |
* |
|
data.ticket[brand][departments][][chat_queue][routingModel]
|
|
* |
|
data.ticket[brand][theme_sets][]
|
array of objects (ThemeSet) |
* |
|
data.ticket[department] |
object (Department) |
* |
|
data.ticket[department][id] |
integer |
* |
|
data.ticket[department][parent] |
object (Department) |
* |
|
data.ticket[department][children][]
|
array of objects (Department) |
* |
|
data.ticket[department][title] |
string |
* |
|
data.ticket[department][user_title]
|
string |
* |
|
data.ticket[department][is_tickets_enabled]
|
boolean |
* |
|
data.ticket[department][is_chat_enabled]
|
boolean |
* |
|
data.ticket[department][display_order]
|
integer |
* |
|
data.ticket[department][avatar] |
object (Blob) |
* |
|
data.ticket[department][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[department][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[department][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[department][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[department][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[department][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[department][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[department][avatar][authcode]
|
string |
* |
|
data.ticket[department][avatar][blob_hash]
|
string |
* |
|
data.ticket[department][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[department][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[department][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[department][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[department][avatar][date_created]
|
DateTime |
* |
|
data.ticket[department][avatar][is_temp]
|
boolean |
* |
|
data.ticket[department][avatar][source_ref]
|
string |
* |
|
data.ticket[department][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[department][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[department][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.ticket[department][brands][]
|
array of objects (Brand) |
* |
|
data.ticket[department][permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.ticket[department][permissions][][department]
|
integer id (Department) |
* |
|
data.ticket[department][permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.ticket[department][permissions][][name]
|
string |
* |
The name of the permission. |
data.ticket[department][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.ticket[department][permissions][][is_active]
|
boolean |
* |
|
data.ticket[department][chat_queue]
|
object (UserChatQueue) |
* |
|
data.ticket[department][chat_queue][id]
|
integer |
* |
The unique ID. |
data.ticket[department][chat_queue][name]
|
string |
* |
|
data.ticket[department][chat_queue][routing_model]
|
string |
* |
|
data.ticket[department][chat_queue][answer_timeout]
|
integer |
* |
|
data.ticket[department][chat_queue][is_all_agents]
|
boolean |
* |
|
data.ticket[department][chat_queue][departments][]
|
array of objects (Department) |
* |
|
data.ticket[department][chat_queue][max_queue_size]
|
integer |
* |
|
data.ticket[category] |
object (TicketCategory) |
* |
|
data.ticket[category][id] |
integer |
* |
The unique ID. |
data.ticket[category][parent] |
integer id (TicketCategory) |
* |
This category parent. |
data.ticket[category][title] |
string |
* |
Category title. |
data.ticket[category][display_order]
|
integer |
* |
Obviously it's display order for
lists.
|
data.ticket[priority] |
object (TicketPriority) |
* |
|
data.ticket[priority][id] |
integer |
* |
The unique ID. |
data.ticket[priority][title] |
string |
* |
Priority title. |
data.ticket[priority][priority] |
integer |
* |
The priority itself. |
data.ticket[workflow] |
object (TicketWorkflow) |
* |
|
data.ticket[workflow][id] |
integer |
* |
The unique ID. |
data.ticket[workflow][title] |
string |
* |
Workflow title. |
data.ticket[workflow][display_order]
|
integer |
* |
Workflow display order. |
data.ticket[product] |
object (Product) |
* |
|
data.ticket[product][parent] |
integer id (Product) |
* |
Parent of the product. |
data.ticket[product][title] |
|
* |
|
data.ticket[person] |
object (Person) |
* |
|
data.ticket[person_email] |
object (PersonEmail) |
* |
|
data.ticket[person_email][id] |
integer |
* |
The unique ID. |
data.ticket[person_email][person]
|
integer id (Person) |
* |
Person owner of email. |
data.ticket[person_email][email]
|
string |
* |
The email address. |
data.ticket[person_email][email_domain]
|
string |
* |
The email address domain. |
data.ticket[person_email][is_validated]
|
boolean |
* |
True if validation passed. |
data.ticket[person_email][date_created]
|
DateTime |
* |
The original time the email was
created.
|
data.ticket[agent] |
object (Person) |
* |
|
data.ticket[agent_team] |
object (AgentTeam) |
* |
|
data.ticket[agent_team][id] |
integer |
* |
The unique ID. |
data.ticket[agent_team][name] |
string |
* |
The name of agent team. |
data.ticket[agent_team][avatar_urn]
|
string |
* |
Avatar urn, used to store emoji avatar
|
data.ticket[agent_team][members]
|
|
* |
|
data.ticket[organization] |
object (Organization) |
* |
|
data.ticket[organization][id] |
integer |
* |
The unique ID. |
data.ticket[organization][picture_blob]
|
object (Blob) |
* |
The org picture. |
data.ticket[organization][picture_blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[organization][picture_blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[organization][picture_blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[organization][picture_blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[organization][picture_blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[organization][picture_blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[organization][picture_blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[organization][picture_blob][authcode]
|
string |
* |
|
data.ticket[organization][picture_blob][blob_hash]
|
string |
* |
|
data.ticket[organization][picture_blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[organization][picture_blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[organization][picture_blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[organization][picture_blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[organization][picture_blob][date_created]
|
DateTime |
* |
|
data.ticket[organization][picture_blob][is_temp]
|
boolean |
* |
|
data.ticket[organization][picture_blob][source_ref]
|
string |
* |
|
data.ticket[organization][picture_blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[organization][picture_blob][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[organization][icon_property]
|
object (IconProperty) |
* |
|
data.ticket[organization][icon_property][urn]
|
string |
* |
|
data.ticket[organization][icon_property][options]
|
array |
* |
|
data.ticket[organization][name] |
string |
* |
The organization name. |
data.ticket[organization][summary]
|
string |
* |
The summary field as filled in by
agents.
|
data.ticket[organization][importance]
|
integer |
* |
The org importance. |
data.ticket[organization][custom_data][]
|
array of objects
(CustomDataOrganization)
|
* |
|
data.ticket[organization][custom_data][][organization]
|
object (Organization) |
* |
|
data.ticket[organization][custom_data][][field]
|
object (CustomDefOrganization) |
* |
|
data.ticket[organization][custom_data][][field][parent]
|
object (CustomDefOrganization) |
* |
Field`s parent. |
data.ticket[organization][custom_data][][field][children][]
|
array of objects
(CustomDefOrganization)
|
* |
Field children. |
data.ticket[organization][custom_data][][field][title]
|
|
* |
|
data.ticket[organization][custom_data][][root_field]
|
object (CustomDefOrganization) |
* |
|
data.ticket[organization][usergroups][]
|
array of objects (Usergroup) |
* |
Usergroups the user belongs to. |
data.ticket[organization][usergroups][][id]
|
integer |
* |
The unique ID, DB-generated. |
data.ticket[organization][usergroups][][title]
|
string |
* |
Title of the usergroup. |
data.ticket[organization][usergroups][][note]
|
string |
* |
A note or description about the
usergroup.
|
data.ticket[organization][usergroups][][is_agent_group]
|
boolean |
* |
Is this an agent group? |
data.ticket[organization][usergroups][][sys_name]
|
string |
* |
When non-null, the group is a special
system group (hidden from most
interfaces).
|
data.ticket[organization][usergroups][][is_enabled]
|
boolean |
* |
Is the group enabled? |
data.ticket[organization][usergroups][][permissions][]
|
array of objects (Permission) |
* |
Usergroup permissions. |
data.ticket[organization][usergroups][][permissions][][id]
|
integer |
* |
The unique ID. |
data.ticket[organization][usergroups][][permissions][][name]
|
string |
* |
The name of the permission. |
data.ticket[organization][usergroups][][permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.ticket[organization][usergroups][][permissions][][is_active]
|
boolean |
* |
True means this permission record is
active for normal use with the
permission resolver. When a $person
permission is used but the $person in
question is also part of a usergroup,
then this record might be superfluous:
If the ug grants the perm, and this
record grants the perm, then we have
two records that both grant the perm.
This isn't harmful usually but if you
have many many agents defined and they
all have these duplicative perms, then
you end up with many thousands of
extra rows, which are all fetched and
processed with the permission
resolver. So we turn these extra perms
"off" so the resolver doesn't fetch
them. That means if a hd with many
agent uses groups instead of
overrides, permission resolving is
much much faster.
|
data.ticket[organization][usergroups][][department_permissions][]
|
array of objects
(DepartmentPermission)
|
* |
|
data.ticket[organization][usergroups][][department_permissions][][department]
|
integer id (Department) |
* |
|
data.ticket[organization][usergroups][][department_permissions][][app]
|
string |
* |
Application name. It's going to be
either chat or tickets.
|
data.ticket[organization][usergroups][][department_permissions][][name]
|
string |
* |
The name of the permission. |
data.ticket[organization][usergroups][][department_permissions][][value]
|
integer |
* |
Any numeric number (ex filesize,
flag).
|
data.ticket[organization][usergroups][][department_permissions][][is_active]
|
boolean |
* |
|
data.ticket[organization][usergroups][][people][]
|
array of objects (Person) |
* |
Usergroup members. |
data.ticket[organization][auto_cc_people][]
|
array of objects (Person) |
* |
Users who are set to automatically be
added to tickets and other org things.
|
data.ticket[organization][labels][]
|
array of objects (LabelOrganization)
|
* |
|
data.ticket[organization][labels][][organization]
|
object (Organization) |
* |
|
data.ticket[organization][contact_data][]
|
array of objects
(OrganizationContactData)
|
* |
|
data.ticket[organization][contact_data][][organization]
|
|
* |
|
data.ticket[organization][contact_data][][contact_type]
|
|
* |
|
data.ticket[organization][contact_data][][comment]
|
|
* |
|
data.ticket[organization][contact_data][][field_1]
|
|
* |
|
data.ticket[organization][contact_data][][field_2]
|
|
* |
|
data.ticket[organization][contact_data][][field_3]
|
|
* |
|
data.ticket[organization][contact_data][][field_5]
|
|
* |
|
data.ticket[organization][contact_data][][field_9]
|
|
* |
|
data.ticket[organization][emails][]
|
array of objects (OrganizationEmail)
|
* |
|
data.ticket[organization][emails][][id]
|
integer |
* |
The unique log id. |
data.ticket[organization][emails][][organization]
|
object (Organization) |
* |
|
data.ticket[organization][emails][][email]
|
string |
* |
|
data.ticket[organization][emails][][date_created]
|
DateTime |
* |
|
data.ticket[organization][email_domains][]
|
array of objects
(OrganizationEmailDomain)
|
* |
|
data.ticket[organization][email_domains][][domain]
|
string |
* |
The email domain. |
data.ticket[organization][email_domains][][organization]
|
object (Organization) |
* |
The users organization. |
data.ticket[organization][date_created]
|
DateTime |
* |
The date the org was inserted into the
system.
|
data.ticket[organization][members][]
|
array of objects (Person) |
* |
|
data.ticket[organization][parent]
|
object (Organization) |
* |
|
data.ticket[organization][children][]
|
array of objects (Organization) |
* |
|
data.ticket[organization][tickets][]
|
array of objects (Ticket) |
* |
|
data.ticket[organization][organization_members][]
|
array of objects (OrganizationMember)
|
* |
|
data.ticket[organization][organization_members][][id]
|
integer |
* |
|
data.ticket[organization][organization_members][][person]
|
integer id (Person) |
* |
|
data.ticket[organization][organization_members][][organization]
|
integer id (Organization) |
* |
|
data.ticket[organization][organization_members][][is_manager]
|
boolean |
* |
|
data.ticket[organization][organization_members][][position]
|
string |
* |
|
data.ticket[organization][organization_members][][created_at]
|
DateTime |
* |
|
data.ticket[organization][organization_members][][updated_at]
|
DateTime |
* |
|
data.ticket[organization][publicUsergroups]
|
|
* |
|
data.ticket[linked_chat] |
object (ChatConversation) |
* |
|
data.ticket[linked_chat][id] |
integer |
* |
The unique id of chat conversation.
|
data.ticket[linked_chat][department]
|
object (Department) |
* |
Department which chat was assigned.
|
data.ticket[linked_chat][brand] |
object (Brand) |
* |
Department which chat was assigned.
|
data.ticket[linked_chat][task_id]
|
integer |
* |
|
data.ticket[linked_chat][ticket]
|
object (Ticket) |
* |
|
data.ticket[linked_chat][labels][]
|
array of objects
(LabelChatConversation)
|
* |
|
data.ticket[linked_chat][labels][][chat]
|
object (ChatConversation) |
* |
|
data.ticket[linked_chat][subject]
|
string |
* |
Subject of the chat conversation.
|
data.ticket[linked_chat][status]
|
string |
* |
Status of the chat conversation.
|
data.ticket[linked_chat][agent] |
object (Person) |
* |
If this is a user conversation, this
is the agent assigned.
|
data.ticket[linked_chat][agent_team]
|
object (AgentTeam) |
* |
If this is a team chat, the team it
is.
|
data.ticket[linked_chat][person]
|
object (Person) |
* |
If this is a user conversation, this
is the user who started the chat.
|
data.ticket[linked_chat][session]
|
object (Session) |
* |
If this is a user convo, this is the
users session.
|
data.ticket[linked_chat][session][id]
|
integer |
* |
The unique ID. |
data.ticket[linked_chat][session][auth]
|
string |
* |
The authcode for the session to verify
an id.
|
data.ticket[linked_chat][session][interface]
|
string |
* |
The Interface the session is for.
|
data.ticket[linked_chat][session][person]
|
object (Person) |
* |
|
data.ticket[linked_chat][session][user_agent]
|
string |
* |
The users user agent string. |
data.ticket[linked_chat][session][visitor_id]
|
string |
* |
|
data.ticket[linked_chat][session][ip_address]
|
string |
* |
The users IP address. |
data.ticket[linked_chat][session][data]
|
string |
* |
|
data.ticket[linked_chat][session][is_person]
|
boolean |
* |
|
data.ticket[linked_chat][session][is_bot]
|
boolean |
* |
|
data.ticket[linked_chat][session][is_helpdesk]
|
boolean |
* |
|
data.ticket[linked_chat][session][active_status]
|
string |
* |
(Agents) Status (available or away).
|
data.ticket[linked_chat][session][is_chat_available]
|
boolean |
* |
(Agents) Wehn status is available, if
they are available for chat.
|
data.ticket[linked_chat][session][date_created]
|
DateTime |
* |
|
data.ticket[linked_chat][session][date_last]
|
DateTime |
* |
|
data.ticket[linked_chat][session][date_last_page]
|
DateTime |
* |
|
data.ticket[linked_chat][visitor_id]
|
string |
* |
|
data.ticket[linked_chat][person_name]
|
string |
* |
User chat: The users name, if they
arent a person.
|
data.ticket[linked_chat][person_email]
|
string |
* |
User chat: The users email, if they
aren`t a person.
|
data.ticket[linked_chat][participants][]
|
array of objects (Person) |
* |
|
data.ticket[linked_chat][messages][]
|
array of objects (ChatMessage) |
* |
|
data.ticket[linked_chat][messages][][id]
|
integer |
* |
The unique ID. |
data.ticket[linked_chat][messages][][author_id]
|
integer |
* |
Author id (legacy). |
data.ticket[linked_chat][messages][][author_type]
|
string |
* |
Author type (legacy). |
data.ticket[linked_chat][messages][][conversation_id]
|
integer |
* |
Conversation id (legacy). |
data.ticket[linked_chat][messages][][author]
|
integer id (Person) |
* |
Person who created the message. |
data.ticket[linked_chat][messages][][content]
|
string |
* |
The message. |
data.ticket[linked_chat][messages][][is_sys]
|
boolean |
* |
Is this a system message? (ended,
joined, etc).
|
data.ticket[linked_chat][messages][][is_user]
|
boolean |
* |
Is this an user's message? (send from
the widget).
|
data.ticket[linked_chat][messages][][is_html]
|
boolean |
* |
Is the content an HTML message? |
data.ticket[linked_chat][messages][][metadata]
|
array |
* |
Additional data. |
data.ticket[linked_chat][messages][][date_created]
|
DateTime |
* |
Date message was created. |
data.ticket[linked_chat][messages][][date_received]
|
DateTime |
* |
Date message was received. |
data.ticket[linked_chat][custom_data][]
|
array of objects (CustomDataChat)
|
* |
|
data.ticket[linked_chat][custom_data][][conversation]
|
object (ChatConversation) |
* |
The conversation the message belongs
to.
|
data.ticket[linked_chat][custom_data][][field]
|
object (CustomDefChat) |
* |
|
data.ticket[linked_chat][custom_data][][field][parent]
|
object (CustomDefChat) |
* |
|
data.ticket[linked_chat][custom_data][][field][children][]
|
array of objects (CustomDefChat)
|
* |
Field children. |
data.ticket[linked_chat][custom_data][][field][title]
|
|
* |
|
data.ticket[linked_chat][custom_data][][root_field]
|
object (CustomDefChat) |
* |
|
data.ticket[linked_chat][rating_response_time]
|
integer |
* |
|
data.ticket[linked_chat][rating_overall]
|
integer |
* |
|
data.ticket[linked_chat][rating_comment]
|
string |
* |
|
data.ticket[linked_chat][is_agent]
|
boolean |
* |
Is this an agent chat. |
data.ticket[linked_chat][is_window]
|
boolean |
* |
If the chat is popped out into a
window. This is used to make sure the
JS widget on pages doesn't load again.
|
data.ticket[linked_chat][date_created]
|
DateTime |
* |
Date when chat was started. |
data.ticket[linked_chat][date_user_waiting]
|
DateTime |
* |
Since when the user has started
waiting (i.e., time the assignment was
0).
|
data.ticket[linked_chat][date_assigned]
|
DateTime |
* |
|
data.ticket[linked_chat][date_agent_typing]
|
DateTime |
* |
Date when agent typed last time.
|
data.ticket[linked_chat][date_first_agent_message]
|
DateTime |
* |
|
data.ticket[linked_chat][date_ended]
|
DateTime |
* |
Date when chat was ended. |
data.ticket[linked_chat][total_to_ended]
|
integer |
* |
|
data.ticket[linked_chat][ended_by]
|
string |
* |
Who ended the chat. |
data.ticket[linked_chat][should_send_transcript]
|
boolean |
* |
True if transcript should be send.
|
data.ticket[linked_chat][date_transcript_sent]
|
DateTime |
* |
Date when transcript was sent. |
data.ticket[linked_chat][email_validation_code]
|
string |
* |
|
data.ticket[linked_chat][email_validated]
|
boolean |
* |
|
data.ticket[linked_chat][access_token]
|
string |
* |
|
data.ticket[attachments][] |
array of objects (TicketAttachment)
|
* |
|
data.ticket[attachments][][id] |
integer |
* |
The unique ID. |
data.ticket[attachments][][ticket]
|
integer id (Ticket) |
* |
Ticket this attachment belongs to.
|
data.ticket[attachments][][person]
|
integer id (Person) |
* |
Who created the attachment. |
data.ticket[attachments][][blob]
|
object (Blob) |
* |
Actual attachment. |
data.ticket[attachments][][blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[attachments][][blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[attachments][][blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[attachments][][blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[attachments][][blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[attachments][][blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[attachments][][blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[attachments][][blob][authcode]
|
string |
* |
|
data.ticket[attachments][][blob][blob_hash]
|
string |
* |
|
data.ticket[attachments][][blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[attachments][][blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[attachments][][blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[attachments][][blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[attachments][][blob][date_created]
|
DateTime |
* |
|
data.ticket[attachments][][blob][is_temp]
|
boolean |
* |
|
data.ticket[attachments][][blob][source_ref]
|
string |
* |
|
data.ticket[attachments][][blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[attachments][][blob][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[attachments][][message]
|
integer id (TicketMessage) |
* |
Message - holder of this attachment.
|
data.ticket[attachments][][is_agent_note]
|
boolean |
* |
True if this attachmen just a note.
|
data.ticket[attachments][][is_inline]
|
boolean |
* |
Is this attachment is embed in
message.
|
data.ticket[access_codes][] |
array of objects (TicketAccessCode)
|
* |
|
data.ticket[access_codes][][id] |
integer |
* |
|
data.ticket[access_codes][][ticket]
|
object (Ticket) |
* |
|
data.ticket[access_codes][][person]
|
object (Person) |
* |
|
data.ticket[access_codes][][auth]
|
string |
* |
|
data.ticket[messages][] |
array of objects (TicketMessage)
|
* |
|
data.ticket[messages][][id] |
integer |
* |
The unique id of message. |
data.ticket[messages][][ticket] |
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.ticket[messages][][person] |
object (Person) |
* |
Person this message was sent by.
|
data.ticket[messages][][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.ticket[messages][][email_source][id]
|
integer |
* |
|
data.ticket[messages][][email_source][uuid]
|
string |
* |
|
data.ticket[messages][][email_source][blob]
|
object (Blob) |
* |
|
data.ticket[messages][][email_source][blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[messages][][email_source][blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[messages][][email_source][blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[messages][][email_source][blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[messages][][email_source][blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[messages][][email_source][blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[messages][][email_source][blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[messages][][email_source][blob][authcode]
|
string |
* |
|
data.ticket[messages][][email_source][blob][blob_hash]
|
string |
* |
|
data.ticket[messages][][email_source][blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[messages][][email_source][blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[messages][][email_source][blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[messages][][email_source][blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[messages][][email_source][blob][date_created]
|
DateTime |
* |
|
data.ticket[messages][][email_source][blob][is_temp]
|
boolean |
* |
|
data.ticket[messages][][email_source][blob][source_ref]
|
string |
* |
|
data.ticket[messages][][email_source][blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[messages][][email_source][blob][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[messages][][email_source][object_type]
|
string |
* |
The type of object this is attached to
(should be the table name of the super
type, eg: tickets, people,
organizations). This typically is not
set until after the email is processed
(ie the status is 'processed').
|
data.ticket[messages][][email_source][object_id]
|
integer |
* |
The ID of the object this is attached
to.
|
data.ticket[messages][][email_source][from_email]
|
string |
* |
|
data.ticket[messages][][email_source][status]
|
string |
* |
The current status of the message: -
inserted: Only inserted - processing:
Currently processing - complete: Fully
processed - error: Tried to process
but there was some kind of error (see
error_code).
|
data.ticket[messages][][email_source][date_status]
|
DateTime |
* |
|
data.ticket[messages][][email_source][error_code]
|
string |
* |
When status is error, this is the code
that describes the error.
|
data.ticket[messages][][email_source][date_created]
|
DateTime |
* |
|
data.ticket[messages][][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.ticket[messages][][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.ticket[messages][][snippet_use_logs][][id]
|
integer |
* |
The unique ID. |
data.ticket[messages][][snippet_use_logs][][snippet]
|
object (SnippetV2) |
* |
Snippet used. |
data.ticket[messages][][snippet_use_logs][][snippet][id]
|
integer |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][title]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][author]
|
object (Person) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][is_private]
|
boolean |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar]
|
object (Blob) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][authcode]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][blob_hash]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][date_created]
|
DateTime |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][is_temp]
|
boolean |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][source_ref]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][avatar][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][status]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][shortcut_codes]
|
array |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][inline_translations]
|
array |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][translations][]
|
array of objects
(SnippetV2Translation)
|
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][translations][][id]
|
integer |
* |
The unique ID. |
data.ticket[messages][][snippet_use_logs][][snippet][translations][][snippet]
|
object (SnippetV2) |
* |
Snippet translated. |
data.ticket[messages][][snippet_use_logs][][snippet][translations][][language]
|
object (Language) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][translations][][content]
|
array |
* |
Snippet content. |
data.ticket[messages][][snippet_use_logs][][snippet][translations][][blobs][]
|
array of objects (Blob) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][]
|
array of objects (SnippetV2Category)
|
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][][id]
|
integer |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][][title]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][][is_global]
|
boolean |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][][display_order]
|
integer |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][][parent]
|
object (SnippetV2Category) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][categories][][agent_teams][]
|
array of objects (AgentTeam) |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][display_order]
|
integer |
* |
|
data.ticket[messages][][snippet_use_logs][][snippet][date_created]
|
DateTime |
* |
|
data.ticket[messages][][snippet_use_logs][][ticket_message]
|
object (TicketMessage) |
* |
Ticket Message where the snippet was
used.
|
data.ticket[messages][][snippet_use_logs][][chat_message]
|
object (ChatMessage) |
* |
Chat Message where the snippet was
used.
|
data.ticket[messages][][snippet_use_logs][][chat_message][id]
|
integer |
* |
The unique ID. |
data.ticket[messages][][snippet_use_logs][][chat_message][author_id]
|
integer |
* |
Author id (legacy). |
data.ticket[messages][][snippet_use_logs][][chat_message][author_type]
|
string |
* |
Author type (legacy). |
data.ticket[messages][][snippet_use_logs][][chat_message][conversation_id]
|
integer |
* |
Conversation id (legacy). |
data.ticket[messages][][snippet_use_logs][][chat_message][author]
|
integer id (Person) |
* |
Person who created the message. |
data.ticket[messages][][snippet_use_logs][][chat_message][content]
|
string |
* |
The message. |
data.ticket[messages][][snippet_use_logs][][chat_message][is_sys]
|
boolean |
* |
Is this a system message? (ended,
joined, etc).
|
data.ticket[messages][][snippet_use_logs][][chat_message][is_user]
|
boolean |
* |
Is this an user's message? (send from
the widget).
|
data.ticket[messages][][snippet_use_logs][][chat_message][is_html]
|
boolean |
* |
Is the content an HTML message? |
data.ticket[messages][][snippet_use_logs][][chat_message][metadata]
|
array |
* |
Additional data. |
data.ticket[messages][][snippet_use_logs][][chat_message][date_created]
|
DateTime |
* |
Date message was created. |
data.ticket[messages][][snippet_use_logs][][chat_message][date_received]
|
DateTime |
* |
Date message was received. |
data.ticket[messages][][snippet_use_logs][][language]
|
object (Language) |
* |
Snippet translated. |
data.ticket[messages][][snippet_use_logs][][person]
|
object (Person) |
* |
|
data.ticket[messages][][snippet_use_logs][][rating]
|
integer |
* |
|
data.ticket[messages][][snippet_use_logs][][rating_person]
|
object (Person) |
* |
|
data.ticket[messages][][snippet_use_logs][][rating_message]
|
string |
* |
|
data.ticket[messages][][snippet_use_logs][][date_created]
|
DateTime |
* |
|
data.ticket[messages][][date_created]
|
DateTime |
* |
Date when message was created. |
data.ticket[messages][][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.ticket[messages][][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.ticket[messages][][creation_system]
|
string |
* |
How this message was created. |
data.ticket[messages][][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.ticket[messages][][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.ticket[messages][][hostname]
|
string |
* |
Host from which message was left.
|
data.ticket[messages][][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.ticket[messages][][email] |
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.ticket[messages][][message_hash]
|
string |
* |
An unique hash of message. |
data.ticket[messages][][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.ticket[messages][][primary_translation][id]
|
integer |
* |
|
data.ticket[messages][][primary_translation][ticket]
|
object (Ticket) |
* |
|
data.ticket[messages][][primary_translation][ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket[messages][][primary_translation][from_lang_code]
|
string |
* |
|
data.ticket[messages][][primary_translation][lang_code]
|
string |
* |
|
data.ticket[messages][][primary_translation][message]
|
string |
* |
|
data.ticket[messages][][primary_translation][date_created]
|
DateTime |
* |
|
data.ticket[messages][][message]
|
string |
* |
The message, will be in HTML! |
data.ticket[messages][][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.ticket[messages][][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.ticket[messages][][message_source]
|
string |
* |
The message source. |
data.ticket[messages][][message_source_type]
|
string |
* |
The message source type. |
data.ticket[messages][][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.ticket[messages][][lang_code]
|
string |
* |
The set/detected lang code. |
data.ticket[messages][][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.ticket[messages][][email_message_id][][id]
|
integer |
* |
|
data.ticket[messages][][email_message_id][][message]
|
object (TicketMessage) |
* |
|
data.ticket[messages][][email_message_id][][email_id]
|
string |
* |
|
data.ticket[messages][][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.ticket[messages][][ticket_feedback][][id]
|
integer |
* |
|
data.ticket[messages][][ticket_feedback][][ticket]
|
object (Ticket) |
* |
|
data.ticket[messages][][ticket_feedback][][ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket[messages][][ticket_feedback][][person]
|
object (Person) |
* |
|
data.ticket[messages][][ticket_feedback][][rating]
|
integer |
* |
|
data.ticket[messages][][ticket_feedback][][message]
|
string |
* |
|
data.ticket[messages][][ticket_feedback][][date_created]
|
DateTime |
* |
|
data.ticket[messages][][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.ticket[messages][][ticket_message_forwards][][id]
|
integer |
* |
|
data.ticket[messages][][ticket_message_forwards][][ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket[messages][][ticket_message_forwards][][new_ticket]
|
object (Ticket) |
* |
|
data.ticket[messages][][ticket_message_forwards][][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket[messages][][ticket_message_forwards][][subject]
|
string |
* |
|
data.ticket[messages][][ticket_message_forwards][][from_email]
|
string |
* |
|
data.ticket[messages][][ticket_message_forwards][][tos]
|
array |
* |
|
data.ticket[messages][][ticket_message_forwards][][ccs]
|
array |
* |
|
data.ticket[messages][][ticket_message_forwards][][bccs]
|
array |
* |
|
data.ticket[messages][][ticket_message_forwards][][message]
|
string |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][]
|
array of objects (Blob) |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][authcode]
|
string |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][blob_hash]
|
string |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[messages][][ticket_message_forwards][][blobs][][date_created]
|
DateTime |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][is_temp]
|
boolean |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][source_ref]
|
string |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[messages][][ticket_message_forwards][][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[messages][][ticket_message_forwards][][date_created]
|
DateTime |
* |
|
data.ticket[messages][][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.ticket[messages][][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.ticket[messages][][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.ticket[messages][][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.ticket[messages][][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.ticket[messages][][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.ticket[messages][][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.ticket[messages][][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.ticket[messages][][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.ticket[messages][][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.ticket[messages][][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.ticket[sms_messages][] |
array of objects (TicketSms) |
* |
|
data.ticket[sms_messages][][id] |
integer |
* |
|
data.ticket[sms_messages][][ticket]
|
object (Ticket) |
* |
|
data.ticket[sms_messages][][person]
|
object (Person) |
* |
|
data.ticket[sms_messages][][sms_account]
|
object (SmsAccount) |
* |
|
data.ticket[sms_messages][][sms_account][id]
|
integer |
* |
The unique ID. |
data.ticket[sms_messages][][sms_account][type]
|
string |
* |
|
data.ticket[sms_messages][][sms_account][params]
|
array |
* |
|
data.ticket[sms_messages][][sms_account][identifier]
|
string |
* |
|
data.ticket[sms_messages][][sms_account][is_enabled]
|
boolean |
* |
|
data.ticket[sms_messages][][sms_account][is_connected]
|
boolean |
* |
|
data.ticket[sms_messages][][sms_account][is_tested]
|
boolean |
* |
|
data.ticket[sms_messages][][sms_account][test_code]
|
string |
* |
|
data.ticket[sms_messages][][job]
|
object (Job) |
* |
|
data.ticket[sms_messages][][job][id]
|
integer |
* |
The unique job id. |
data.ticket[sms_messages][][job][type]
|
string |
* |
The job type, used by the Job Router
to find the right Job Processor.
|
data.ticket[sms_messages][][job][status]
|
string |
* |
The status of the job. |
data.ticket[sms_messages][][job][status_code]
|
string |
* |
Any code to further classify the
status.
|
data.ticket[sms_messages][][job][date_touch]
|
DateTime |
* |
Date the last time a process "touched"
this ticket.
|
data.ticket[sms_messages][][job][date_created]
|
DateTime |
* |
Date this job entered the "jobs"
table.
|
data.ticket[sms_messages][][job][date_last_try]
|
DateTime |
* |
Last time we processed this job.
|
data.ticket[sms_messages][][job][date_next_try]
|
DateTime |
* |
If this DateTime is in the future, it
won't be selected for execution.
|
data.ticket[sms_messages][][job][num_tries]
|
integer |
* |
The number of times this job has been
executed Job Processor (usually
indicated failures if > 1).
|
data.ticket[sms_messages][][job][log_summary]
|
string |
* |
A human readable summary of the job's
execution.
|
data.ticket[sms_messages][][job][log]
|
string |
* |
A more verbose log. |
data.ticket[sms_messages][][job][data]
|
array |
* |
An array of data, or payload, that the
job processor needs to execute this
job (stored in the db as json). This
MUST always be an array, even if its
an empty array
|
data.ticket[sms_messages][][job][original_job]
|
integer |
* |
Null unless the job was created as a
retry - if so, the originating job ID
is stored here so we can query it
later. Note: You MUST specify the
originating job, do not create a
linked list of failed jobs.
|
data.ticket[sms_messages][][date_created]
|
DateTime |
* |
|
data.ticket[sms_messages][][from_number]
|
string |
* |
Permanent record of the phone number
that sent this SMS. (Won't change even
if Person changes their phone number).
|
data.ticket[sms_messages][][to_number]
|
string |
* |
Permanent record of the phone number
that this SMS was sent to.
|
data.ticket[sms_messages][][message]
|
string |
* |
The SMS message. |
data.ticket[sms_messages][][direction]
|
string |
* |
Just a system flag for reporting.
|
data.ticket[topic_links][] |
array of objects
(TicketCommunityTopicLink)
|
* |
|
data.ticket[topic_links][][id] |
integer |
* |
The unique filter ID. |
data.ticket[topic_links][][ticket]
|
integer id (Ticket) |
* |
|
data.ticket[topic_links][][topic]
|
integer id (CommunityTopic) |
* |
|
data.ticket[topic_links][][person]
|
integer id (Person) |
* |
|
data.ticket[topic_links][][date_created]
|
DateTime |
* |
|
data.ticket[custom_data][] |
array of objects (CustomDataTicket)
|
* |
|
data.ticket[custom_data][][ticket]
|
object (Ticket) |
* |
|
data.ticket[custom_data][][field]
|
object (CustomDefTicket) |
* |
|
data.ticket[custom_data][][field][parent]
|
object (CustomDefTicket) |
* |
|
data.ticket[custom_data][][field][children][]
|
array of objects (CustomDefTicket)
|
* |
Field children. |
data.ticket[custom_data][][field][title]
|
|
* |
|
data.ticket[custom_data][][root_field]
|
object (CustomDefTicket) |
* |
|
data.ticket[labels][] |
array of objects (LabelTicket) |
* |
|
data.ticket[labels][][ticket] |
object (Ticket) |
* |
|
data.ticket[sent_to_address] |
string |
* |
The email address the ticket was sent
to if it came in via a gateway. This
is a full string (e.g., including
CC's) of the original.
|
data.ticket[email_account] |
object (EmailAccount) |
* |
The gateway this ticket originated
from.
|
data.ticket[email_account][id] |
integer |
* |
|
data.ticket[email_account][account_type]
|
string |
* |
|
data.ticket[email_account][is_enabled]
|
boolean |
* |
|
data.ticket[email_account][address]
|
string |
* |
|
data.ticket[email_account][cert_blob]
|
object (Blob) |
* |
|
data.ticket[email_account][cert_blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket[email_account][cert_blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket[email_account][cert_blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket[email_account][cert_blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket[email_account][cert_blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket[email_account][cert_blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket[email_account][cert_blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket[email_account][cert_blob][authcode]
|
string |
* |
|
data.ticket[email_account][cert_blob][blob_hash]
|
string |
* |
|
data.ticket[email_account][cert_blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket[email_account][cert_blob][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket[email_account][cert_blob][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket[email_account][cert_blob][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket[email_account][cert_blob][date_created]
|
DateTime |
* |
|
data.ticket[email_account][cert_blob][is_temp]
|
boolean |
* |
|
data.ticket[email_account][cert_blob][source_ref]
|
string |
* |
|
data.ticket[email_account][cert_blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket[email_account][cert_blob][labels][][blob]
|
object (Blob) |
* |
|
data.ticket[email_account][key_blob]
|
object (Blob) |
* |
|
data.ticket[email_account_address]
|
string |
* |
The email address (from list of to/cc)
that matched with the email account.
|
data.ticket[creation_system] |
string |
* |
|
data.ticket[creation_system_option]
|
string |
* |
Optional information about the
creation system. For example, source
URL the ticket came from.
|
data.ticket[ticket_hash] |
string |
* |
|
data.ticket[status] |
string |
* |
|
data.ticket[ticket_status] |
object (TicketStatus) |
* |
|
data.ticket[ticket_status][id] |
integer |
* |
|
data.ticket[ticket_status][status_type]
|
string |
* |
|
data.ticket[ticket_status][status_code]
|
string |
* |
|
data.ticket[ticket_status][sys_id]
|
string |
* |
|
data.ticket[ticket_status][title]
|
string |
* |
|
data.ticket[ticket_status][display_order]
|
integer |
* |
|
data.ticket[ticket_status][pending_waiting_time_mode]
|
string |
* |
Where to count time spending in
pending status. Check
PENDING_WAITING_TIME_MODE_ constants
|
data.ticket[ticket_status][children][]
|
array of objects (TicketStatus) |
* |
|
data.ticket[ticket_status][options]
|
array |
* |
|
data.ticket[ticket_status][statusType]
|
|
* |
|
data.ticket[ticket_status][displayOrder]
|
integer |
* |
|
data.ticket[urgency] |
integer |
* |
|
data.ticket[feedback_rating] |
integer |
* |
|
data.ticket[date_feedback_rating]
|
DateTime |
* |
|
data.ticket[date_created] |
DateTime |
* |
|
data.ticket[date_resolved] |
DateTime |
* |
|
data.ticket[date_archived] |
DateTime |
* |
|
data.ticket[date_first_agent_assign]
|
DateTime |
* |
|
data.ticket[date_first_agent_reply]
|
DateTime |
* |
|
data.ticket[date_last_agent_reply]
|
DateTime |
* |
|
data.ticket[date_last_user_reply]
|
DateTime |
* |
|
data.ticket[date_agent_waiting] |
DateTime |
* |
|
data.ticket[date_user_waiting] |
DateTime |
* |
|
data.ticket[date_status] |
DateTime |
* |
|
data.ticket[date_on_hold] |
DateTime |
* |
|
data.ticket[total_user_waiting] |
integer |
* |
|
data.ticket[total_to_first_reply]
|
integer |
* |
|
data.ticket[total_user_waiting_wh_start]
|
DateTime |
* |
|
data.ticket[total_user_waiting_wh]
|
integer |
* |
|
data.ticket[total_to_first_reply_wh]
|
integer |
* |
|
data.ticket[locked_by_agent] |
object (Person) |
* |
|
data.ticket[date_locked] |
DateTime |
* |
|
data.ticket[has_attachments] |
boolean |
* |
|
data.ticket[subject] |
string |
* |
|
data.ticket[original_subject] |
string |
* |
|
data.ticket[properties] |
array |
* |
|
data.ticket[count_agent_replies]
|
integer |
* |
|
data.ticket[count_user_replies] |
integer |
* |
|
data.ticket[worst_sla_status] |
string |
* |
|
data.ticket[waiting_times] |
array |
* |
Used to track ticket status changes
and how much time ticket was in status
Add new item every time status changed
This is optimisation over TicketLog.
|
data.ticket[participants][] |
array of objects (TicketParticipant)
|
* |
|
data.ticket[participants][][id] |
integer |
* |
|
data.ticket[participants][][ticket]
|
object (Ticket) |
* |
|
data.ticket[participants][][person]
|
object (Person) |
* |
|
data.ticket[participants][][access_code]
|
object (TicketAccessCode) |
* |
|
data.ticket[participants][][person_email]
|
object (PersonEmail) |
* |
|
data.ticket[participants][][default_on]
|
boolean |
* |
Default checkbox status of the user.
|
data.ticket[charges][] |
array of objects (TicketCharge) |
* |
|
data.ticket[charges][][id] |
integer |
* |
|
data.ticket[charges][][charge_time]
|
integer |
* |
|
data.ticket[charges][][amount] |
float |
* |
|
data.ticket[charges][][date_created]
|
DateTime |
* |
|
data.ticket[charges][][ticket] |
object (Ticket) |
* |
|
data.ticket[charges][][person] |
object (Person) |
* |
|
data.ticket[charges][][organization]
|
object (Organization) |
* |
|
data.ticket[charges][][agent] |
object (Person) |
* |
|
data.ticket[charges][][custom_data][]
|
array of objects (CustomDataBilling)
|
* |
|
data.ticket[charges][][custom_data][][ticket_charge]
|
object (TicketCharge) |
* |
|
data.ticket[charges][][custom_data][][field]
|
object (CustomDefBilling) |
* |
|
data.ticket[charges][][custom_data][][field][parent]
|
object (CustomDefBilling) |
* |
|
data.ticket[charges][][custom_data][][field][children][]
|
array of objects (CustomDefBilling)
|
* |
Field children. |
data.ticket[charges][][custom_data][][field][title]
|
|
* |
|
data.ticket[charges][][custom_data][][root_field]
|
object (CustomDefBilling) |
* |
|
data.ticket[ticket_slas][] |
array of objects (TicketSla) |
* |
|
data.ticket[ticket_slas][][id] |
integer |
* |
The unique ID. |
data.ticket[ticket_slas][][sla_status]
|
string |
* |
The SLA status. |
data.ticket[ticket_slas][][warn_date]
|
DateTime |
* |
The SLA warn date. |
data.ticket[ticket_slas][][fail_date]
|
DateTime |
* |
The SLA fail date. |
data.ticket[ticket_slas][][is_completed]
|
boolean |
* |
Is the SLA completed? |
data.ticket[ticket_slas][][is_completed_set]
|
boolean |
* |
Completed by automated action. |
data.ticket[ticket_slas][][completed_time_taken]
|
integer |
* |
Time taken. |
data.ticket[ticket_slas][][ticket]
|
integer id (Ticket) |
* |
Ticket. |
data.ticket[ticket_slas][][sla] |
integer id (Sla) |
* |
SLA. |
data.ticket[ticket_slas][][date_applied]
|
DateTime |
* |
time and date when SLA was applied to
the ticket.
|
data.ticket[ticket_slas][][date_completed]
|
DateTime |
* |
time when SLA status became OK. |
data.ticket[jira_issues][] |
array of objects (JiraIssue) |
* |
linked jira issues. |
data.ticket[jira_issues][][id] |
integer |
* |
The unique ID. |
data.ticket[jira_issues][][ticket]
|
object (Ticket) |
* |
The associated DeskPRO ticket. |
data.ticket[jira_issues][][issue_id]
|
integer |
* |
|
data.ticket[jira_issues][][status_id]
|
integer |
* |
|
data.ticket[jira_issues][][created]
|
DateTime |
* |
Export time. |
data.ticket[problems][] |
array of objects (Problem) |
* |
|
data.ticket[problems][][id] |
integer |
* |
The unique ID. |
data.ticket[problems][][title] |
string |
* |
Problem title. |
data.ticket[problems][][creator]
|
integer id (Person) |
* |
Person who created the problem. |
data.ticket[problems][][created]
|
DateTime |
* |
Date when the problem was created.
|
data.ticket[problems][][is_open]
|
boolean |
* |
Is problem still has no solution?
|
data.ticket[problems][][tickets][]
|
array of integer ids (Ticket) |
* |
Tickets associated with problem.
|
data.ticket[stars][] |
array of objects (TicketFlagged)
|
* |
|
data.ticket[stars][][ticket] |
object (Ticket) |
* |
|
data.ticket[stars][][person_id] |
integer |
* |
|
data.ticket[stars][][color] |
string |
* |
|
data.ticket[follow_ups][] |
array of objects (TicketFollowUp)
|
* |
|
data.ticket[follow_ups][][id] |
integer |
* |
The unique ID. |
data.ticket[follow_ups][][person]
|
integer id (Person) |
* |
|
data.ticket[follow_ups][][actions]
|
array |
* |
|
data.ticket[follow_ups][][cancel_if_user_reply]
|
boolean |
* |
|
data.ticket[follow_ups][][cancel_if_agent_reply]
|
boolean |
* |
|
data.ticket[follow_ups][][status]
|
string |
* |
|
data.ticket[follow_ups][][date_created]
|
DateTime |
* |
|
data.ticket[follow_ups][][date_to_run]
|
DateTime |
* |
|
data.ticket[follow_ups][][date_did_run]
|
DateTime |
* |
|
data.ticket[follow_ups][][dateToRun]
|
|
* |
|
data.ticket[logs][] |
array of objects (TicketLog) |
* |
|
data.ticket[logs][][id] |
integer |
* |
|
data.ticket[logs][][parent] |
object (TicketLog) |
* |
|
data.ticket[logs][][ticket] |
object (Ticket) |
* |
|
data.ticket[logs][][person] |
object (Person) |
* |
|
data.ticket[logs][][action_type]
|
string |
* |
|
data.ticket[logs][][id_object] |
integer |
* |
If the log involves a specific thing
in a ticket (eg a message that was
moved), then that is this id.
|
data.ticket[logs][][id_before] |
integer |
* |
The ID of the previous entity changed,
or any other numeric value.
|
data.ticket[logs][][id_after] |
integer |
* |
The ID of the new entity, or any other
numeric value.
|
data.ticket[logs][][trigger_id] |
integer |
* |
If the change was caused by a trigger,
the trigger id. Note this is the
integer ID (not a FK relation) so the
record is kept even if the trigger
itself is deleted.
|
data.ticket[logs][][escalation_id]
|
integer |
* |
If the change was caused by an
escalation Note this is the integer ID
(not a FK relation) so the record is
kept even if the esc itself is
deleted.
|
data.ticket[logs][][macro_id] |
integer |
* |
If the change was caused by an v2
macro Note this is the integer ID (not
a FK relation) so the record is kept
even if the esc itself is deleted.
|
data.ticket[logs][][sla] |
object (Sla) |
* |
If the change was caused by an SLA,
the SLA.
|
data.ticket[logs][][sla][id] |
integer |
* |
The unique ID. |
data.ticket[logs][][sla][title] |
string |
* |
SLA title. |
data.ticket[logs][][sla][sla_type]
|
string |
* |
Type of SLA - first_response,
resolution, waiting_time.
|
data.ticket[logs][][sla][active_time]
|
string |
* |
Whether active all the time (all) or
during work hours only (work_hours) or
use the default ticket-wide settings
(default).
|
data.ticket[logs][][sla][work_start]
|
integer |
* |
When the work day starts. This is
stored as the number of seconds after
00:00:00.
|
data.ticket[logs][][sla][work_end]
|
integer |
* |
When the work day ends. This is stored
as the number of seconds after
00:00:00.
|
data.ticket[logs][][sla][work_days]
|
array |
* |
Array of work days, stored with keys
corresponding to day numbers. Values
are true. 0 = Sunday, 6 = Saturday
(same as PHP, easy to convert to MySQL
which is 1 = Sunday, 7 = Saturday).
|
data.ticket[logs][][sla][work_timezone]
|
string |
* |
Timezone for work hours/days to be
considered in.
|
data.ticket[logs][][sla][work_holidays]
|
array |
* |
List of work holidays. |
data.ticket[logs][][sla][apply_type]
|
string |
* |
Controls how the SLA is applied to
tickets: all, terms,
terms_before_triggers, manual.
|
data.ticket[logs][][sla][apply_terms]
|
object (TriggerTerms) |
* |
Conditions to apply. |
data.ticket[logs][][sla][apply_terms][version]
|
integer |
* |
Terms version. |
data.ticket[logs][][sla][apply_terms][terms]
|
array |
* |
Terms themselves. |
data.ticket[logs][][sla][trigger_terms]
|
object (TriggerTerms) |
* |
Conditions to consider sla completed.
|
data.ticket[logs][][sla][warn_time]
|
integer |
* |
Warn time integer. |
data.ticket[logs][][sla][warn_time_unit]
|
string |
* |
And it's unit (see warn time). |
data.ticket[logs][][sla][warn_actions]
|
object (TriggerActions) |
* |
How to warn about SLA will fail.
|
data.ticket[logs][][sla][warn_actions][version]
|
integer |
* |
Actions version. |
data.ticket[logs][][sla][warn_actions][actions]
|
array |
* |
Actions array representation. |
data.ticket[logs][][sla][fail_time]
|
integer |
* |
Fail time integer. |
data.ticket[logs][][sla][fail_time_unit]
|
string |
* |
And it's measuring unit (see
fail_time).
|
data.ticket[logs][][sla][fail_actions]
|
object (TriggerActions) |
* |
What to do if SLA failed. |
data.ticket[logs][][sla][exclude_ticket_statuses]
|
array |
* |
This SLA will not apply while tickets
are in these pending statuses.
|
data.ticket[logs][][sla_status] |
string |
* |
|
data.ticket[logs][][details] |
array |
* |
|
data.ticket[logs][][date_created]
|
DateTime |
* |
|
data.ticket[chats][] |
array of objects (ChatConversation)
|
* |
|
data.ticket[created_with_channel]
|
string |
* |
|
data.ticket[last_channel_used] |
string |
* |
|
data.ticket[channels] |
array |
* |
|
data.ticket[pending_articles][] |
array of objects
(ArticlePendingCreate)
|
* |
|
data.ticket[pending_articles][][id]
|
integer |
* |
|
data.ticket[pending_articles][][person]
|
integer id (Person) |
* |
|
data.ticket[pending_articles][][assigned_person]
|
integer id (Person) |
* |
|
data.ticket[pending_articles][][ticket]
|
integer id (Ticket) |
* |
|
data.ticket[pending_articles][][message]
|
integer id (TicketMessage) |
* |
|
data.ticket[pending_articles][][comment]
|
string |
* |
|
data.ticket[pending_articles][][date_created]
|
DateTime |
* |
|
data.ticket[summary] |
object (TicketSummary) |
* |
|
data.ticket[summary][id] |
integer |
* |
|
data.ticket[summary][ticket] |
object (Ticket) |
* |
|
data.ticket[summary][summary] |
string |
* |
|
data.ticket[summary][summary_input]
|
string |
* |
|
data.ticket[summary][date_created]
|
DateTime |
* |
|
data.person |
object (Person) |
* |
Person this message was sent by.
|
data.person[emails] |
|
* |
|
data.person[labels] |
|
* |
|
data.person[teams] |
|
* |
|
data.person[primary_team] |
|
* |
|
data.person[agentData] |
|
* |
|
data.person[publicUsergroups] |
|
* |
|
data.person[publicAgentgroups] |
|
* |
|
data.email_source |
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.email_source[id] |
integer |
* |
|
data.email_source[uuid] |
string |
* |
|
data.email_source[blob] |
object (Blob) |
* |
|
data.email_source[blob][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.email_source[blob][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.email_source[blob][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.email_source[blob][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.email_source[blob][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.email_source[blob][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.email_source[blob][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.email_source[blob][authcode]
|
string |
* |
|
data.email_source[blob][blob_hash]
|
string |
* |
|
data.email_source[blob][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.email_source[blob][title] |
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.email_source[blob][dim_w] |
integer |
* |
If this type of file has dimentions,
the width.
|
data.email_source[blob][dim_h] |
integer |
* |
If this type of file has dimentions,
the height.
|
data.email_source[blob][date_created]
|
DateTime |
* |
|
data.email_source[blob][is_temp]
|
boolean |
* |
|
data.email_source[blob][source_ref]
|
string |
* |
|
data.email_source[blob][labels][]
|
array of objects (LabelBlob) |
* |
|
data.email_source[blob][labels][][blob]
|
object (Blob) |
* |
|
data.email_source[object_type] |
string |
* |
The type of object this is attached to
(should be the table name of the super
type, eg: tickets, people,
organizations). This typically is not
set until after the email is processed
(ie the status is 'processed').
|
data.email_source[object_id] |
integer |
* |
The ID of the object this is attached
to.
|
data.email_source[from_email] |
string |
* |
|
data.email_source[status] |
string |
* |
The current status of the message: -
inserted: Only inserted - processing:
Currently processing - complete: Fully
processed - error: Tried to process
but there was some kind of error (see
error_code).
|
data.email_source[date_status] |
DateTime |
* |
|
data.email_source[error_code] |
string |
* |
When status is error, this is the code
that describes the error.
|
data.email_source[date_created] |
DateTime |
* |
|
data.date_created |
DateTime |
* |
Date when message was created. |
data.is_agent_note |
boolean |
* |
Is this message agent note? |
data.is_hidden |
boolean |
* |
Is this message hidden? |
data.creation_system |
string |
* |
How this message was created. |
data.ip_address |
string |
* |
An ip address from which message was
sent.
|
data.visitor_id |
string |
* |
Unique ID of visitor left this
message.
|
data.hostname |
string |
* |
Host from which message was left.
|
data.geo_country |
string |
* |
Country message is from (deprecated).
|
data.email |
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.message_hash |
string |
* |
An unique hash of message. |
data.message |
string |
* |
The message, will be in HTML! |
data.message_full |
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.message_raw |
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.message_source |
string |
* |
The message source. |
data.message_source_type |
string |
* |
The message source type. |
data.show_full_hint |
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.lang_code |
string |
* |
The set/detected lang code. |
data.email_message_id[] |
array of objects
(TicketMessageEmailId)
|
* |
|
data.email_message_id[][id] |
integer |
* |
|
data.email_message_id[][message]
|
object (TicketMessage) |
* |
|
data.email_message_id[][message][id]
|
integer |
* |
The unique id of message. |
data.email_message_id[][message][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.email_message_id[][message][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.email_message_id[][message][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.email_message_id[][message][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.email_message_id[][message][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.email_message_id[][message][date_created]
|
DateTime |
* |
Date when message was created. |
data.email_message_id[][message][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.email_message_id[][message][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.email_message_id[][message][creation_system]
|
string |
* |
How this message was created. |
data.email_message_id[][message][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.email_message_id[][message][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.email_message_id[][message][hostname]
|
string |
* |
Host from which message was left.
|
data.email_message_id[][message][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.email_message_id[][message][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.email_message_id[][message][message_hash]
|
string |
* |
An unique hash of message. |
data.email_message_id[][message][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.email_message_id[][message][message]
|
string |
* |
The message, will be in HTML! |
data.email_message_id[][message][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.email_message_id[][message][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.email_message_id[][message][message_source]
|
string |
* |
The message source. |
data.email_message_id[][message][message_source_type]
|
string |
* |
The message source type. |
data.email_message_id[][message][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.email_message_id[][message][lang_code]
|
string |
* |
The set/detected lang code. |
data.email_message_id[][message][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.email_message_id[][message][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.email_message_id[][message][ticket_feedback][][id]
|
integer |
* |
|
data.email_message_id[][message][ticket_feedback][][ticket]
|
object (Ticket) |
* |
|
data.email_message_id[][message][ticket_feedback][][ticket_message]
|
object (TicketMessage) |
* |
|
data.email_message_id[][message][ticket_feedback][][person]
|
object (Person) |
* |
|
data.email_message_id[][message][ticket_feedback][][rating]
|
integer |
* |
|
data.email_message_id[][message][ticket_feedback][][message]
|
string |
* |
|
data.email_message_id[][message][ticket_feedback][][date_created]
|
DateTime |
* |
|
data.email_message_id[][message][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.email_message_id[][message][ticket_message_forwards][][id]
|
integer |
* |
|
data.email_message_id[][message][ticket_message_forwards][][ticket_message]
|
object (TicketMessage) |
* |
|
data.email_message_id[][message][ticket_message_forwards][][new_ticket]
|
object (Ticket) |
* |
|
data.email_message_id[][message][ticket_message_forwards][][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.email_message_id[][message][ticket_message_forwards][][subject]
|
string |
* |
|
data.email_message_id[][message][ticket_message_forwards][][from_email]
|
string |
* |
|
data.email_message_id[][message][ticket_message_forwards][][tos]
|
array |
* |
|
data.email_message_id[][message][ticket_message_forwards][][ccs]
|
array |
* |
|
data.email_message_id[][message][ticket_message_forwards][][bccs]
|
array |
* |
|
data.email_message_id[][message][ticket_message_forwards][][message]
|
string |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][]
|
array of objects (Blob) |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][authcode]
|
string |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][blob_hash]
|
string |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][date_created]
|
DateTime |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][is_temp]
|
boolean |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][source_ref]
|
string |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.email_message_id[][message][ticket_message_forwards][][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.email_message_id[][message][ticket_message_forwards][][date_created]
|
DateTime |
* |
|
data.email_message_id[][message][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.email_message_id[][message][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.email_message_id[][message][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.email_message_id[][message][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.email_message_id[][message][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.email_message_id[][message][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.email_message_id[][message][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.email_message_id[][message][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.email_message_id[][message][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.email_message_id[][message][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.email_message_id[][message][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.email_message_id[][email_id]
|
string |
* |
|
data.ticket_feedback[] |
array of objects (TicketFeedback)
|
* |
|
data.ticket_feedback[][id] |
integer |
* |
|
data.ticket_feedback[][ticket] |
object (Ticket) |
* |
|
data.ticket_feedback[][ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket_feedback[][ticket_message][id]
|
integer |
* |
The unique id of message. |
data.ticket_feedback[][ticket_message][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.ticket_feedback[][ticket_message][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.ticket_feedback[][ticket_message][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.ticket_feedback[][ticket_message][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.ticket_feedback[][ticket_message][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.ticket_feedback[][ticket_message][date_created]
|
DateTime |
* |
Date when message was created. |
data.ticket_feedback[][ticket_message][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.ticket_feedback[][ticket_message][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.ticket_feedback[][ticket_message][creation_system]
|
string |
* |
How this message was created. |
data.ticket_feedback[][ticket_message][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.ticket_feedback[][ticket_message][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.ticket_feedback[][ticket_message][hostname]
|
string |
* |
Host from which message was left.
|
data.ticket_feedback[][ticket_message][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.ticket_feedback[][ticket_message][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.ticket_feedback[][ticket_message][message_hash]
|
string |
* |
An unique hash of message. |
data.ticket_feedback[][ticket_message][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.ticket_feedback[][ticket_message][message]
|
string |
* |
The message, will be in HTML! |
data.ticket_feedback[][ticket_message][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.ticket_feedback[][ticket_message][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.ticket_feedback[][ticket_message][message_source]
|
string |
* |
The message source. |
data.ticket_feedback[][ticket_message][message_source_type]
|
string |
* |
The message source type. |
data.ticket_feedback[][ticket_message][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.ticket_feedback[][ticket_message][lang_code]
|
string |
* |
The set/detected lang code. |
data.ticket_feedback[][ticket_message][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.ticket_feedback[][ticket_message][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][id]
|
integer |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][new_ticket]
|
object (Ticket) |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][subject]
|
string |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][from_email]
|
string |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][tos]
|
array |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][ccs]
|
array |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][bccs]
|
array |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][message]
|
string |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][]
|
array of objects (Blob) |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][authcode]
|
string |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][blob_hash]
|
string |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][date_created]
|
DateTime |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][is_temp]
|
boolean |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][source_ref]
|
string |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.ticket_feedback[][ticket_message][ticket_message_forwards][][date_created]
|
DateTime |
* |
|
data.ticket_feedback[][ticket_message][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.ticket_feedback[][ticket_message][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.ticket_feedback[][ticket_message][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.ticket_feedback[][ticket_message][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.ticket_feedback[][ticket_message][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.ticket_feedback[][person] |
object (Person) |
* |
|
data.ticket_feedback[][rating] |
integer |
* |
|
data.ticket_feedback[][message] |
string |
* |
|
data.ticket_feedback[][date_created]
|
DateTime |
* |
|
data.ticket_message_forwards[] |
array of objects
(TicketMessageForward)
|
* |
|
data.ticket_message_forwards[][id]
|
integer |
* |
|
data.ticket_message_forwards[][ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket_message_forwards[][ticket_message][id]
|
integer |
* |
The unique id of message. |
data.ticket_message_forwards[][ticket_message][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.ticket_message_forwards[][ticket_message][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.ticket_message_forwards[][ticket_message][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.ticket_message_forwards[][ticket_message][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.ticket_message_forwards[][ticket_message][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.ticket_message_forwards[][ticket_message][date_created]
|
DateTime |
* |
Date when message was created. |
data.ticket_message_forwards[][ticket_message][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.ticket_message_forwards[][ticket_message][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.ticket_message_forwards[][ticket_message][creation_system]
|
string |
* |
How this message was created. |
data.ticket_message_forwards[][ticket_message][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.ticket_message_forwards[][ticket_message][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.ticket_message_forwards[][ticket_message][hostname]
|
string |
* |
Host from which message was left.
|
data.ticket_message_forwards[][ticket_message][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.ticket_message_forwards[][ticket_message][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.ticket_message_forwards[][ticket_message][message_hash]
|
string |
* |
An unique hash of message. |
data.ticket_message_forwards[][ticket_message][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.ticket_message_forwards[][ticket_message][message]
|
string |
* |
The message, will be in HTML! |
data.ticket_message_forwards[][ticket_message][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.ticket_message_forwards[][ticket_message][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.ticket_message_forwards[][ticket_message][message_source]
|
string |
* |
The message source. |
data.ticket_message_forwards[][ticket_message][message_source_type]
|
string |
* |
The message source type. |
data.ticket_message_forwards[][ticket_message][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.ticket_message_forwards[][ticket_message][lang_code]
|
string |
* |
The set/detected lang code. |
data.ticket_message_forwards[][ticket_message][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.ticket_message_forwards[][ticket_message][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.ticket_message_forwards[][ticket_message][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.ticket_message_forwards[][ticket_message][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.ticket_message_forwards[][ticket_message][channel_message][id]
|
integer |
* |
@var int The unique id of message.
|
data.ticket_message_forwards[][ticket_message][channel_message][ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.ticket_message_forwards[][ticket_message][channel_message][provider]
|
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.ticket_message_forwards[][ticket_message][channel_message][created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|
data.ticket_message_forwards[][new_ticket]
|
object (Ticket) |
* |
|
data.ticket_message_forwards[][new_ticket_message]
|
object (TicketMessage) |
* |
|
data.ticket_message_forwards[][subject]
|
string |
* |
|
data.ticket_message_forwards[][from_email]
|
string |
* |
|
data.ticket_message_forwards[][tos]
|
array |
* |
|
data.ticket_message_forwards[][ccs]
|
array |
* |
|
data.ticket_message_forwards[][bccs]
|
array |
* |
|
data.ticket_message_forwards[][message]
|
string |
* |
|
data.ticket_message_forwards[][blobs][]
|
array of objects (Blob) |
* |
|
data.ticket_message_forwards[][blobs][][sys_name]
|
string |
* |
A unique system name for the blob.
|
data.ticket_message_forwards[][blobs][][original_blob]
|
object (Blob) |
* |
Sometimes we might have multiple
versions of a file. For example, if a
file has been cropped then the cropped
file is saved as its own blob, but the
original is linked here.
|
data.ticket_message_forwards[][blobs][][storage_loc]
|
string |
* |
The storage adapter that knows how to
load this file.
|
data.ticket_message_forwards[][blobs][][storage_loc_pref]
|
string |
* |
The preferred storage adapter. This is
used to mark when we want to move a
file from one storage location to
another. For example, if an upload to
S3 failed and we saved the file in the
database instead, then the
$storage_loc would be 'db' but
$storage_loc_pref would be 's3'. The
cron jobs will look for when these two
values don't match and will attempt to
move resources gradually.
|
data.ticket_message_forwards[][blobs][][storage_loc_specific]
|
string |
* |
A set storage adapter. This is used to
'set' a storage adapter that will be
used even if the system would normally
use a different one. The main usage
for this is to store things like
logfiles in the database instead of
something like s3. DeskPRO saves lots
of logfiles, so its pretty inefficient
to send off lots of small logfiles to
s3.
|
data.ticket_message_forwards[][blobs][][save_path]
|
string |
* |
The path to the file if it's not
stored in the database.
|
data.ticket_message_forwards[][blobs][][file_url]
|
string |
* |
The HTTP link to download the file.
|
data.ticket_message_forwards[][blobs][][authcode]
|
string |
* |
|
data.ticket_message_forwards[][blobs][][blob_hash]
|
string |
* |
|
data.ticket_message_forwards[][blobs][][is_media_upload]
|
boolean |
* |
Is this a media upload (appears in the
media browser etc). These are files
that were uploaded and are attached to
things.
|
data.ticket_message_forwards[][blobs][][title]
|
string |
* |
The title of this file used in
interfaces if its a media upload.
|
data.ticket_message_forwards[][blobs][][dim_w]
|
integer |
* |
If this type of file has dimentions,
the width.
|
data.ticket_message_forwards[][blobs][][dim_h]
|
integer |
* |
If this type of file has dimentions,
the height.
|
data.ticket_message_forwards[][blobs][][date_created]
|
DateTime |
* |
|
data.ticket_message_forwards[][blobs][][is_temp]
|
boolean |
* |
|
data.ticket_message_forwards[][blobs][][source_ref]
|
string |
* |
|
data.ticket_message_forwards[][blobs][][labels][]
|
array of objects (LabelBlob) |
* |
|
data.ticket_message_forwards[][blobs][][labels][][blob]
|
object (Blob) |
* |
|
data.ticket_message_forwards[][date_created]
|
DateTime |
* |
|
data.channel_message |
object (TicketMessageChannelMessage)
|
* |
|
data.channel_message[id] |
integer |
* |
@var int The unique id of message.
|
data.channel_message[ticket_message]
|
object (TicketMessage) |
* |
@var TicketMessageEntity TicketMessage
with which this message is associated.
|
data.channel_message[ticket_message][id]
|
integer |
* |
The unique id of message. |
data.channel_message[ticket_message][ticket]
|
object (Ticket) |
* |
Ticket with which this message is
associated.
|
data.channel_message[ticket_message][person]
|
object (Person) |
* |
Person this message was sent by.
|
data.channel_message[ticket_message][email_source]
|
object (EmailSource) |
* |
Info about email source, if message
comes from such source.
|
data.channel_message[ticket_message][attachments][]
|
array of objects (TicketAttachment)
|
* |
Items attached to the ticket. |
data.channel_message[ticket_message][snippet_use_logs][]
|
array of objects (SnippetV2UseLog)
|
* |
Snippets used in this message. |
data.channel_message[ticket_message][date_created]
|
DateTime |
* |
Date when message was created. |
data.channel_message[ticket_message][is_agent_note]
|
boolean |
* |
Is this message agent note? |
data.channel_message[ticket_message][is_hidden]
|
boolean |
* |
Is this message hidden? |
data.channel_message[ticket_message][creation_system]
|
string |
* |
How this message was created. |
data.channel_message[ticket_message][ip_address]
|
string |
* |
An ip address from which message was
sent.
|
data.channel_message[ticket_message][visitor_id]
|
string |
* |
Unique ID of visitor left this
message.
|
data.channel_message[ticket_message][hostname]
|
string |
* |
Host from which message was left.
|
data.channel_message[ticket_message][geo_country]
|
string |
* |
Country message is from (deprecated).
|
data.channel_message[ticket_message][email]
|
string |
* |
The email address the user sent the
email from (gateway messages only).
This is a perm record and doesnt
change even if the user
changes/deletes their email address.
|
data.channel_message[ticket_message][message_hash]
|
string |
* |
An unique hash of message. |
data.channel_message[ticket_message][primary_translation]
|
object (TicketMessageTranslated)
|
* |
The primary translation is the one
sent to the user.
|
data.channel_message[ticket_message][message]
|
string |
* |
The message, will be in HTML! |
data.channel_message[ticket_message][message_full]
|
string |
* |
This is the full message, including
all quotes/cut content. This will
still be the HTMLPurifier'ed content
(so it's safe), it's just the message
before it's been run through the
cutter.
|
data.channel_message[ticket_message][message_raw]
|
string |
* |
This is the full raw message content.
It has not been passed through any
HTML cleaning process.s.
|
data.channel_message[ticket_message][message_source]
|
string |
* |
The message source. |
data.channel_message[ticket_message][message_source_type]
|
string |
* |
The message source type. |
data.channel_message[ticket_message][show_full_hint]
|
boolean |
* |
A hint to say if we should show
message_full by default. We do this
when we detect that the user has
replied to a message inline rather
than above the cut line.
|
data.channel_message[ticket_message][lang_code]
|
string |
* |
The set/detected lang code. |
data.channel_message[ticket_message][email_message_id][]
|
array of objects
(TicketMessageEmailId)
|
* |
|
data.channel_message[ticket_message][ticket_feedback][]
|
array of objects (TicketFeedback)
|
* |
|
data.channel_message[ticket_message][ticket_message_forwards][]
|
array of objects
(TicketMessageForward)
|
* |
|
data.channel_message[ticket_message][channel_message]
|
object (TicketMessageChannelMessage)
|
* |
|
data.channel_message[provider] |
string |
* |
@var string name of the provider from
the ticket-channel service
|
data.channel_message[platform_id]
|
string |
* |
@var string ID of the platform from
the ticket-channel service
|
data.channel_message[channel_id]
|
string |
* |
@var string ID of the channel from the
ticket-channel service
|
data.channel_message[message_id]
|
string |
* |
@var string ID of the message from the
ticket-channel service
|
data.channel_message[message_root_id]
|
string |
* |
@var string ID of the root message
from the ticket-channel service
|
data.channel_message[channel_type]
|
string |
* |
@var string name of the channel type
from the ticket-channel service
|
data.channel_message[message_type]
|
string |
* |
@var string name of the message type
from the ticket-channel service
|
data.channel_message[created_at]
|
DateTime |
* |
@var \DateTime Date when channel
message was created.
|