XML/JSON APIから新しいREST APIへの移行
新しいREST APIにより、開発者はより簡単で便利に、Zoho Deskの機能にアクセスして利用できるようになりました。このドキュメントでは、新しいAPIにシームレスに移行できるようにするため、古いXML/JSON APIに相当するREST APIの一覧を紹介しています。
重要な変更
移行に関連する最も重要な変更は、次のとおりです。
インプット/レスポンスの形式
古いAPIでは、XML形式とJSON形式の両方でレスポンスを返しました。新しいAPIでは、複雑さを軽減して使いやすさを保証するために、JSON形式でのみレスポンス応答を返すように設計しました。
HTTPメソッド
新しいAPIでは、APIリクエストでGET、POST、PATCH、DELETEなどの基本的なHTTPメソッドを使用します。
認証
古いAPIでは、認証にauthTokenを使用していました。新しいREST APIでは、より安全なOAuthトークンを使用します。
orgId
古いAPIでは、Zoho Deskで組織を識別するために、リクエストにポータル名を使用していました。一方、新しいAPIでは、orgIdパラメーターを使用します。Get all organizations APIを使用して、組織のorgIdを取得できます。
orgIdトークンとOauthトークンの両方を、すべてのAPIリクエストのヘッダーに含めてください。
使用頻繁の高いXML/JSON APIと、それに対応するREST APIの一覧は、次の表のとおりです。
古いXML/JSON API | 対応するREST API |
/api/(xml|json)/(Requests|Cases|requests|cases)/updaterecords | |
/api/(xml|json)/(Contacts|contacts)/updaterecords | |
/api/(xml|json)/(Accounts|accounts)/updaterecords | |
/api/(xml|json)/(Tasks|tasks)/updaterecords | |
/api/(xml|json)/(timeentry|TimeEntry)/updaterecords | |
/api/(xml|json)/(Contracts|contracts|Contract)/updaterecords | |
/api/(xml|json)/(Requests|Cases|requests|cases)/addrecords | |
/api/(xml|json)/(Contacts|contacts)/addrecords | |
/api/(xml|json)/(Accounts|accounts)/addrecords | |
/api/(xml|json)/(Tasks|tasks)/addrecords | |
/api/(xml|json)/(timeentry|TimeEntry)/addrecords | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getrecords | |
/api/(xml|json)/(Accounts|accounts)/getrecords | |
/api/(xml|json)/(Products|products)/getrecords | |
/api/(xml|json)/(Contracts|contracts|Contract)/getrecords | |
/api/(xml|json)/(Timeentry|timeentry|TimeEntry)/getrecords | |
/api/(xml|json)/(Tasks|tasks)/getrecords | |
/api/(xml|json)/(Solutions|solutions)/getrecords | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbyid | |
/api/(xml|json)/(Contacts|contacts)/getrecordsbyid | |
/api/(xml|json)/(Tasks|tasks)/getrecordsbyid | |
/api/(xml|json)/(Accounts|accounts)/getrecordsbyid | |
/api/(xml|json)/(Solutions|solutions)/getrecordsbyid | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbycustomview | https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets - このAPIリクエストでviewIdパラメーターを使用します。 https://desk.zoho.com/support/APIDocument.do#Views#Views_Listallviews - このAPIを使用して、viewIdsの一覧を取得します。 |
/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbysearch | |
/api/(xml|json)/(Contacts|contacts)/getrecordsbysearch | |
/api/(xml|json)/(Accounts|accounts)/getrecordsbysearch | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getrecordsbyowner | https://desk.zoho.com/support/APIDocument.do#Tickets#Tickets_Listalltickets - このAPIリクエストでassigneeパラメーターを使用します。 https://desk.zoho.com/support/APIDocument.do#Agents#Agents_Listallagents - このAPIを使用して、担当者の一覧を取得します。 |
/api/(xml|json)/(Requests|Cases|requests|cases)/deleterecords | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getrequestthreads | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getattachments | |
/api/(xml|json)/(Requests|Cases|requests|cases)/getattachmentslist | |
/api/(xml|json)/(Requests|Cases|requests|cases)/addattachments | |
/api/(xml|json)/(Requests|Cases|requests|cases)/reply | |
/api/(xml|json)/(departments|department)/getalldepartments | |
/api/(xml|json)/(portals|portal)/getportallist | |
/api/(xml|json)/emails/getfromaddress |
Zoho CRM 管理者向けトレーニング
「導入したばかりで基本操作や設定に不安がある」、「短期間で集中的に運用開始できる状態にしたい」、「運用を開始しているが再度学び直したい」 といった課題を抱えられているユーザーさまに向けた少人数制のオンライントレーニングです。
日々の営業活動を効率的に管理し、導入効果を高めるための方法を学びましょう。
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Zoho Campaigns Resources
Zoho WorkDrive Resources
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
WhatsApp連携のWhatsAppクラウドAPIへの移行
WhatsAppクラウドAPIを使用すると、顧客とのメッセージの送受信を手軽に行うことができます。なお、WhatsAppクラウドAPIの登場により、メッセージを送信できる回数は、1秒あたり30件から、80件まで増加しました（テキストだけでなく画像や動画を含むメッセージを送受信できます）。 どのようなメリットがありますか？ ...Webhookブロックのヘッダー
Webhookブロックを通じてAPIリクエストを送信するにあたって、ヘッダーはとても重要です。ヘッダーに含まれている情報をもとに、外部アプリ／システム側でAPIリクエストの識別、承認が行われます。 以下では、Webhookブロックのヘッダーの概要やよくある質問について説明します。 参考情報：自動ガイドボットのWebhookブロックの概要 ヘッダーとは ...他のサービスからZoho Deskへのデータ移行（Zwitch）
「Zwitch」 とは、他のサービスからZoho Deskへのデータ移行をZoho Deskの移行担当チームに依頼するための機能です。「Zwitch」という言葉自体は「Zoho」と「Switch」（スイッチ、移行）の2語を組み合わせた造語です。 一般に、顧客サポート用のシステム（ソフトウェア、ツール）を入れ替える場合、問い合わせ、顧客、ナレッジベース（商品やサービスに関するヘルプやよくある質問）、ユーザー情報などのデータを、必要な形でスムーズに移行できるかどうかは重要です。 Zoho ...WebhookブロックのPOSTメソッド
顧客への対応を行うにあたって、ボットを通じて他のアプリ／システムで問い合わせを作成したり、チャットの利用者から受け取ったフィードバックを保存したり、フォームの回答を記録したりしたい場合があります。このような場合、WebhookブロックのPOSTメソッドが役立ちます。 WebhookブロックのPOSTメソッドでは、APIに対応しているZoho Desk、Zoho CRM、他の外部アプリ／システムに対して、ボットを通じてデータを送信できます。 ...Webhookブロックのフォーマッター（Deluge）
APIによる出力データは、チャットの利用者にとってわかりにくい場合があります。このような場合に、Webhookブロックのフォーマッターが役立ちます。フォーマッターでは、Delugeスクリプトを通じてAPIによる出力データの形式を整えることができます。 たとえば、APIによって出力される日時の値が「2025-06-02T10:45:00Z」の場合に、値が「2 June 2025, 10:45 ...