この記事では、LiveAgent MCPサーバーが提供するツールについて説明します。各ツールが受け付ける正確なパラメータと、返す正確なフィールドを含みます。個人用MCP接続では、そのエージェントのロールが権限を持つすべてのツールが提供されますが、AIエージェントMCP接続では、そのAIエージェント用に選択されたツールのみが提供されます。

すべてのツールは単一のJSONオブジェクトを返します。成功した呼び出しはドキュメント化されたレスポンスを返し、何も返すものがないツールは{"success": true}で応答します。失敗または拒否された呼び出しはエラーオブジェクトを返します。例：{"success": false, "error": "Not authorized to read this ticket"}または{"code": -32602, "message": "Tool is not available on this account: reply_via_whatsapp"}。これは通常、ツールがAIエージェントに対して有効化されていない場合、エージェントのロールがそのツールに必要な権限を持っていない場合、ツールがそのアカウントで利用できない場合、使用制限に達した場合などに発生します。

読み取り専用ツール

これらのツールは、何も変更することなくチケット、アカウントデータ、ナレッジベースコンテンツを検索します。

チケット検索（search_tickets）

指定されたフィルターに一致するチケットを、最近変更されたものから順に取得します。各呼び出しはデフォルトで最大10件のチケットを返し、limitで最大50件まで指定できます — 残りはnextCursorでページングして取得します。

パラメータ

パラメータ 必須 説明
status いいえ 選択されたステータスのチケットのみを返します：new、open、answered、resolved、postponed、chatting、calling。複数のステータスを組み合わせることができます。省略した場合、削除済み、クローズ済み、スパムチケットを除くすべてのチケットが返されます。
departmentId いいえ list_departmentsで返される、選択された部門のチケットのみを返します。省略した場合、すべての部門のチケットが返されます。
agentId いいえ list_agentsで返される、選択されたエージェントに割り当てられたチケットのみを返します。省略した場合、割り当ての有無にかかわらず、すべてのエージェントのチケットが返されます。
query いいえ このフルテキストフレーズに一致する内容のチケットのみを返します。省略した場合、テキストマッチングは適用されません。
limit いいえ 返すチケットの最大数。デフォルトは10、最大50まで指定可能です。それより大きい値は拒否されるのではなく、黙って50に減らされます。
cursor いいえ 前回の呼び出しが返したnextCursorを渡すことで、そこから続きを取得します。省略した場合、最初のページが返されます。

戻り値

フィールド 説明
tickets[].id 内部チケットID — 他のチケットツールがticketIdとして期待するものです。
tickets[].code 人間が読みやすい短いチケットコード（例：ABC-DEFGH-123）。通常、エージェントパネルに表示されます。
tickets[].subject チケットの件名。
tickets[].status 現在のチケットステータス。statusフィルターが受け付ける値のいずれか、またはstatusフィルターが指定されていない場合はinit。closed、deleted、spamステータスのチケットは決して返されません。
tickets[].departmentId チケットが属する部門のID。
tickets[].assignedAgentId チケットが割り当てられているエージェントのID。チケットが未割り当ての場合はnull。
totalCount このページだけでなく、一致したチケットの総数。
nextCursor 次のページを参照するカーソル — そのページを取得するにはcursorとして渡します。これ以上チケットがない場合はnull。

注意事項：

  • 日付、タグ、顧客、チャネルによるフィルターはなく、ソート順も変更できません。タグ、チャネル、日付で結果を絞り込むには、各チケットをget_ticket_metadataで確認してください。これはtags、channel、createdAt、lastActivityAtを返します。
  • 部門と割り当てられたエージェントはIDのみで返されます — 名前を調べるにはlist_departmentsとlist_agentsを使用してください。

チケットメタデータの取得（get_ticket_metadata）

チケットのプロパティ：ステータス、チャネル、部門、割り当て、タグ、タイムスタンプを取得します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値

