Zendesk Chat APIの使い方：ステップバイステップガイド

カスタム統合の構築、レポート作成のためのチャットデータの抽出、あるいはZendeskでのいくつかのワークフローの自動化を検討されているのですね。それは素晴らしい目標です。APIを使用することで、チームの特定のニーズに合わせてプラットフォームを自在にカスタマイズできるようになります。

Zendeskは成熟した信頼性の高いプラットフォームであり、その強みの一部は提供されている幅広い開発者ツールにあります。従来のライブチャット（Live Chat）を使用している場合でも、新しいメッセージング（Messaging）プラットフォームを使用している場合でも、ZendeskはRESTやリアルタイムAPIなど、さまざまなAPIの選択肢を提供しています。選択肢が豊富であることはプラットフォームの奥深さを示していますが、最適な出発点を見つけるためのガイドがあればさらに心強いでしょう。

このガイドは、これらの強力なツールの活用を支援するために作成されました。Zendeskが提供する従来のChat APIを使用するための、明確なステップバイステップのプロセスを追っていきます。目標に合わせて適切なツールを選択する方法から、最初の手順、そして最初のAPIコールの成功までを解説します。

Zendesk Chat APIを使い始めるために必要なもの

手順に入る前に、必要なものがすべて揃っているか簡単に確認しましょう。今これらを整理しておくことで、プロセスが非常にスムーズになります。

チェックリストは以下の通りです：

• APIアクセス権のあるZendeskアカウント。 これはZendesk Suite Teamプラン以上で利用可能です。Zendeskは、さまざまなチームの規模やニーズに合わせた段階的なプランを提供しています。

• 管理者（Admin）権限。 APIキーを生成するには、Zendeskアカウントの管理者である必要があります。これにより、統合が安全に処理されることが保証されます。

• APIクライアント。 APIにリクエストを送信する方法が必要です。Postmanのようなツールは、プロフェッショナルなインターフェースでAPIコールをテストできるため、非常に便利です。あるいは、ターミナルで直接cURLを使用したり、お好みのプログラミング言語を使用したりすることもできます。

• REST APIに関する基礎知識。 エンドポイント、GETリクエスト、認証ヘッダーといった概念に多少馴染みがあれば、Zendeskの堅牢な開発者エコシステムを最大限に活用できるでしょう。

Zendesk Chat API使用のステップバイステップガイド

さて、ツールの準備が整ったところで、本題に入りましょう。まずはZendeskの全体像を確認し、その後に実際のAPIコールへと進みます。

ステップ 1：Zendesk Chatの構成を理解する（チャット vs メッセージング）

Zendeskは、ライブチャット（Live Chat）とメッセージング（Messaging）という2つの異なるチャット製品を含む、包括的なコミュニケーションツールセットを提供しています。どちらも強力なソリューションですが、どちらを使用しているかを知ることで、適切なAPIを選択できます。

Zendesk ライブチャット（クラシック版） これは、何千もの企業でリアルタイムのカスタマーサービスを支えてきた、オリジナルのセッションベースのチャット製品です。ライブで即時の会話に最適です。この製品は、このガイドで焦点を当てる Chat REST API を含む特定のAPIセットを使用します。これらのAPIは、リアルタイムの会話の管理、エージェントの操作、過去のチャットログの取得を行うために構築されています。

Zendesk メッセージング これはZendeskのモダンなオムニチャネル・アプローチです。非同期の会話用に構築されており、顧客はウェブ、モバイル、またはWhatsAppのようなソーシャルチャネルを通じて、自分のペースでコミュニケーションをとることができます。メッセージングは、Sunshine Conversationsを含む独自の高度な開発者ツールキットを活用しています。

ステップ 2：目的に合った適切なAPIを選択する

ライブチャット環境において、Zendeskは特定のタスクに最適化されたいくつかの特殊なAPIを提供しています。

選択肢の概要は以下の通りです：

• Chat REST API: これはほとんどのタスクに使用する多目的なツールです。過去のチャットデータのプログラムによる取得、トランスクリプトの取得、エージェントの管理、チャット情報の更新などに使用します。今回の例でもこれを使用します。

• Real-Time Chat API: これはライブ監視用に構築された高性能なストリーミングAPIです。アクティブなチャットやエージェントのステータスをリアルタイムで表示するダッシュボードが必要な場合、これが最適な選択肢です。

• Conversations API (GraphQL): このAPIはエージェントのようなアプリケーションの構築に使用されていましたが、Zendeskは現在、より新しいツールへの開発に注力しています。現在はメンテナンスモードであるため、新規プロジェクトにはREST APIの使用が推奨されます。

• Web SDK: これは、完全にカスタムされたチャットウィジェットを構築できるJavaScriptライブラリであり、サイト上のユーザー体験を完全にコントロールすることができます。

分かりやすくするために、これらのオプションを簡単な表にまとめました。

