問い合わせの操作履歴データを取得するAPIに関する詳細
はじめに
このAPIでは、問い合わせ内や問い合わせの詳細画面の各サブタブにて行われたすべての操作に関する詳細データを取得することができます。
リクエスト形式
GET: api/v1/tickets/{問い合わせID}/History
クエリーの各パラメーター
-
from
- int - インデックス番号です。この番号から詳細データを取得します。このキーの値を指定しない場合、初期値は「0」と識別されます。
-
limit
- int - 表示する詳細データの件数です。1から50までの値を指定できます。このキーの値を指定しない場合、初期値は「10」と識別されます。
-
eventFilter
- string - 問い合わせにて行われた操作に基づいて詳細データを抽出するためのキーです。指定可能な値は以下のとおりです：
-
CommentHistory
-
TimeEntryHistory
-
AttachmentHistory
-
ApprovalHistory
-
AssignmentRuleHistory
-
NotificationRuleHistory
-
WorkflowHistory
-
MacroHistory
-
SuperviseHistory
-
SLAHistory
-
BlueprintHistory
-
TaskHistory
-
CallHistory
-
EventHistory
-
agentId
- long - 特定の担当者によって行われた操作に関する詳細データを抽出するためのキーです。指定可能な値は、
Zoho Deskの担当者ID
です。
-
fieldName
- string - 特定の項目における、変更後の値を返すためのキーです。このパラメーターの値は、項目のAPI名である必要があります。
メモ：
APIの1回の実行において、3つすべてのフィルターを含めることができます。3つすべてのフィルターを含める場合、3つすべてのフィルターに一致する履歴データをレスポンスとして返します。
レスポンスの形式
このAPIは、JSONオブジェクトの括弧内のJSON配列をデータとして返します。配列には、新しい時間から順に並べられた履歴データが含まれます。つまり、問い合わせにて行われた最新の操作が先頭に表示されます。以下のテンプレートは、レスポンスのデータ構造の例です。
{
"data"
: [
{
"eventName"
:
"EventNameEnum"
,
"eventTime"
:
"DateTime"
,
"actor"
: {
"id"
:
"Long"
,
"name"
:
"String"
,
"type"
:
"ActorTypeEnum"
},
"source"
:
"SourceEnum"
,
"eventInfo"
: [
{
"propertyName"
:
"String"
,
"propertyValue"
:
"#値の種類は「propertyType」によって異なります"
,
"propertyType"
:
"PropertyTypeEnum"
,
"systemProperty"
:
"boolean"
}
],
"actorInfo"
: [
{
"propertyName"
:
"String"
,
"propertyValue"
:
"#値の種類は「propertyType」によって異なります"
,
"propertyType"
:
"PropertyTypeEnum"
,
"systemProperty"
:
"boolean"
}
]
}
]
}
data
配列内のJSONオブジェクトは、単一の履歴データを表します。上記のテンプレートでは、単一の履歴データとそれに対応する値の種類に関連するすべてのキーが表示されています。こちらでは、キー「
propertyValue
」の値は、列挙定数である「
propertyType
」の値によって異なります。
テンプレートにて使用されているすべてのキーと列挙定数は、以下のとおりです：
eventName
問い合わせにて行われた操作の種類を表すためのキーです。このキーの値は列挙定数であり、対応している値は以下のとおりです：
-
TicketCreated
-
TicketUpdated
-
TicketDeleted
-
TicketRestored
-
TicketCloned
-
TicketMergedMaster
-
TicketSplitParent
-
TicketSplitChild
-
TicketArchived
-
TicketEscalated
-
TicketShared
-
TicketShareModeUpdated
-
TicketShareRevoked
-
ThreadAdded
-
ThreadDeleted
-
ThreadResent
-
CommentAdded
-
CommentEdited
-
CommentDeleted
-
ApprovalSent
-
ApprovalApproved
-
ApprovalRejected
-
FollowersAdded
-
FollowersRemoved
-
TagsAdded
-
TagsRemoved
-
AttachmentAdded
-
AttachmentUpdated
-
AttachmentDeleted
-
AttachmentRestored
-
AttachmentDeletedRB
-
TimeEntryAdded
-
TimeEntryUpdated
-
TimeEntryDeleted
-
TimeEntryRestored
-
SecondaryContactsAdded
-
SecondaryContactsUpdated
-
OvershotDueTime
-
BlueprintApplied
-
BlueprintRevoked
-
BlueprintTransitionPerformed
-
BlueprintStateMoved
-
CustomFunctionExecuted
-
NotificationSent
-
CallAdded
-
CallUpdated
-
CallDeleted
-
CallRestored
-
CallCommentAdded
-
CallCommentEdited
-
CallCommentDeleted
-
CallTimeEntryAdded
-
CallTimeEntryUpdated
-
CallTimeEntryDeleted
-
CallTimeEntryRestored
-
EventAdded
-
EventUpdated
-
EventDeleted
-
EventRestored
-
EventCommentAdded
-
EventCommentEdited
-
EventCommentDeleted
-
EventTimeEntryAdded
-
EventTimeEntryUpdated
-
EventTimeEntryDeleted
-
EventTimeEntryRestored
-
TaskAdded
-
TaskUpdated
-
TaskDeleted
-
TaskRestored
-
TaskCommentAdded
-
TaskCommentEdited
-
TaskCommentDeleted
-
TaskTimeEntryAdded
-
TaskTimeEntryUpdated
-
TaskTimeEntryDeleted
-
TaskTimeEntryRestored
-
BugCreated
-
BugLinked
-
BugDelinked
-
InvoiceCreated
-
EstimateCreated
-
SalesOrderCreated
eventTime
操作が行われた時間を表す値です。
actor
問い合わせにて操作を行ったユーザー、または機能に関する詳細データです。問い合わせでの操作は、サポート担当者、顧客、自動化ルール、Zoho Deskのシステムによって行われたものです。このオブジェクトが含まれるそれぞれのキーは、以下のとおりです：
id
-
操作を行ったユーザーや設定のIDです。場合によっては、この値はnullになります。
name
-
操作を行ったユーザーや設定の名前です。担当者、または顧客によって操作が行われた場合、ユーザーの氏名を返します。自動化ルールによって操作が行われた場合、ルールの名前を返します。Zoho Deskのシステムによって操作が行われた場合、「
DeskSystem
」を値として返します。
type
-
操作を行ったユーザーや設定の種類です。対応している値は以下のとおりです：
-
Agent
-
Contact
-
DirectAssignment
-
RoundRobinAssignment
-
NotificationRule
-
SLA
-
Workflow
-
Macro
-
Supervise
-
Blueprint
-
System
source
操作に関連する情報です。たとえば、問い合わせにスレッドが追加された場合、このキーは、ユーザーがスレッドを追加した際に使用した経路（チャネル）に関する情報を返します。対応している値は以下のとおりです：
-
Email
-
Chat
-
OfflineChat
-
HelpCenter
-
Forum
-
Twitter
-
Facebook
-
FeedbackWidget
-
WebForm
-
CustomChannel
-
Import
-
IncomingResponse
-
CustomerRating
-
Setting
-
LicenseDowngrade
-
ZohoBugTracker
-
Jira
-
ZohoBooks
-
ZohoInvoice
-
ZohoInventory
場合によっては、このキーの値はnullになります。
eventInfo
操作に関連する追加情報です。
eventInfo
の値は、構成要素の種類として
Propertyオブジェクト
を持つJSON配列です。操作に関連する追加情報がない場合は、
eventInfo
の値には何も表示されません。
actorInfo
操作を行ったユーザーや設定に関連する追加情報です。
eventInfo
と同様に、
actorInfo
の値は、構成要素の種類として
Property
オブジェクトを持つJSON配列です。操作を行ったユーザーや設定に関連する追加情報がない場合は、
actorInfo
の値には何も表示されません。
Property
オブジェクトの構造は以下のとおりです：
Propertyオブジェクト
{
"propertyName"
:
"String"
,
"systemProperty"
:
"boolean"
,
"propertyType"
:
"PropertyTypeEnum"
,
"propertyValue"
:
"#「propertyType」によって異なります"
}
Property
オブジェクトには、単一のリソースのプロパティのデータが含まれます。たとえば、1件の問い合わせの項目の値や、1件のコメント内の@メンションです。このオブジェクトにて対応しているキーは、以下のとおりです：
propertyName
- プロパティの名前です。
systemProperty
- プロパティがシステムによって生成されたかどうかを表す真偽値です。カスタム項目は、システムによって生成されたプロパティとは扱われません。
propertyType
- プロパティの種類です。対応している値は以下のとおりです：
|
Propertyの種類
|
Propertyの値の種類
|
|
Text
|
単一の値です。
|
|
TextList
|
構成要素として単一の値のみを含むJSON配列です。
|
|
Enum
|
計算可能な値に対応する文字列です。値は、関連するデータによって異なります。
|
|
Boolean
|
真偽値です。
|
|
Date
|
「yyyy-mm-dd」形式の日付です。
|
|
DateTime
|
時間を表す値です。
|
|
Duration
|
秒数にて期間を表す整数値です。
|
|
Numeric
|
数値です。整数、または小数のいずれかです。
|
|
Entity
|
担当者、顧客、問い合わせ、活動、ブループリントなど、単一の項目を表すJSONオブジェクトです。詳細については、別途以下で説明します。
|
|
EntityList
|
Entity
オブジェクトのJSON配列です。
|
|
PropertyGroup
|
Property
オブジェクトのJSON配列です。
|
|
PropertyGroupList
|
PropertyGroup
配列のJSON配列です。
|
|
ValueTransition
|
項目の更新内容を表すJSONオブジェクトです。詳細については、別途以下で説明します。
|
Entity
Entityオブジェクトの構造は、以下のとおりです：
{
"id": "Long",
"name": "String",
"type": "EntityTypeEnum"
}
id
- 項目のIDです。
name
- 項目の名前です。問い合わせの場合、問い合わせ番号が表示されます。活動の場合、活動の件名が表示されます。
type
-
項目の種類です。この値は列挙定数です。対応している値は以下のとおりです：
-
Agent
-
Contact
-
Department
-
Team
-
Ticket
-
Call
-
Event
-
Task
-
Activity
-
Blueprint
-
Transition
-
Layout
項目が削除され、項目のデータがシステム内に存在しない場合は、削除された項目のデータが表示されます。削除された項目の詳細データは、以下の形式で表示されます：
{
"id"
:
"Long/null"
,
"name"
:
"DELETED-ENTITY"
,
"type"
:
"EntityTypeEnum-Deleted"
}
以下は、削除されたチームの詳細データの例です。
{
"id"
:
"57890890789568"
,
"name"
:
"DELETED-ENTITY"
,
"type"
:
"Team-Deleted"
}
メモ：活動が削除された場合、活動の正確な種類は識別されません。そのため、種類は単に「Activity」として表示されます。活動が削除されていない場合は、活動の正確な種類が表示されます。
ValueTransition
このオブジェクトは、項目の更新内容に関連する情報を返します。このオブジェクトの構造は、以下のとおりです：
{
"previousValue"
:
"#「type」によってデータの種類が異なります"
,
"updatedValue"
:
"#「type」によってデータの種類が異なります"
,
"type"
:
"ValueTransitonTypeEnum"
}
previousValue
と
updatedValue
のキーの値は、常に同じデータの種類になります。種類の値は、
type
のキーによって異なります。
PropertyGroup
、
PropertyGroupList
、
ValueTransition
を除くプロパティの種類は、すべて遷移の値に対応しています。
対応している履歴のイベントの一覧や、それぞれのイベントの表示方法については、
こちらのドキュメント
をご参照ください。
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?