フィールド 説明
id 内部チケットID。
code 人間が読みやすい短いチケットコード（例：ABC-DEFGH-123）。通常、エージェントパネルに表示されます。
subject チケットの件名。
status 現在のチケットステータス：new、open、answered、resolved、postponed、chatting、calling、closed、deleted、spam、またはinit。
channel チケットが作成されたチャネル：email、contact_button、contact_form、invitation、call、call_button、facebook、facebook_message、twitter、forum、suggestion、instagram、instagram_mention、viber、whatsapp、またはtelegram。チャネルが記録されていない場合はnull。
departmentId チケットが属する部門のID。
departmentName チケットが属する部門の名前。
assignedAgentId チケットが割り当てられているエージェントのID。チケットが未割り当ての場合はnull。
assignedAgentName 割り当てられたエージェントの表示名。チケットが未割り当ての場合はnull。
tags チケットに現在付与されているタグの名前。
createdAt チケットが作成された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。
lastActivityAt チケットが最後に変更された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。

チケットメッセージの取得（get_ticket_messages）

デフォルトで内部ノートを含む、チケットのメッセージを取得します。各呼び出しは最大20件のメッセージを返します — 残りはnextCursorでページングして取得します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
since いいえ 前回の呼び出しが返したnextCursorを渡すことで、そこから続きを取得します。省略した場合、最初のページが返されます：最新のメッセージ、またはorderがascの場合は最も古いもの。
types いいえ 選択された種類のメッセージのみを返します：email、chat、whatsapp、instant_message、note、またはlegacy_message。省略した場合、ノートを含むすべての種類のメッセージが返されます。
dateFrom いいえ この時刻以降に追加されたメッセージのみを返します（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00Z）。省略した場合、下限時刻はありません。
dateTo いいえ この時刻以前に追加されたメッセージのみを返します（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00Z）。省略した場合、上限時刻はありません。dateFromより早いdateToは拒否されます。
order いいえ メッセージを追加された順にソートします：descは最新を最初に、ascは最も古いものを最初にリストします。デフォルトはdescです。sinceを使用する場合、カーソルは独自の順序を保持し、矛盾するorderは拒否されます。

戻り値

フィールド 説明
messages[].id メッセージID。
messages[].text プレーンテキストとしてのメッセージ本文。
messages[].author メッセージを追加した人：agent、customer、ai_agent、rule、またはexternal_app。
messages[].authorId 作成者のID。
messages[].type メッセージの種類：email、chat、whatsapp、instant_message、note、またはlegacy_message。
messages[].createdAt メッセージが追加された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。
messages[].attachments[] メッセージの添付ファイル。それぞれid、fileName、contentType、size（バイト）、downloadUrlを持ちます。ファイルの内容自体は結果に含まれません。downloadUrlは1回限り使用可能なリンクで、最初のダウンロード成功後、または3時間後に無効になります — 新しいリンクを取得するにはツールを再度呼び出してください。
messages[].recipients メッセージのメールアドレス情報：from、to、cc、replyToを持つオブジェクトで、fromは単一のアドレスで、他はそれぞれnameとemailを持つアドレスのリストです。email以外のメッセージ種類ではnullです。fromがnullであったり、リストが空であることは、アドレスがメッセージに記録されなかったことを意味し、アドレスが存在しなかったことを意味するわけではありません。Bccアドレスは決して返されません。
nextCursor 最後に返されたメッセージを参照するカーソル — 次のページを取得するにはsinceとして渡します。ページに何らかのメッセージがある限り（最後のページを含む）設定されるため、呼び出しが空のmessagesリストとここでnullを返したときに終端に達したことになります。

チケットノートの取得（get_ticket_notes）

チケットの内部ノートを、最新のものから順に取得します。各呼び出しは最大20件のノートを返します — 残りはnextCursorでページングして取得します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
since いいえ 前回の呼び出しが返したnextCursorを渡すことで、そこから続きを取得します。省略した場合、最初のページ（最新のノート）が返されます。

戻り値

フィールド 説明
notes[].noteId ノートID。
notes[].text プレーンテキストとしてのノート本文。
notes[].author.id 作成者のID。
notes[].author.name 作成者の表示名。
notes[].author.type ノートを追加した人：agent、ai_agent、rule、またはexternal_app。
notes[].createdAt ノートが追加された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。
nextCursor 最後に返されたノートを参照するカーソル — 次のページを取得するにはsinceとして渡します。ページに何らかのノートがある限り（最後のページを含む）設定されるため、呼び出しが空のnotesリストとここでnullを返したときに終端に達したことになります。