API名	タイプ	主なユースケース	ステータス
Chat REST API	REST	履歴データの取得、チャットの管理	アクティブ
Real-Time Chat API	REST / ストリーミング	ライブメトリクスとエージェントステータスの監視	アクティブ
Conversations API	GraphQL	エージェント型ボットやアプリの構築	メンテナンスモード
Web SDK	JavaScript	カスタムフロントエンドチャットウィジェットの構築	アクティブ

ステップ 3：API認証情報を生成する

APIと安全にやり取りするために、Zendesk ChatダッシュボードでOAuthクライアントを作成します。これは、アクセスを管理するための安全で標準的な方法です。

手順は以下の通りです：

1. Zendesk Chatダッシュボードに移動します。これは、メインのZendesk Supportアカウントの製品トレイにあります。

2. 設定 > アカウントに移動し、APIとSDKタブをクリックします。

3. APIクライアントを追加ボタンをクリックします。

4. クライアントにクライアント名（「Chat Data Integration」など）を付け、会社名を入力します。リダイレクトURLには、今回のセットアップ用に「https://localhost」と入力できます。

5. ZendeskがクライアントIDとクライアントシークレットを生成します。クライアントシークレットは必ず安全に保存してください。

6. これらの認証情報を使用して、リクエスト用のアクセストークンを生成できます。このガイドでは、アクセストークンの準備ができているものとして進めます。

ステップ 4：最初のAPIコールを行う

いよいよエキサイティングな部分です。認証情報を使って、最新のチャットリストを取得してみましょう。

エンドポイント すべてのチャットのリストを取得するためのエンドポイントは "GET /api/v2/chats" です。

認証 「Authorization: Bearer YOUR_ACCESS_TOKEN」という形式で、「Authorization」ヘッダーにアクセストークンを含めます。

cURLの使用 ターミナルで次のコマンドを実行します（YOUR_ACCESS_TOKENを実際のトークンに置き換えてください）：

curl https://www.zopim.com/api/v2/chats \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Zendeskの信頼性の高いインフラストラクチャが、JSON形式のチャットリストを返します。

レスポンス例 次のような詳細なレスポンスが表示されます：

{
  "chats": [
    {
      "id": "1A2B3C4D5E",
      "visitor": {
        "name": "Jane Doe",
        "email": "jane.doe@example.com"
      },
      "history": [
        {
          "type": "chat.msg",
          "display_name": "Jane Doe",
          "msg": "こんにちは、最近の注文について質問があります。",
          "timestamp": 1678886400000
        },
        {
          "type": "chat.msg",
          "display_name": "サポートエージェント",
          "msg": "Janeさん、こんにちは！喜んでお手伝いさせていただきます。",
          "timestamp": 1678886460000
        }
      ],
      "timestamp": "2026-03-15T12:00:00Z"
    }
  ],
  "count": 1
}

これで、Zendeskが提供するChat APIの使用に成功しました！訪問者の詳細、会話履歴などにアクセスできるようになりました。

Zendesk Chat APIをスムーズに利用するためのヒント

より高度な統合を構築する際、以下のベストプラクティスを念頭に置くことで、Zendeskの機能を最大限に活用できます。

• 1. 製品に合ったAPIを選択する: Zendeskはライブチャットとメッセージングの両方に専用のツールを提供しているため、常にどちらの製品を対象にしているかを確認してください。これにより、コードが初日から完璧に動作することが保証されます。

• 2. 安定性のためにレート制限を遵守する: すべてのユーザーに高いパフォーマンスを保証するため、ZendeskのChat APIにはレート制限があります。これは通常、1分あたり約200リクエストです。レスポンスの「X-Rate-Limit-Remaining」ヘッダーを監視することで、コールを効果的に管理できます。

• 3. モダンなAPIに焦点を当てる: Zendeskは常に革新を続けています。Chat REST APIのようなアクティブにサポートされているAPIを使用することで、プロジェクトが最新で最も機能豊富な基盤の上に構築されるようになります。

Zendeskのエコシステムは広大で強力であり、世界クラスのサポートを構築するために必要なすべてを提供しています。さらに効率性を高めたい場合は、eesel AIのようなツールがZendeskのセットアップを補完できます。これは、過去のデータに基づいてAIがチケットをどのように処理するかを確認できるシミュレーションエンジンを提供し、より自信を持って自動化を導入することを可能にします。

Zendesk Chat APIのコードを書かずにAIで自動化する

おめでとうございます！Zendeskが提供するChat APIを探索し、認証情報の生成方法とデータの取得方法を学びました。これは環境をカスタマイズするための素晴らしい方法です。

エージェントの効率をさらに高め、即時の解決を提供したい場合は、Zendeskエコシステム内で動作するすぐに使えるオプションもあります。

eesel AIは、数分でZendeskインスタンスと統合できる専門ツールです。自律型エージェントや、人間のエージェントをサポートするAI Copilotなどの補完的な機能を提供します。これは、チームのためにZendeskがすでに構築した強力な基盤を活用しながら、強力な自動化を追加する優れた方法です。

今すぐ無料トライアルを開始しましょう。