読者です 読者をやめる 読者になる 読者になる

アルパカログ

まじめなことを書きます。

Zendesk REST API で複数のチケットフィールドを指定してチケットを検索する

3年前から業務で Zendesk App を作っています。 Zendesk は開発者向け機能が豊富に提供されているところが良いですね。

今日は Zendesk REST APISearch API を使い複数のチケットフィールドを AND 指定してチケットを検索する方法について説明します。が、 Undocumented な方法のため使用は自己責任でお願いしますね。

リクエスト URL

チケットを検索する場合のリクエスト URL は下記のようになるでしょう。

/api/v2/search.json?query=type:ticket {query}&sort_by={sort_by}&sort_order={sort_order}&page={page}

チケットフィールドを含め検索条件は query で指定します。

チケットフィールドの指定

チケットフィールド (カスタムフィールド) の条件は Zendesk Support search reference にあるとおり fieldvalue:12345 のように指定します。

ここで気を付けなければならないのは 12345 の部分は ID ではなく値であるということです。

AND 条件

fieldvalue:12345,67890 のようにスペースを入れず CSV で指定します。


最近は過去に App Framework v1 で作った Zendesk App を v2 に書き換えて少し知見が溜まったので、また気が向いたら書きたいと思います。