チケット概要の取得（get_ticket_summary）

チケットのAI生成概要を取得します。このツールはAIエージェント用に選択できないため、個人用MCP接続でのみ利用可能です。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値

フィールド 説明
summary プレーンテキストとしての概要。チケットにまだ概要がない場合はnull。
generatedAt 概要が最後に生成された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。チケットにまだ概要がない場合はnull。

タグの取得（get_tags）

アカウント内のすべてのタグを一覧表示します。

パラメータ： なし。

戻り値

フィールド 説明
tags[].id タグID（4文字の英数字コード） — これがadd_tags_to_ticketとremove_tags_from_ticketがtagsに期待するものです（タグ名とともに）。
tags[].name エージェントパネルに表示されるタグ名。
tags[].isPublic タグがエージェントパネル外で表示されるかどうかを示します：公開タグの場合はtrue、内部タグの場合はfalse。

チケットフィールド定義の取得（get_ticket_field_definitions）

アカウントに設定されたカスタムチケットフィールドを、正しく入力するために必要なメタデータとともに一覧表示します。アーカイブされた定義は除外されます。

パラメータ： なし。

戻り値

フィールド 説明
definitions[].definitionId 数値の定義ID — これがset_ticket_field_valueがdefinitionIdとして期待するものです。
definitions[].code フィールドの安定した文字列コード — これがset_ticket_field_valueが数値IDの代わりにdefinitionCodeとして期待するものです。
definitions[].name エージェントパネルに表示されるフィールドラベル。
definitions[].type フィールドタイプ。書き込み時に使用する値パラメータを決定します：BOOLEAN、STRING、POSTAL_ADDRESS、LIST_SINGLE_VALUED、またはLIST_MULTI_VALUED。
definitions[].description フィールドに設定されたヘルプテキスト。エージェントパネルでその横に表示されます。設定されていない場合は空の文字列。
definitions[].checkboxDescription チェックボックスの横に表示されるラベル。BOOLEAN定義のみに存在します。
definitions[].validation 値が満たすべきルール。STRING定義のみに存在します。{"kind": "PREDEFINED", "format": …}（ALPHANUMERIC、ALPHANUMERIC_SPACE、DATE、DATE_REVERSE、DECIMAL、EMAIL、WHOLE_NUMBER、NUMERIC_STRING、INTERNATIONAL_PHONE、US_PHONE、IP_ADDRESS、TEXT、TIME、URLのいずれか）、または独自の正規表現を持つ{"kind": "CUSTOM", "regex": …}のいずれかです。
definitions[].availableValues 値を選択できるオプションラベル。LIST_SINGLE_VALUEDとLIST_MULTI_VALUED定義のみに存在します。

チケットフィールド値の取得（get_ticket_field_values）

1つのチケットに保存されているすべてのカスタムフィールド値を、それぞれの定義メタデータとともに取得します。定義がアーカイブされている値も返されます。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値

フィールド 説明
values[].fieldId この保存された値のID — これがdelete_ticket_field_valueがfieldIdとして期待するものです。
values[].definitionId この値が属する定義の数値ID。
values[].code この値が属する定義の文字列コード。
values[].name エージェントパネルに表示されるフィールドラベル。
values[].type フィールドタイプ。get_ticket_field_definitionsと同じ値を使用します。
values[].value 保存された値。フィールドに応じて型が異なります：BOOLEANの場合はブール値；STRINGとLIST_SINGLE_VALUEDの場合は文字列；LIST_MULTI_VALUEDの場合は文字列の配列；POSTAL_ADDRESSの場合はstreet、district、city、state、postalCode、countryを持つオブジェクト。

エージェント一覧（list_agents）

アカウント内のエージェントを一覧表示します。assign_ticket用のエージェントIDを見つけたり、assignedAgentIdを名前とメールアドレスに変換したりするために使用します。

パラメータ

