Bright Pattern Contact Center（BPCC）タスクルーティングAPI v1は、外部システム（CRMなど）がBPCC内でタスクの作成、ルーティング、修正、キャンセル、および照会を行えるようにするRESTful APIです。
\nタスクルーティング API v1 では、以下の機能がサポートされています。
\nこの API は、Bright Pattern Contact Center 内の以下のコアオブジェクトと連携します：
\nTask Routing API v1 のエンドポイントプレフィックスは以下の通りです：
\nhttps://<tenant_url>/taskroutingapi/v1/\n\nこのドキュメントは、外部システムとBright Patternコンタクトセンターの統合を担当するIT担当者および開発者を対象としています。読者は、REST API、JSONデータ構造、およびサービス、キュー、dispositionなどのコンタクトセンターの概念について、ある程度の知識をお持ちである必要があります。このAPIを使用して統合を実装するには、スクリプト作成やプログラミングの経験があることが推奨されます。
\nこのドキュメントには、各APIメソッドのサンプルが含まれています。これらのサンプルは、統合開発の出発点としてご利用いただけます。これらのAPIの説明は、 Postman API開発環境 に読み込み、ご自身のアクセストークンを使用してAPIとやり取りすることができます。
\nタスクルーティングのリクエストおよびレスポンスには、application/json 型の JSON エンコードされた本文が含まれる場合があります。成功したレスポンスの本文はメソッドによって異なります。失敗したレスポンスでは、以下の内容が返されます：
{\n\"errorCode\": [integer number],\n\"errorMessage\": \"[string with error description]\"\n}\n\n以下のAPIメソッドを使用するには、ユーザーに「タスクルーティングAPIの使用」権限が付与されている必要があります。管理者は、コンタクトセンター内の 役割 ＞ サービスおよびキャンペーン管理 からこの権限を付与できます。
\n詳細については、『設定ガイド』をご参照ください。
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"対象読者","slug":"5a6lgh6kqt6icf"},{"content":"使用方法","slug":"5l255so5pa55rov"}],"owner":"58450950","collectionId":"08385194-e60a-4972-9003-3453721012a9","publishedId":"2sBYB4LmuJ","public":true,"customColor":{"top-bar":"FFFFFF","highlight":"FF6C37","right-sidebar":"303030"},"publishDate":"2026-09-29T10:20:20.000Z"},"item":[{"name":"認証","item":[{"name":"Get access token","id":"341632c9-61a6-4bf9-8931-77c4080d11f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"String (Username)","type":"text","description":"Username of a BPCC user with the User Privilege Use Task Routing API enabled.
\n"},{"key":"client_secret","value":"String (API Token)","type":"text","description":"The API secret key generated for the user specified by client_id
\n"},{"key":"scope","value":"String (URL)","type":"text","description":"Your tenant URL, e.g., example.brightpattern.com
\n"},{"key":"grant_type","value":"String (\"client_credentials\")","type":"text","description":"Grant type. Must be set to client_credentials.
\n"}]},"url":"https://このAPI経由で行われる以降の各リクエストの認証に使用する必要があるアクセストークンを返します。
\n","urlObject":{"protocol":"https","path":["configapi","v2","oauth","token"],"host":["このAPIのクライアントを認証するために、OAuth 2.0 クライアント認証情報グラントが使用されます。認証されたユーザーが、要求された操作を実行するための適切な権限を持っているかどうかが確認されます。権限の完全なリストはこちらで確認できます。権限は、1つまたは複数の役割を通じてユーザーに割り当てられます。
\nアクセストークンを取得するには：
\nBPCC管理ポータルにログインします。
\nユーザーページに移動します。
\n「_Taskrouting APIを使用する_」権限を持つユーザーを選択するか、新規作成します。
\n[生成] ボタンをクリックして、APIシークレットキーを生成します。生成されたキーをコピーし、ユーザー名を記録しておきます。
\n「Get Access Token_」メソッドを使用して、アクセストークンを取得します。_client_id には上記のユーザー名を、client_secret には生成されたAPIシークレットキーを設定します。
\nレスポンスで返された_access_token_の値を使用して、BPCC タスクルーティングAPI経由で送信される以降の各リクエストの「_Authorization: Bearer [access token]_」ヘッダーに設定します。
\nタスクをキューに入れ、ケースおよび連絡先に関連付けます。
\nオプションとして、重複を防ぐために、タスク、ケース、または連絡先に紐付ける外部IDを指定することができます。外部IDが指定された場合：
\nBPCCは、タスク、ケース、または連絡先に対して指定された外部IDと関連付けられている既存のレコードがあるかどうかを確認します。
\nIf a match is found 外部IDと適合するレコードが見つかった場合、BPCC内の対応する既存のレコードが使用されます。
\nIf no match is found 外部IDと適合するレコードが見つからない場合、BPCCに新規のレコード（タスク、ケース、または連絡先）が作成され、その外部IDと関連付けられます。
\n最後に、そのタスク（既存のものを参照した場合でも、新規に作成された場合でも）は、ケースおよび連絡先エンティティ（既存のものを参照した場合でも、新規に作成された場合でも）に関連付けられ、指定されたサービスにキューに入れられます。
\ncontactInfo Properties:contactInfo.emails Array Element Properties:contactInfo.addresses Array Element Properties:screenpopData Array Element Properties:screenpopData 配列を使用して、エージェントのクライアントアプリケーション（フルエージェントデスクトップまたは統合CRMウィジェット）に基づいて条件付きで表示される複数のスクリーンポップを定義します：
エージェントがフルエージェントデスクトップアプリケーションでタスクを承認した場合、type: \"web\" が指定されたスクリーンポップのみが表示されます。複数の web スクリーンポップを同時に表示することができます（例：webScreenpopShowInTab の設定に応じて、別々のタブや埋め込みフレームで表示されます）。
タイプが web のオブジェクトを複数含めることができます。定義されたすべての web スクリーンポップが試行されます。ただし、配列要素内で最後に検出された webScreenpopShowInTab および screenpopShowUponAnswer の値が、すべての スクリーンポップに適用されます。
エージェントが特定のCRMウィジェット（例：Dynamics、Salesforce、ServiceNow、またはZendesk）内でタスクを承認した場合、システムは配列内から、そのCRM（例：type: \"dynamicscrm\"）と適合する type を持つスクリーンポップオブジェクトを検索します。見つかった場合、その特定のCRMスクリーンポップのみがウィジェットインターフェース内に表示されます。配列内の web タイプのスクリーンポップはすべて無視されます。
配列内に対応するCRMの type が見つからない場合、システムは web タイプのスクリーンポップを検索します。web タイプのスクリーンポップが存在する場合、その webScreenpopShowInTab 設定が true である場合に_のみ_表示されます（オブジェクト内で明示的に設定されているか、リクエストの最上位レベルから継承されているか）。webScreenpopShowInTab が false の場合、Webスクリーンポップはウィジェット内に表示されません。
フルエージェントデスクトップとCRMウィジェットの両方が開いており、screenpopData に適合するCRMタイプと web タイプの両方が含まれている場合、ウィジェットでタスクを承認した際には、CRMのスクリーンポップのみが表示されます。
異なるCRMに対応する複数のオブジェクトを含めることができます（例：dynamicscrm 用と salesforce 用をそれぞれ1つずつ）。ただし、同じCRMタイプを持つ複数のオブジェクトを含めた場合（例：type: \"dynamicscrm\" を持つオブジェクトが2つある場合）、配列内のその特定のCRMタイプに属する最後のオブジェクトのみが使用されます。
caseInfo Properties:taskInfo Properties:path変数で指定されたtaskIdのタスクをキューから削除し、そのdispositionをdispositionNameに設定します。タスクのキャンセルは、そのタスクがまだサービスキューまたはエージェントのパーソナルキュー内にある場合にのみ可能です。
\nexternal クエリパラメータを使用して、taskId が内部識別子か外部識別子かを指定してください。
\nなし
\n","urlObject":{"protocol":"https","path":["taskroutingapi","v1","task",":taskid",""],"host":["パスで指定された taskId が、外部タスクID（CRM やその他の外部システムからのもの）であるか、それとも Bright Pattern Contact Center によって生成された内部タスクIDであるかを示します。
\n","type":"text/plain"},"key":"external","value":"Boolean"}],"variable":[{"description":{"content":"external クエリパラメータで指定されたとおり、内部または外部のいずれかのIDを使用して、キャンセルするタスクを特定します。
\n","type":"text/plain"},"type":"any","value":"String (task ID)","key":"taskid"}]}},"response":[{"id":"cd42b563-8c94-48cb-a3ce-d8d31d471b62","name":"Cancel Task","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer E9C97B84D0F72C08A1B31916A1646B91618F63F146CC3694CD2523B63F732363","type":"text"}],"body":{"mode":"raw","raw":"{\n \"note\":\"Cancelled per user request\",\n \"dispositionName\":\"Abandoned\"\n}"},"url":{"raw":"https://serviceName で指定されたサービスに関連付けられている、現在キューに登録されているすべてのタスクをキャンセルします。dispositionName で指定された処理結果と、note で指定された注記が、キャンセルされた各タスクに適用されます。
\ntaskID パス変数で指定されたキュー内のタスクの優先度または関連するサービスを修正します。
\nexternal クエリパラメータを使用して、taskId が内部識別子か外部識別子かを指定します。
\nなし
\n","urlObject":{"protocol":"https","path":["taskroutingapi","v1","task",":taskid"],"host":["パスで指定された taskId が、外部タスク ID（CRM やその他の外部システムからのもの）であるか、それとも Bright Pattern Contact Center によって生成された内部タスク ID であるかを示します。
\n","type":"text/plain"},"key":"external","value":"Boolean"}],"variable":[{"description":{"content":"external クエリパラメータで指定された内部識別子または外部識別子のいずれかを使用して、キャンセルするタスクを特定します。
\n","type":"text/plain"},"type":"any","value":"String (task ID)","key":"taskid"}]}},"response":[{"id":"c9feeab6-929f-4972-a716-b65b56581bee","name":"Update Task","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer E9C97B84D0F72C08A1B31916A1646B91618F63F146CC3694CD2523B63F732363","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"priority\": 100,\n\t\"serviceName\": \"TaskService\"\n}\n"},"url":{"raw":"https://path変数の taskId で指定されたタスクに関する情報を取得します。
\nexternal クエリパラメータを使用して、taskId が内部識別子か外部識別子かを指定してください。
\nなし
\nパスで指定された taskId が、外部タスクID（CRMやその他の外部システムからのもの）であるか、それともBright Pattern Contact Centerによって生成された内部タスクIDであるかを示します。
\n","type":"text/plain"},"key":"external","value":"Boolean"}],"variable":[{"description":{"content":"external クエリパラメータで指定された内部識別子または外部識別子のいずれかを使用して、キャンセルするタスクを特定します。
\n","type":"text/plain"},"type":"any","value":"String (task ID)","key":"taskid"}]}},"response":[{"id":"973c2f7e-1e6f-4bdb-8bc6-0fa1ae325816","name":"Query Task","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer E9C97B84D0F72C08A1B31916A1646B91618F63F146CC3694CD2523B63F732363","type":"text"}],"url":{"raw":"https://以下の方法により、Bright Pattern Contact Center 内のタスクをキューに入れ、キャンセルし、更新し、照会することができます。
\n","_postman_id":"47c01fe5-cb05-4345-9ce8-4dad865dbd60"},{"name":"エラーコード","item":[],"id":"8c7861a1-5405-48c0-95a7-547109afd8c1","description":"Task Routing API では、以下のいずれかのエラーコードが返される可能性があります。
\n","_postman_id":"8c7861a1-5405-48c0-95a7-547109afd8c1"}],"event":[{"listen":"prerequest","script":{"id":"7af1b467-d52c-450c-93ec-95d7384fe200","type":"text/javascript","exec":["const echoPostRequest = {"," url: \"https://\" + pm.environment.get(\"tenant_url\") + \"/configapi/v2/oauth/token\","," method: 'POST',"," header: {"," 'Accept': '*/*',"," 'Content-Type': 'application/x-www-form-urlencoded',"," },"," body: {"," mode: 'urlencoded',"," urlencoded : ["," { key: 'client_id', value: pm.environment.get(\"client_id\")},"," { key: 'client_secret', value: pm.environment.get(\"client_secret\")},"," { key: 'scope', value: pm.environment.get(\"scope\")},"," { key: 'grant_type', value: \"client_credentials\"},"," ]"," }","};","","var getToken = true;","","if (!pm.environment.get('accessTokenExpiry') || "," !pm.environment.get('currentAccessToken')) {"," console.log('Token or expiry date are missing')","} else if (pm.environment.get('accessTokenExpiry') <= (new Date()).getTime()) {"," console.log('Token is expired')","} else {"," getToken = false;"," console.log('Token and expiry date are all good');","}","","if (getToken === true) {"," pm.sendRequest(echoPostRequest, function (err, res) {"," console.log(err ? err : res.json());"," if (err === null) {"," console.log('Saving the token and expiry date')"," var responseJson = res.json();"," pm.environment.set('currentAccessToken', responseJson.access_token)"," "," var expiryDate = new Date();"," //console.log(\"expiry date: \",expiryDate)"," //console.log(\"expiry seconds: \", responseJson['expires_in'])"," expiryDate.setSeconds(expiryDate.getSeconds() + Number(responseJson['expires_in']));"," //console.log(\"new expiry date: \", expiryDate)"," pm.environment.set('accessTokenExpiry', expiryDate.getTime());",""," }"," });","}"]}},{"listen":"test","script":{"id":"519e558a-fe67-4aeb-9ffb-c7be21c2efbc","type":"text/javascript","exec":[""]}}],"variable":[{"key":"tenant_url","value":"boromir.bugfocus.com"},{"key":"client_id","value":"User01","type":"string"},{"key":"clientSecret","value":"huuw8tbDgk9tX0r6C4rZfpa6kzCHP4oOZmtP7E3DG5d8yaaGC75Ux0Lb7dkngpAg","type":"string"},{"key":"scope","value":"","type":"string"},{"key":"currentAccessToken","value":"","type":"string"},{"key":"accessTokenExpiry","value":"","type":"string"},{"key":"client_credentials","value":"client_credentials"}]}