On this page
フィルタリング API v3 GET /tickets の結果
取得したチケットの一覧をフィルタリングするには、エージェントパネルで利用可能なフィルターのみを使用できます。
一部のフィルター(例:{"subject":"order"})は、期待とは少し異なる動作をします。「subjectがorderに等しい」ではなく「subjectがorderを含む」として検索されるため、subjectに"order"という単語を含むすべてのチケットが検索されます。例えば、“Order #123”、“Order #456”、“Order-inquiry"などのsubjectを持つチケットが該当します。
また、searchパラメーターを使用してチケットの全文検索を行うことも可能です。エージェントパネルでの検索と同じ方法で、例えば _filters={"search":"order"} や _filters=[["search","L","invoice"]] のように使用します。searchパラメーターは、チケットのオーナーの詳細、subject、本文、およびカスタムフィールドで指定した値を検索します。
利用可能な演算子と日付範囲の説明については、こちらの記事をご覧ください。
パラメーター id、code、owner_email、owner_name、last_activity_public、public_access_urlcode はフィルタリングに使用できません。
| GET /tickets API v3 で利用可能なフィルター | ||
|---|---|---|
| パラメーター | 利用可能な演算子 | 使用例 |
| status | E IN NI | {"status":"C"} [["status","E","C"]] [["status",IN","N,C"]] [["status","NI","L,X,B"]] |
| tags | E L CY NI IE INE | [["tags","E","fqr2,25pr"]] [["tags","L","fqr2,25pr"]] [["tags","CY","fqr2,25pr"]] [["tags","NI","fqr2,25pr"]] [["tags","IE",""]] [["tags","INE",""]] |
| channel_type | E IN | {"channel_type":"E"} [["channel_type","E","E"]] [["channel_type","IN","V,1"]] |
| subject | E IN | {"subject":"invoice"} [["subject","E","invoice"]] [["subject","IN","shipping,invoice"]] |
| owner_contactid | E IN | {"owner_contactid":"gv6dy7vk"} [["owner_contactid","E","gv6dy7vk"]] [["owner_contactid","IN","gv6dy7vk,upz575s4"]] |
| agentid | IN | [["agentid","IN","54jhzz7z"]] |
| departmentid | E IN NI | {"departmentid":"default"} [["departmentid","E","zbmc7d61"]] [["departmentid","IN","default,zbmc7d61"]] [["departmentid","NI","default"]] |
| date_created | D> D< D>= D<= DP | [["date_created","D>","2025-01-01 00:0:00"]] [["date_created","D<","2025-01-01 00:0:00"]] [["date_created","D>=","2025-01-01 00:0:00"]] [["date_created","D<=","2025-01-01 00:0:00"]] [["date_created","DP","Y"]] |
| date_changed | D> D< D>= D<= DP | [["date_changed","D>","2025-01-01 00:0:00"]] [["date_changed","D<","2025-01-01 00:0:00"]] [["date_changed","D>=","2025-01-01 00:0:00"]] [["date_changed","D<=","2025-01-01 00:0:00"]] [["date_changed","DP","Y"]] |
| date_resolved | D> D< D>= D<= DP | [["date_resolved","D>","2025-01-01 00:0:00"]] [["date_resolved","D<","2025-01-01 00:0:00"]] [["date_resolved","D>=","2025-01-01 00:0:00"]] [["date_resolved","D<=","2025-01-01 00:0:00"]] [["date_resolved","DP","Y"]] |
| last_activity | D> D< D>= D<= DP | [["last_activity","D>","2025-01-01 00:0:00"]] [["last_activity","D<","2025-01-01 00:0:00"]] [["last_activity","D>=","2025-01-01 00:0:00"]] [["last_activity","D<=","2025-01-01 00:0:00"]] [["last_activity","DP","Y"]] |
| カスタムフィールド | E NE L NL | [["field_player_id","E","007"]] [["field_player_id","NE","007"]] [["field_player_id","L","007"]] [["field_player_id","NL","007"]] |
また、APIリクエストのレスポンスには返されませんが、チケット一覧の結果をフィルタリングする際に使用できる追加パラメーターもあります。
| GET /tickets API v3 で利用可能な追加フィルター | |||
|---|---|---|---|
| 条件の説明 | パラメーター | 利用可能な演算子 | 使用例 |
| メッセージが追加された日時 | m_datecreated | D> D< D>= D<= DP | [["m_datecreated","D>","2025-01-01 00:0:00"]] [["m_datecreated","D<","2025-01-01 00:0:00"]] [["m_datecreated","D>=","2025-01-01 00:0:00"]] [["m_datecreated","D<=","2025-01-01 00:0:00"]] [["m_datecreated","DP","Y"]] |
| エージェントが追加したメッセージ | m_userid | IN | [["m_userid","IN","54jhzz7z,20fdjyq0"]] |
| 適用されたSLAレベル | sla_levelid | E NE IE INE | [["sla_levelid","E","phgeo2ot"]] [["sla_levelid","NE","phgeo2ot"]] [["sla_levelid","IE",""]] [["sla_levelid","INE",""]] |
| チケットオーナーの顧客グループ | groups | L | [["groups","L","9q8l"]] |
| サジェストカテゴリー | s_category | IN | [["s_category","IN","39"]] |
| フォーラムカテゴリー | f_category | IN | [["f_category","IN","41"]] |