パラメータ 必須 説明
search いいえ 名前またはメールアドレスにこのテキストを含むエージェントのみを返します。省略した場合、すべてのエージェントが返されます。

戻り値

フィールド 説明
agents[].id エージェントID — これがassign_ticketがagentIdとして期待するものです。
agents[].name エージェントの表示名。
agents[].email エージェントのメールアドレス。エージェントがメールアドレスを持たない場合はnull。

部門一覧（list_departments）

アカウント内の部門を一覧表示します。transfer_ticket用の部門IDを見つけたり、departmentIdを名前に変換したりするために使用します。

パラメータ

パラメータ 必須 説明
search いいえ 名前にこのテキストを含む部門のみを返します。省略した場合、すべての部門が返されます。

戻り値

フィールド 説明
departments[].id 部門ID — これがtransfer_ticketがdepartmentIdとして期待するものです。
departments[].name 部門名。

ナレッジベース一覧（list_knowledge_bases）

アカウント内のナレッジベースを一覧表示します。どのナレッジベースツールもデフォルトのナレッジベースを前提としていないため、ここから始めて、ここで取得したknowledgeBaseIdを渡してください。

パラメータ： なし。

戻り値

フィールド 説明
knowledgeBases[].id ナレッジベースID — これが他のナレッジベースツールがknowledgeBaseIdとして期待するものです。
knowledgeBases[].name ナレッジベース名。
knowledgeBases[].isActive ナレッジベースが有効かどうかを示します：有効な場合はtrue、無効化されている場合はfalse。

ナレッジベースカテゴリ一覧（list_kb_categories）

ナレッジベースのカテゴリをネストされたツリーとして一覧表示します — 親カテゴリが指定された場合はそのサブツリー全体、指定されない場合はナレッジベース全体です。

パラメータ

パラメータ 必須 説明
knowledgeBaseId はい 読み込むナレッジベースのID。list_knowledge_basesで返されます。
parentCategoryId いいえ このカテゴリの下のサブツリーのみを返します。list_kb_categoriesで返されます。省略した場合、または0の場合、ツリー全体が返されます。

戻り値

フィールド 説明
categories[].id カテゴリID — これが他のナレッジベースツールがcategoryIdまたはparentCategoryIdとして期待するものです。
categories[].name カテゴリ名。
categories[].parentCategoryId 親カテゴリのID。ルートレベルのカテゴリの場合は0。
categories[].visibility カテゴリを見ることができる人：publicまたはinternal。
categories[].position 兄弟要素間での0から始まる位置。
categories[].children[] 子カテゴリ。それぞれ同じフィールドを持ちます。
count 子要素を含む、返されたカテゴリの総数。

ナレッジベース記事の検索（search_kb_articles）

キーワードまたはフレーズに一致する記事をナレッジベースから検索します — 顧客の質問に答える記事を見つけたり、すでに記事が存在するかどうかを確認したりするために使用します。各呼び出しはデフォルトで最大10件の記事を返し、limitで最大50件まで指定できますが、それ以上ページングする方法はありません。

パラメータ

パラメータ 必須 説明
query はい タイトルまたは内容がこのキーワードまたはフレーズに一致する記事のみを返します。
knowledgeBaseId はい 検索対象のナレッジベースのID。list_knowledge_basesで返されます。
categoryId いいえ このカテゴリとそのサブカテゴリ内の記事のみを返します。list_kb_categoriesで返されます。省略した場合、ナレッジベース全体が検索されます。
limit いいえ 返す記事の最大数。デフォルトは10、最大50まで指定可能です。それより大きい値は拒否されるのではなく、黙って50に減らされます。

戻り値

フィールド 説明
articles[].id 記事ID — これがget_kb_articleとupdate_kb_articleがarticleIdとして期待するものです。
articles[].title 記事タイトル。
articles[].url 公開記事URL。
articles[].summary プレーンテキストとしての記事の冒頭部分。最大300文字で単語境界で切られ、それより長い場合は省略記号で終わります。
articles[].description 検索エンジンの検索結果に表示されるメタディスクリプション。
articles[].categoryId 記事が配置されているカテゴリのID。
articles[].knowledgeBaseId 記事が属するナレッジベースのID。
articles[].status 公開状態：publishedまたはdraft。
articles[].visibility 記事を見ることができる人：publicまたはinternal。

