SparkTG

有効な休憩の取得 (v2)ドキュメント

有効な休憩の取得 (v2)

v2

有効な休憩の取得 (v2)

エージェントが使える休憩ステータス(特定のエージェント向けも可)

API v2v21件のエンドポイント

概要

サービス内でエージェントが使える休憩ステータスを一覧表示します。たとえば CRM や CTI でエージェントのステータス用ドロップダウンを作るときに使います。「有効」とは、エージェントが現在使える休憩のことで、管理者が無効にしていないデフォルトの休憩と、管理者が有効にしたカスタム休憩を指します。サービス全体で無効にされた休憩は一覧に含まれません。一覧は常にトークンのサービスのものです。agent-id を送ると、そのエージェントに対して管理者が非表示にした休憩もわかります。課金対象外です。

利用可能なエンドポイント

GET/api/v2/effective-breaks

主なパラメーター

agent-id(Integer)

エージェントの ID(GET /api/v2/agents が返す id)。送信すると、管理者がこのエージェントに対して非表示にした休憩が "disabled": true 付きで返ります。省略するか空で送ると、エージェント固有のフラグなしでサービスの一覧を取得します。エージェントは有効で、トークンのサービスに属している必要があります。

利用シナリオ

サービス全体の休憩

パラメーターなし。特定のエージェントを想定していないとき、たとえばレポートに休憩名を表示するときに使います。レスポンスは省略しています。一般的なサービスには 12 個前後の休憩があります。

0件のパラメーターサンプルに掲載

1 人のエージェントの休憩

agent-id を送ります。ここでは管理者がエージェント 319 に対して Leave を非表示にしているため、"disabled": true 付きで返ります。名前と色を表示できるよう休憩は一覧に残りますが、エージェントには選ばせないでください。

0件のパラメーターサンプルに掲載

簡単なサンプル

簡単なcURLコマンドでこのAPIを試す

基本的なAPI呼び出し
curl 'https://telephonycloud.co.in/api/v2/effective-breaks' \
  -H 'Authorization: Bearer <YOUR_TOKEN>'
💡 <YOUR_TOKEN> をお使いの API トークンに置き換えてください

レスポンスのプレビュー

このAPIのサンプルレスポンス

サンプルレスポンス
[{"break_id":0,"label":"Available","icon":"available","color":"#5ccc56","is_system":true,"sort_order":1,"is_deleted":false,"category":"SYSTEM"},{"break_id":1,"label":"Meal","icon":"lunch","color":"#F4...
レスポンス全体の形式はレスポンスセクションをご覧ください