{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"08385194-e60a-4972-9003-3453721012a9","name":"BPCC Task Routing API (JA)","description":"Bright Pattern Contact Center（BPCC）タスクルーティングAPI v1は、外部システム（CRMなど）がBPCC内でタスクの作成、ルーティング、修正、キャンセル、および照会を行えるようにするRESTful APIです。\n\n## 機能\n\nタスクルーティング API v1 では、以下の機能がサポートされています。\n\n- **タスクのキューへの登録：**新規のタスクを作成してキューに登録し、ケースおよび連絡先に関連付けます。\n- **タスクのキャンセル：**特定のタスクをキューから消去し、そのdispositionを設定します。\n- **サービスタスクのキャンセル：**特定のサービスに関連付けられた、キューに登録されているすべてのタスクをキャンセルします。\n- **タスクの更新：**キューに登録されたタスクの属性（サービスや優先度など）を修正します。\n- **タスクの照会：**特定のタスクのステータスやキュー情報を取得します。\n- **外部識別子のサポート：**エンティティは、内部識別子（BPCC によって自動的に生成される）または外部識別子（ユーザーが指定する）のいずれかを使用して参照できます。\n\n## エンティティ\n\nこの API は、Bright Pattern Contact Center 内の以下のコアオブジェクトと連携します：\n\n- **タスク：**エージェントが完了すべき特定のアクションやアクティビティを表す、個別の作業単位です。タスクは常にケースおよび連絡先に関連付けられています。タスクがキューに入れられる際、外部識別子に関連付けられる場合があります。既存のタスクは、内部識別子または外部識別子を用いて、キャンセル、更新、および照会を行うことができます。\n- **ケース：**特定の顧客リクエストに関連する[コミュニケーションおよび情報のグループ](https://help.brightpattern.com/Agent-guide/Work/CasesEmail/CasesEmailandThreads#Cases_and_Email)です。ケースは常に連絡先に関連付けられています。API経由でケースが作成される際、外部識別子とリンクされる場合があります。タスクがキューに入れられる際、既存のケースは、そのケースの外部識別子を使用してタスクに関連付けられる場合があります。\n- **連絡先：**対話に関与する[顧客または個人](https://help.brightpattern.com/Agent-guide/Work/Contacts/Overview)を指します。API 経由で連絡先が作成される場合、外部識別子と関連付けられることがあります。タスクがキューに登録される際、連絡先の外部識別子を使用して、その連絡先をタスクに関連付けることができます。\n\n## エンドポイントプレフィックス\n\nTask Routing API v1 のエンドポイントプレフィックスは以下の通りです：\n\n```\nhttps://<tenant_url>/taskroutingapi/v1/\n\n ```\n\n# 対象読者\n\nこのドキュメントは、外部システムとBright Patternコンタクトセンターの統合を担当するIT担当者および開発者を対象としています。読者は、REST API、JSONデータ構造、およびサービス、キュー、dispositionなどのコンタクトセンターの概念について、ある程度の知識をお持ちである必要があります。このAPIを使用して統合を実装するには、スクリプト作成やプログラミングの経験があることが推奨されます。\n\n# 使用方法\n\nこのドキュメントには、各APIメソッドのサンプルが含まれています。これらのサンプルは、統合開発の出発点としてご利用いただけます。これらのAPIの説明は、 [Postman API開発環境](https://www.getpostman.com/) に読み込み、ご自身のアクセストークンを使用してAPIとやり取りすることができます。\n\nタスクルーティングのリクエストおよびレスポンスには、`application/json` 型の JSON エンコードされた本文が含まれる場合があります。成功したレスポンスの本文はメソッドによって異なります。失敗したレスポンスでは、以下の内容が返されます：\n\n``` JSON\n{\n\"errorCode\": [integer number],\n\"errorMessage\": \"[string with error description]\"\n}\n\n ```\n\n## 認証\n\n以下のAPIメソッドを使用するには、ユーザーに**「タスクルーティングAPIの使用」**権限が付与されている必要があります。管理者は、コンタクトセンター内の [<b>役割</b> ＞ <b>サービスおよびキャンペーン管理</b>](https://help.brightpattern.com/Contact-center-administrator-guide/UsersandTeams/Privileges#Service_and_Campaign_Administration) からこの権限を付与できます。\n\n詳細については、『設定ガイド』をご参照ください。","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"58450950","team":263630,"collectionId":"08385194-e60a-4972-9003-3453721012a9","publishedId":"2sBYB4LmuJ","public":true,"publicUrl":"https://documenter-api.postman.tech/view/58450950/2sBYB4LmuJ","privateUrl":"https://go.postman.co/documentation/58450950-08385194-e60a-4972-9003-3453721012a9","customColor":{"top-bar":"FFFFFF","highlight":"FF6C37","right-sidebar":"303030"},"documentationLayout":"classic-double-column","customisation":{"appearance":{"themes":[{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","highlight":"FF6C37","right-sidebar":"303030"}},{"name":"dark","logo":null,"colors":{"top-bar":"212121","highlight":"FF6C37","right-sidebar":"303030"}}],"default":"light"}},"version":"8.12.8","publishDate":"2026-09-29T10:20:20.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/548ccf0870037d7d48b6f450bf81fdffe296fe66a78fbf9e364d901796057123","favicon":"https://res.cloudinary.com/postman/image/upload/v1564790818/team/iomnrli2noloyuyialz3.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYB4LmuJ"}