注： 記事の全文は返されません — get_kb_articleで取得してください。

ナレッジベース記事の取得（get_kb_article）

記事の全文内容を、記事IDまたはそのURLの6桁コードで取得します。

パラメータ

パラメータ 必須 説明
articleId いずれか一方 読み込む記事のID。search_kb_articlesで返されます。これまたはurlCodeのいずれかを指定してください。両方指定された場合、articleIdが使用されます。
urlCode 記事URL内の6桁コード。例：.../397021-article-titleにおける397021。

戻り値

フィールド 説明
id 記事ID — これがupdate_kb_articleがarticleIdとして期待するものです。
title 記事タイトル。
url 公開記事URL。
body HTMLとしての記事の全文。
plainText プレーンテキストとしての同じ本文内容。
description 検索エンジンの検索結果に表示されるメタディスクリプション。
keywords 記事に設定されたメタキーワード。
categoryId 記事が配置されているカテゴリのID。
knowledgeBaseId 記事が属するナレッジベースのID。
status 公開状態：publishedまたはdraft。
visibility 記事を見ることができる人：publicまたはinternal。
position そのカテゴリ内での0から始まる位置。
createdAt 記事が作成された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。
changedAt 記事が最後に変更された日時（RFC 3339形式のタイムスタンプ、例：2026-07-08T10:00:00+00:00）。
attachments[] 記事の添付ファイル。それぞれid、fileName、contentType、size（バイト）、isInline、downloadUrlを持ちます。isInlineは本文に埋め込まれた画像の場合はtrueです。ファイルの内容自体は結果に含まれません。downloadUrlは1回限り使用可能なリンクで、最初のダウンロード成功後、または3時間後に無効になります — 新しいリンクを取得するにはツールを再度呼び出してください。

書き込み・管理ツール

これらのツールはチケットやナレッジベースを変更したり、顧客に返信を送信したりします。

メールで返信（reply_via_email）

メールで対応しているチケットの顧客に対してメール返信を送信します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。チケットのchannelは、email、contact_button、contact_form、invitation、call、call_buttonのいずれかでなければなりません — これらはエージェントパネルがメール返信ボックスから対応するチャネルです。それ以外のチャネル、または記録されたチャネルがないチケットは拒否されます。
text はい 顧客に送信される返信本文。formatがhtmlでない限り、プレーンテキストとして扱われます。
format いいえ textを選択した形式で送信します：plainはプレーンテキスト、htmlはHTML本文です。デフォルトはplainです。textが実際にHTMLマークアップである場合にのみhtmlを使用してください。解析できない本文は、キューに入れられる前に拒否されます。
subject いいえ 返信の件名として送信するテキスト。最大255文字。より長い件名は拒否されるのではなく、黙って255文字に短縮されます。省略した場合、返信はエージェントパネルの返信ボックスがそのチケットに事前入力する件名を使用します。
to いいえ これらのメールアドレスに返信を送信します。指定されたとおりに使用されます。省略した場合、返信はエージェントパネルのReply（返信）ボタンが使用するのと同じ宛先に送信されます。
cc いいえ これらのメールアドレスに返信をCcします。toが省略されている場合でも、指定されたとおりに使用されます。すでにtoにあるアドレスはCcから除外されます。省略した場合、返信にCcはありません。

戻り値

フィールド 説明
answerId 配信のためにキューに入れられた返信のID。

