"],"query":[],"variable":[]}},"response":[{"id":"5cd3e640-7df2-4e8a-891e-3571d08bc289","name":"Authenticate","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"tenant_url\" : \"yourcompany.brightpattern.com\",\r\n \"username\" : \"stats.user\",\r\n \"password\" : \"SecurePassword!\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://yourcompany.brightpattern.com/statsapi/auth"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"token\": \"61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721\",\r\n \"privileges\": [\r\n \"PUSH_PULL_GLOBAL_WALLBOARDS\",\r\n \"CUSTOMIZE_WALLBOARDS\",\r\n \"SYS_USE_AGENT_SEAT_MAPS\"\r\n ],\r\n \"user_id\": \"XXXC49E4-E9XX-4XFX-X4X4-62XXXXXXXX8E\"\r\n}"}],"_postman_id":"dcadf8cb-3bb3-4462-9f45-2326f4e97ed8"}],"id":"cc968b6e-c8c7-418b-b971-b6f080a84208","description":"認証
\nこのAPIは、OAuth 2.0による認証に対応しています。
\nOAuth 2.0 認証
\nOAuth 2.0 クライアントクレデンシャルグラントは、Get Access Tokenメソッドを使用して、このAPIのクライアントを認証するために使用されます。認証されたユーザーが、要求された操作を実行するための適切な権限を持っているかどうかが確認されます。権限の完全なリストはこちらでご確認いただけます。権限は、1つまたは複数の役割（Roles）を介してユーザーに割り当てられます。
\nアクセストークンを取得するには：
\n\nBPCC設定ポータルにログインしてください。
\n「ユーザー」ページに移動してください。
\nユーザーを選択するか、新規作成してください。そのユーザーは以下の条件を満たしている必要があります:
\n\n以下の権限を持っていること：
\n\nリアルタイム統計 API へのアクセス権
\nエージェントのリアルタイムメトリクスの表示
\nリアルタイムのサービスメトリクスの表示
\n
\nチームスーパーバイザーとして割り当てられていること（つまり、このチームのエージェントおよびこのチームの担当するサービスのメトリクスを取得できます）
\n
\n[生成]ボタンをクリックして、APIシークレットキーを生成します。生成されたキーをコピーし、次のステップのためにユーザー名を控えておいてください。
\n「_Get Access Token_」メソッドを使用して、アクセストークンを取得します。_client_id_には上記のユーザー名を、_client_secret_には生成されたAPIシークレットキーを設定してください。成功すると、access_tokenが返されます：
\n
\n{\n \"access_token\": \"<access token value>\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"3600\",\n \"scope\": \"yourcompany.brightpattern.com\"\n}\n\n
\n- BPCC Real-Time Stats APIを経由して行われるその後の各リクエストのAuthorizationヘッダーには、
access_tokenの値を使用してください： \n
\nAuthorization: Bearer <access token value>\n\n
基本認証（非推奨）
\n注: この認証方法は、ユーザー認証サービスのリリース以降、非推奨となっています。「_Authenticate_」（POST /statsapi/auth）へのリクエストには、{\"error\": \"illegal login attempt\" を含む 403 Forbidden レスポンスが返されます。代わりに OAuth 2.0 認証を使用してください。
\n基本認証では、Authenticateメソッドを使用してサーバー上でユーザーを認証します。認証に成功した場合、サーバーはセッションクッキーを設定します。
\nAuthenticateメソッドによって取得された認証トークンは、その他のメソッドのCookieヘッダーに含める必要があります：
\nCookie:X-STATSAPI-TOKEN=61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721; X-STATSAPI-TENANT=tenant_URL; X-STATSAPI-LOGIN=user.name\n\n
なお、このクッキーは、次のユーザーが任意のウォールボードにログインするまで有効です（つまり、ユーザーごとに1つのクッキーとなります）。
\n","event":[{"listen":"prerequest","script":{"id":"834d2616-f89a-4290-8e0a-11f6e1962b95","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c6dcf48a-6977-49df-9b98-1e4d0b4dbd49","type":"text/javascript","exec":[""]}}],"_postman_id":"cc968b6e-c8c7-418b-b971-b6f080a84208"},{"name":"メソッド","item":[{"name":"Create Subscription","id":"32238189-7119-43d5-94ff-9ff917370be0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"\": {\r\n \"stats_totals\": [\"statistic name\" ], //array of statistics\r\n \"service_grids\": [//array of service grid definitions \r\n {\r\n \"id\": \"\",\r\n \"columns\": [//array of stats for columns\r\n {\r\n \"id\": \"\",\r\n \"stat_name\": \"\"\r\n }\r\n ], \r\n \"order_by\": \"\",\r\n \"order_dir\": \"ASC|DESC\",\r\n \"limit\": \"\",\r\n \"filter_by\": \"\",\r\n \"filter_value\": \"\",\r\n \"filter_operation\": \"EQ|NE|LT|GT|LE|GE\"\r\n }\r\n ],\r\n \"agent_grids\": [ //array of agent grid definitions \r\n {\r\n \"id\": \"\",\r\n \"columns\": [//array of stats for columns\r\n {\r\n \"id\": \"\",\r\n \"stat_name\": \"\", \r\n \"dispositions\": [\"<(optional)list of dispositions>\"]\r\n }\r\n ], \r\n \"order_by\": \"\",\r\n \"order_dir\": \"ASC|DESC\",\r\n \"limit\": \"\",\r\n \"filter_by\": \"\",\r\n \"filter_value\": \"\",\r\n \"filter_operation\": \"EQ|NE|LT|GT|LE|GE\"\r\n }\r\n ],\r\n \"chat_messages\": {//top of internal chat messages \r\n \"filter\": \"\",\r\n \"limit\": \"\"\r\n }\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https:///statsapi/subscription","description":"このメソッドは、特定のメトリクスセットに対するサブスクリプションを作成します。各クライアントは、アクティブなサブスクリプションを1つしか持つことができません。
\n応答コード
\n\n\n\n| Code | \nDescription | \n
\n\n\n\n| 200 | \nOK サブスクリプションが作成されました | \n
\n\n| 400 | \n不正なリクエスト | \n
\n\n| 401 | \n認証されていません | \n
\n\n| 409 | \nテナントの有効なサブスクリプション数の上限を超過しました | \n
\n\n
\n
このメソッドは、アクティブなサブスクリプションの統計データを取得します。
\n注：
\n\n- agent_grid 情報を取得するには、ユーザーがチームのスーパーバイザーである必要があります。
\n
\n応答コード
\n\n\n\n| コード | \n説明 | \n
\n\n\n\n| 200 | \nOK | \n
\n\n| 204 | \nコンテンツなし（データがまだ準備できていません） | \n
\n\n| 401 | \n認証なし | \n
\n\n| 404 | \n不正なリクエスト（有効なサブスクリプションがありません） | \n
\n\n
\n
このメソッドは、アクティブなサブスクリプションを削除し、サーバー上のデータキャッシュを消去します。
\n","urlObject":{"protocol":"https","path":["statsapi","subscription","active"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1bf2f7cc-d2a0-4f8d-a13e-2b128cd611c7","name":"Delete Subscription","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721","type":"text"}],"url":"https://yourcompany.brightpattern.com/subscription/active"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4f414302-786b-4eb7-8116-31c3170903f2"},{"name":"Get Dispositions","id":"5884b30a-ee9a-49db-af90-42470d099a69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https:///statsapi/cfg/dispositions","description":"このメソッドは、監視対象のすべてのサービスの対話結果（ディスポジション）の名前を取得します。
\nオプションのURLパラメータ
\n\n- agentCanSelect = 1
\n- インバウンド = 1
\n- アウトバンド = 1
\n- プレビュー = 1
\n
\n応答コード
\n\n\n\n| コード | \n説明 | \n
\n\n\n\n| 200 | \nOK | \n
\n\n| 401 | \nアクセス許可なし | \n
\n\n
\n
このメソッドは、特定のサービスを処理できる状態にあるエージェントがいるかどうかについて、「true」または「false」の値を返します。
\n注：
\n\n- このメソッドでは、認証やサブスクリプションは必要ありません。
\n
\n応答
\n\n\n\n| コード | \n説明 | \n
\n\n\n\n| 200 | \nOK | \n
\n\n| True | \n特定のサービスにおいて「受付可能なエージェント数」が 0 より大きい（つまり、少なくとも 1 人のエージェントが利用可能） | \n
\n\n| False | \n特定のサービスにおいて「受付可能なエージェント数」が 0 である（つまり、利用可能なエージェントがいない） | \n
\n\n
\n
このメソッドは、指定されたテナントに対して設定されているチームの名前と内部オブジェクトIDを返します。
\nなお、特定のチームに関する上記の情報を取得するには、API認証に使用するアカウントが、そのチームのスーパーバイザーとして割り当てられている必要があります。
\n","urlObject":{"protocol":"https","path":["statsapi","cfg","teams"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a8791f68-71c7-4c52-8849-8954b50443dd","name":"Get Teams","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{vault:bearer-token}}","type":"text"}],"url":"https://yourcompany.brightpattern.com/statsapi/cfg/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[""],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"F4ED90FA-5A49-4D76-9487-4E41B24CA45F\",\n \"name\": \"Customer Service\"\n }\n]"}],"_postman_id":"ebf333c2-6d65-494f-ba77-4c8badbca58f"}],"id":"a039e9d4-97b6-416c-91b1-8bdcee18da0a","description":"Bright Pattern コンタクトセンターのリアルタイム統計 API のメソッドは以下の通りです。
\n注：
\n\n","event":[{"listen":"prerequest","script":{"id":"b0474593-1e04-40e9-a148-57acc60724e2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"3cc2ad67-8234-4007-8ac8-b451c11dc615","type":"text/javascript","exec":[""]}}],"_postman_id":"a039e9d4-97b6-416c-91b1-8bdcee18da0a"}],"event":[{"listen":"prerequest","script":{"id":"b46e3bf5-2de2-4a6e-baff-5f136d8d3c42","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b7160178-c0e8-43a3-a332-868785e508c8","type":"text/javascript","exec":[""]}}]}