注意事項：

  • 削除済みおよびクローズ済みのチケットは拒否されます。解決済みのチケットは、アカウントが解決済みチケットへの新しい返信による再オープンを許可しない限り、受け付けられます。
  • toが省略された場合、チケットには返信先となるメールスレッドまたは作成者のメールアドレスが必要です。そのどちらもないチケット（通常は電話）は、toを指定するまで拒否されます。
  • すべてのアドレスは有効なメールアドレスでなければならず、宛先の総数はアカウントの宛先数制限によって上限が設定されます。
  • 添付ファイルはサポートされておらず、Bccや別の送信者もサポートされていません — 返信はLiveAgentがそのチケット用に選択する送信メールアカウントから送信されます。
  • 成功した結果は、返信が保存され、キューに入れられたことを意味します。実際の配信はその後に行われ、その結果はこのツールでは報告されません。
  • AIエージェントの場合、このツールはそのランが開始されたチケットにロックされているため、search_ticketsで見つかった別のチケットに返信することはできません。返信の送信はランを終了しません。

WhatsAppで返信（reply_via_whatsapp）

WhatsAppチケットの顧客にテキスト返信を送信します。このツールは、WhatsApp連携が有効になっているアカウントでのみ利用可能です。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。チケットのchannelはwhatsappでなければなりません。それ以外のチャネルは拒否されます。
text はい 顧客に送信される返信テキスト。WhatsAppはメッセージの最大長を強制します。長すぎる返信は、制限を示すエラーとともに拒否されます。

戻り値

フィールド 説明
messageId 配信のためにキューに入れられた返信のID。

注意事項：

  • 返信は24時間のWhatsAppカスタマーサービスウィンドウ内に収まる必要があります — つまり、顧客の最後のメッセージから24時間以内です。それを過ぎると、呼び出しは失敗し、代替手段として、人間のエージェントによる承認済みWhatsAppテンプレートの送信、または内部ノートの使用があります。
  • 添付ファイルはサポートされていません — 返信はテキストのみです。
  • 成功した結果は、返信が保存され、キューに入れられたことを意味します。WhatsAppへの実際の配信はその後に行われ、その結果はこのツールでは報告されません。
  • AIエージェントの場合、このツールはそのランが開始されたチケットにロックされているため、search_ticketsで見つかった別のチケットに返信することはできません。返信の送信はランを終了しません。

ノートの追加（add_note）

チケットに内部ノートを追加します。ノートはエージェントにのみ表示され、顧客には決して表示されません。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
text はい 保存するノート本文（プレーンテキスト）。
reopenTicket いいえ チケットがすでに解決済みの場合に再オープンします。デフォルトはfalseで、解決済みのチケットは解決済みのままです。

戻り値

フィールド 説明
noteId 作成されたノートのID。

注： このツールでは添付ファイルを追加できません。

チケットへのタグの追加（add_tags_to_ticket）

1つ以上の既存のタグをチケットに追加します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
tags はい get_tagsで返される、1つ以上のタグID（4文字の英数字）またはタグ名。不明なタグは拒否されます — このツールはタグを作成しません。

戻り値： {"success": true}。

チケットからのタグの削除（remove_tags_from_ticket）

チケットから1つ以上のタグを削除します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
tags はい add_tags_to_ticketが受け付けるのと同じ形式で、削除する1つ以上のタグIDまたはタグ名。不明なタグは拒否されます。

戻り値： {"success": true}。

チケットフィールド値の設定（set_ticket_field_value）

チケットの1つのカスタムフィールド値を設定します：値が存在しない場合は作成し、異なる場合は更新し、すでに一致している場合は変更しません。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
definitionId いずれか一方 get_ticket_field_definitionsで返される数値の定義ID。これまたはdefinitionCodeのいずれかを指定してください — 両方を指定することも、どちらも指定しないこともできません。
definitionCode get_ticket_field_definitionsで返される、フィールドの安定した文字列コード。
booleanValue いずれか1つ BOOLEANフィールドに保存する値：trueまたはfalse。
stringValue STRINGフィールドに保存する値。最大255文字。より長い値は拒否されます。また、定義のvalidationルールを満たす必要があります。
singleValue LIST_SINGLE_VALUEDフィールドに保存する値：定義のavailableValuesからの1つのラベル。
multiValue LIST_MULTI_VALUEDフィールドに保存する値：定義のavailableValuesからの任意の数のラベル。
postalAddress POSTAL_ADDRESSフィールドに保存する値：street、district、city、state、postalCode、countryのキーを持つオブジェクト。

戻り値

フィールド 説明
fieldId 保存された値のID — これがdelete_ticket_field_valueがfieldIdとして期待するものです。
action 呼び出しが行ったこと：created、updated、またはunchanged。

注意事項：

  • 値パラメータはフィールドの型と一致している必要があります — 別の型用の値パラメータは拒否されます。
  • アーカイブされた定義は拒否されます。
  • チケットに同じ定義に対する複数の値が保存されている場合、呼び出しは失敗し、まずdelete_ticket_field_valueで余分な値を削除するよう求められます。

チケットフィールド値の削除（delete_ticket_field_value）

チケットから保存された1つのカスタムフィールド値を削除します。フィールドの定義がアーカイブされている場合でも機能します。

パラメータ

パラメータ 必須 説明
fieldId はい get_ticket_field_valuesで返される、削除する保存された値のID。これは値自体のIDであり、定義IDではありません。

戻り値

フィールド 説明
fieldId 削除された値のID。

チケットの割り当て（assign_ticket）

チケットをエージェントに割り当てる、または割り当てを解除します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
agentId はい list_agentsで返される、チケットを割り当てるエージェントのID。必ず指定する必要がありますが、割り当てを解除するためにnullを指定することもできます。

戻り値： {"success": true}。

チケットの転送（transfer_ticket）

チケットを別の部門に移動します。reopenTicketがtrueでない限り、チケットは割り当てられたエージェントを保持します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。
departmentId はい list_departmentsで返される、チケットを移動する部門のID。
reopenTicket いいえ 転送後にチケットを再オープンし、割り当てられたエージェントをクリアします。デフォルトはfalseで、解決済みのチケットは解決済みのままで、割り当てられたエージェントを保持します。チケットが再オープンできないステータスであっても、エージェントはクリアされ、転送は成功します。

戻り値： {"success": true}。

注： AIエージェントの場合、これは最終アクションです — 転送が成功するとランは終了するため、タグやノートを先に追加してください。

チケットの解決（resolve_ticket）

チケットを解決済みとしてマークします。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値： {"success": true}。

注： AIエージェントの場合、これは最終アクションです — チケットが解決するとランは終了するため、タグやノートを先に追加してください。

チケットの再オープン（reopen_ticket）

解決済みのチケットを再オープンします。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値： {"success": true}、または再オープンするものがない場合は{"success": false, "error": "Ticket is already open"}。

スパムとしてマーク（mark_as_spam）

チケットをスパムとしてマークします。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値： {"success": true}、またはチケットがすでにスパムだった場合は{"note": "Ticket was already marked as spam"}。

注： AIエージェントの場合、これは最終アクションです — チケットがスパムとしてマークされると（すでにそうだった場合も含めて）ランは終了するため、タグやノートを先に追加してください。

スパムではないとしてマーク（mark_as_not_spam）

チケットからスパムマークを解除し、チケットをキューに戻します。

パラメータ

パラメータ 必須 説明
ticketId はい チケットID（例：1a2b3c4d）。

戻り値： {"success": true}、またはチケットがスパムでなかった場合は{"note": "Ticket was already not marked as spam"}。

注： mark_as_spamとは異なり、これは最終アクションではありません — AIエージェントのランはこの後も継続します。

ナレッジベース記事の作成（create_kb_article）

ナレッジベースカテゴリに記事を作成します。

パラメータ

パラメータ 必須 説明
title はい 新しい記事のタイトル。最大255文字。より長いタイトルは拒否されます。
body はい 新しい記事の本文（HTML）。
categoryId はい list_kb_categoriesで返される、記事を配置するカテゴリのID。
knowledgeBaseId はい list_knowledge_basesで返される、記事を作成するナレッジベースのID。
status はい 新しい記事の公開状態：publishedまたはdraft。
visibility はい 新しい記事を見ることができる人：publicまたはinternal。
description いいえ 検索エンジンの検索結果に表示される、新しい記事のメタディスクリプション。省略した場合、記事にメタディスクリプションはありません。
keywords いいえ 新しい記事のメタキーワード。省略した場合、記事にメタキーワードはありません。
position いいえ そのカテゴリ内での新しい記事の0から始まる位置。省略した場合、記事は最初に配置されます。

戻り値

フィールド 説明
articleId 作成された記事のID — これがget_kb_articleとupdate_kb_articleがarticleIdとして期待するものです。
message 記事のタイトルとステータスを示す確認テキスト。

注： このツールでは添付ファイルをアップロードできません。HTML本文内にインラインで参照された画像は、本文自体から取得されます。

ナレッジベース記事の更新（update_kb_article）

既存の記事を変更します。指定したパラメータのみが変更され、それ以外は現在の値を保持します。

パラメータ

パラメータ 必須 説明
articleId はい search_kb_articlesで返される、更新する記事のID。
title いいえ タイトルを置き換えます。最大255文字。より長いタイトルは拒否されます。
body いいえ このHTMLで本文を置き換えます。
status いいえ 公開状態を変更します：publishedまたはdraft。
visibility いいえ 記事を見ることができる人を変更します：publicまたはinternal。
description いいえ メタディスクリプションを置き換えます。クリアするには空の文字列を渡してください。
keywords いいえ メタキーワードを置き換えます。クリアするには空の文字列を渡してください。
categoryId いいえ list_kb_categoriesで返される、記事をこのカテゴリに移動します。positionも指定されない限り、記事はそのカテゴリ内で最初に配置されます。省略した場合、記事はそのままです。
knowledgeBaseId いいえ 指定する場合、記事の現在のナレッジベースと一致している必要があります — ナレッジベース間での記事の移動はサポートされていません。
position いいえ そのカテゴリ内で、記事をこの0から始まる位置に移動します。

戻り値

フィールド 説明
message 更新された記事のIDを示す確認テキスト。

ナレッジベースカテゴリの作成（create_kb_category）

ナレッジベースにカテゴリを作成します。ルートレベル、または親カテゴリの下に作成できます。

パラメータ

パラメータ 必須 説明
name はい 新しいカテゴリの名前。最大255文字。より長い名前は拒否されます。
knowledgeBaseId はい list_knowledge_basesで返される、カテゴリを作成するナレッジベースのID。
visibility はい 新しいカテゴリを見ることができる人：publicまたはinternal。
parentCategoryId いいえ list_kb_categoriesで返される、親カテゴリのID。省略した場合、カテゴリはルートレベルに作成されます。
keywords いいえ 新しいカテゴリのメタキーワード。省略した場合、カテゴリにメタキーワードはありません。
position いいえ 兄弟要素間での新しいカテゴリの0から始まる位置。省略した場合、カテゴリは最初に配置されます。

戻り値

フィールド 説明
categoryId 作成されたカテゴリのID — これが他のナレッジベースツールがcategoryIdまたはparentCategoryIdとして期待するものです。
message 作成されたカテゴリの名前を示す確認テキスト。

ナレッジベースカテゴリの更新（update_kb_category）

カテゴリの名前変更、移動、並べ替えを行ったり、可視性やキーワードを変更したりします。指定したパラメータのみが変更され、それ以外は現在の値を保持します。

パラメータ

パラメータ 必須 説明
categoryId はい list_kb_categoriesで返される、更新するカテゴリのID。
name いいえ カテゴリの名前を変更します。最大255文字。より長い名前は拒否されます。
visibility いいえ カテゴリを見ることができる人を変更します：publicまたはinternal。
keywords いいえ メタキーワードを置き換えます。クリアするには空の文字列を渡してください。
parentCategoryId いいえ list_kb_categoriesで返される、このカテゴリをこの親の下に移動します。または0でルートレベルに移動します。positionも指定されない限り、カテゴリは新しい兄弟要素の中で最初に配置されます。カテゴリをそれ自体またはその子孫の下に移動することは拒否されます。
knowledgeBaseId いいえ 指定する場合、カテゴリの現在のナレッジベースと一致している必要があります — ナレッジベース間でのカテゴリの移動はサポートされていません。
position いいえ 兄弟要素間で、カテゴリをこの0から始まる位置に移動します。

戻り値

フィールド 説明
message 更新されたカテゴリの名前を示す確認テキスト。

関連記事