Bright Pattern Contact Center（BPCC）のConfiguration APIを使用すると、現在以下の操作が可能です：
\nこのドキュメントでは、対応する REST API メソッドについて、リクエストおよびレスポンスの例を交えて説明しています。この API は、 Postman API開発環境 に読み込んで、ご自身のアクセストークンを使用してAPIとやり取りすることができます。
\nUsername of a BP user authorized to manage users and/or phones.
\n","type":"text"},{"key":"client_secret","value":"","description":"API secret key generated for the above user.
\n","type":"text"},{"key":"scope","value":"","description":"Your contact center domain name, e.g., example.brightpattern.com.
\n","type":"text"},{"key":"grant_type","value":"","description":"Grant type. Must be set to client_credentials.
\n","type":"text"}]},"url":"https://:tenant-URL/configapi/v2/oauth/token","description":"このAPI経由で行われるその後の各リクエストの認証に使用されるアクセストークンを返します。
\n","urlObject":{"protocol":"https","port":"tenant-URL","path":["configapi","v2","oauth","token"],"query":[],"variable":[{"description":{"content":"コンタクトセンターのドメイン名（例：example.brightpattern.com）。
\n","type":"text/plain"},"type":"any","value":"boromir.bugfocus.com","key":"tenant-URL"}]}},"response":[{"id":"c9ce5d0a-5383-4fe1-a3c7-acc7af0251fb","name":"Get Access Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"client_id","value":"admin","description":"[Username](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Users/ja#Username) of a BP user authorized to [manage users](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Privileges/ja#Manage_users) and/or [phones](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Privileges/ja#Manage_phones).","type":"text"},{"key":"client_secret","value":"X0vhlwMc6YoEbQDDqQGM9nOw8p7v9110rjTL1COxGBnpIAZvY6ryrrBQT5N28qS9","description":"[API secret key](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Users/ja#API_secret) generated for the above user.","type":"text"},{"key":"scope","value":"yourcompany.brightpattern.com","description":"Your contact center domain name, e.g., *example.brightpattern.com*.","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Grant type. Must be set to *client_credentials*.","type":"text"}]},"url":{"raw":"https://:tenant-URL/configapi/v2/oauth/token","protocol":"https","port":"tenant-URL","path":["configapi","v2","oauth","token"],"variable":[{"key":"tenant-URL","value":"yourcompany.brightpattern.com","description":"Your contact center domain name, e.g., *example.brightpattern.com*."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 22 Apr 2019 02:07:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"242"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"CCE2C2EB964827XXXXXXXXXX3E1DEB2867C86D6C7ECDCE36C18D56XXXXXXXXXX\",\n \"token_type\": \"Bearer\",\n \"expires_in\": \"3600\",\n \"scope\": \"yourcompany.brightpattern.com\"\n}"}],"_postman_id":"27293ffc-2601-44f9-b2f7-3fe804c1e945"}],"id":"ab49882b-1b30-4e21-96eb-a8bdba9fdcb8","description":"このAPIのクライアントを認証するために、OAuth 2.0 クライアントクレデンシャルグラントが使用されます。認証されたユーザーが要求された操作を実行するための適切な権限を持っているかどうかが確認されます。権限の完全なリストはこちらで確認できます。権限は、1つまたは複数の役割を通じてユーザーに割り当てられます。
\nアクセストークンを取得するには：
\nコンタクトセンターの設定に新規のユーザーを作成します。
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user"],"query":[],"variable":[{"description":{"content":"コンタクトセンターのドメイン名（例：example.brightpattern.com）。
\n","type":"text/plain"},"type":"any","value":"","key":"tenant_url"}]}},"response":[{"id":"9ccf6c05-3bd5-453c-a3da-6c7fca19102b","name":"Create user with a complete data set","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"loginId\": \"testuser005\",\r\n \"password\": \"$$$999aaa\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"User005\",\r\n \"team\": \"Support Team\",\r\n \"extension\": \"2005\",\r\n \"workPhone\": \"6373335656\",\r\n \"mobilePhone\": \"6374128990\",\r\n \"email\": \"testuser005@nowhere.net\",\r\n \"disabled\": false,\r\n \"changePassword\": true,\r\n \"skills\": {\r\n \"Support\": 100,\r\n \"Mobile\": 100,\r\n \"Cable\": 70\r\n },\r\n \"roles\": [\r\n \"Agent\"\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://:tenant-URL/configapi/v2/user","protocol":"https","port":"tenant-URL","path":["configapi","v2","user"],"variable":[{"key":"tenant-URL","value":"yourcompany.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 25 Feb 2019 07:35:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"e3a16210-0f9f-4f44-aaa3-ac27ea39444e"},{"name":"Get User Data","id":"aba9d084-7573-41e7-9cc9-006a17ae265b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer名前、所属チーム、内線番号、スキル、ログイン情報などのユーザーデータを返します
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user",":username"],"query":[],"variable":[{"description":{"content":"データの照会対象となるユーザーのユーザー名です。
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"92c2ec43-f56e-411d-a172-806477cd796b","name":"Get user data","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer XXXXXXXX"}],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/user/:username","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","user",":username"],"variable":[{"key":"username","value":"testuser005","description":"[Username](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Users/ja#Username) of a BP user."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 25 Feb 2019 07:45:19 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"298"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"disabled\":false,\n \"changePassword\":false,\n \"skills\":{},\n \"loginId\":\"frank.zappa\",\n \"firstName\":\"Frank\",\n \"lastName\":\"Zappa\",\n \"team\":\"Customer Service\",\n \"extension\":\"1048\",\n \"email\":\"frank.zappa@gmail.com\",\n \"roles\":[\"Agent\"]\n \"loginInfo\": {\n \"isLoggedIn\": true,\n \"lastLogin\": \"2024-01-11T20:39:16.000Z\",\n \"lastLogout\": \"2024-01-11T20:39:16.000Z\",\n \"browser\": \"Chrome 120.0.0\",\n \"phoneMode\": \"Browser Secure\",\n \"os\": \"Linux\",\n \"ipAddress\": \"172.27.0.1\",\n \"userAgent\": \"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36\",\n \"adHelperVersion\": \"5.20.0.604\",\n \"appType\": \"Agent Desktop\",\n \"appVersion\": \"5.24.99.755\"\n }\n }"}],"_postman_id":"aba9d084-7573-41e7-9cc9-006a17ae265b"},{"name":"Update User ","id":"291ae1d9-4979-40a8-b0d2-92de50afb272","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer既存のユーザーの1つ以上の属性を更新します。現在、この機能を使用して以下のプロパティを更新できます：
\nデータを更新するユーザーのユーザー名です。
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"5bb82bdb-510b-4c3a-b3a7-5073a647e1b1","name":"Disable user via Update User","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"disabled\": \"true\",\r\n \"team\": \"Accounting\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/user/:username","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","user",":username"],"variable":[{"key":"username","value":"testuser004","description":"[Username](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Users/ja#Username) of the BPCC user."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 25 Feb 2019 22:51:50 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"291ae1d9-4979-40a8-b0d2-92de50afb272"},{"name":"Get User Lock State","id":"3621326a-2be0-4dca-920a-c6ff508ec287","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer無効なログイン試行が回数を越えたため、ユーザーのアカウントが一時的にロックされているかどうかを確認します。
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user","lock",":username"],"query":[],"variable":[{"description":{"content":"ロック状態を確認するユーザーのユーザー名です。
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"0a307e25-bbbd-4c23-a93d-ba83bc0566f9","name":"Get User Lock State","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/user/lock/:username","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","user","lock",":username"],"variable":[{"key":"username","value":"testuser005","description":"[Username](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Users/ja#Username) of the BPCC user."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 25 Feb 2019 23:05:12 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"18"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"lockedOut\": true\n}"}],"_postman_id":"3621326a-2be0-4dca-920a-c6ff508ec287"},{"name":"Clear User Lock State","id":"92c7ba80-257b-47ec-b8fc-c618d5afed98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer不正なログイン試行が繰り返されたために一時的にロックされたユーザーのアカウントのロックを解除します。
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user","lock",":username"],"query":[],"variable":[{"description":{"content":"ロックを解除するユーザーのユーザー名です。
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"41a3e74f-9851-4633-9ea2-0fc5545d3af5","name":"Clear User Lock State","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/user/lock/:username","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","user","lock",":username"],"variable":[{"key":"username","value":"testuser005","description":"[Username](https://help.brightpattern.com/latest:Contact-center-administrator-guide/UsersandTeams/Users/ja#Username) of the BPCC user."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 25 Feb 2019 23:06:15 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"19"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"lockedOut\": false\n}"}],"_postman_id":"92c7ba80-257b-47ec-b8fc-c618d5afed98"},{"name":"Delete User","id":"b8a7c9a7-9fe7-401a-b168-74f62439e1d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer既存のユーザーを削除します。
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user",":username"],"query":[],"variable":[{"description":{"content":"削除するユーザーのユーザー名です。
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"3a6a58f9-e9f1-461f-9254-3b66cbf737ae","name":"Delete User","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/configapi/v2/user/:username","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["configapi","v2","user",":username"],"variable":[{"key":"username","value":"eric.chen","description":"Username of the user to be deleted."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Mon, 22 Apr 2019 02:44:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"OK"}],"_postman_id":"b8a7c9a7-9fe7-401a-b168-74f62439e1d4"},{"name":"Get Teams","id":"c7204964-34b2-4efa-b560-da35fe89bc9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearerこのメソッドは、コンタクトセンター内に存在するすべてのチームのリストを返します。
\n","urlObject":{"protocol":"https","port":"tenant_URL","path":["configapi","v2","team"],"query":[],"variable":[]}},"response":[{"id":"fc892def-7e20-48a2-b6ab-12c8425d652b","name":"Get Teams","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":"https://yourcontactcenter.brightpattern.com/configapi/v2/team"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"name\": \"Administrators\"\n },\n {\n \"name\": \"Contact Center Support\"\n },\n {\n \"name\": \"CSIM Support\"\n },\n {\n \"name\": \"Customer Service\"\n },\n {\n \"name\": \"Maintenance Renewal\"\n },\n {\n \"name\": \"Management\"\n }\n]"}],"_postman_id":"c7204964-34b2-4efa-b560-da35fe89bc9d"}],"id":"18d9f86d-a40b-4cdb-af0f-f22e632aab43","description":"With the https://:tenant_url/configapi/v2/user endpoint you can:
\nBelow is a brief description of all user attributes that can be accessed via this API. More detailed descriptions of these attributes can be found here.
\n各ユーザーの内線番号および割り当てられた外部番号（DID）を含むユーザーリストを返します。
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","phone","user"],"query":[],"variable":[{"description":{"content":"コンタクトセンターのドメイン名（例：example.brightpattern.com）。
\n","type":"text/plain"},"type":"any","value":"","key":"tenant_url"}]}},"response":[{"id":"28633fcf-9157-4753-8b6e-0cbbbe5dc553","name":"Get Directory","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://:tenant/configapi/v2/phone/user","protocol":"https","port":"tenant","path":["configapi","v2","phone","user"],"variable":[{"key":"tenant","value":"yourcompany.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Tue, 26 Feb 2019 00:16:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1072"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"extension\": \"1000\",\n \"loginId\": \"user\",\n \"firstName\": \"User\",\n \"lastName\": \"Lastname\",\n \"external\": \"16505555555\",\n \"voiceMail\": true,\n \"greeting\": false\n },\n {\n \"extension\": \"1001\",\n \"loginId\": \"navarro\",\n \"firstName\": \"Jose\",\n \"lastName\": \"Navarro\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"1002\",\n \"loginId\": \"wandabui\",\n \"firstName\": \"Wanda\",\n \"lastName\": \"Bui\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"1004\",\n \"loginId\": \"dale.turner\",\n \"firstName\": \"Dale\",\n \"lastName\": \"Turner\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"1005\",\n \"loginId\": \"edna.partee\",\n \"firstName\": \"Edna\",\n \"lastName\": \"Partee\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"1006\",\n \"loginId\": \"eric.chen\",\n \"firstName\": \"Eric\",\n \"lastName\": \"Chen\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"1007\",\n \"loginId\": \"admin\",\n \"firstName\": \"API\",\n \"lastName\": \"User\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"2004\",\n \"loginId\": \"testuser004\",\n \"firstName\": \"Test\",\n \"lastName\": \"User004\",\n \"voiceMail\": false,\n \"greeting\": false\n },\n {\n \"extension\": \"2005\",\n \"loginId\": \"testuser005\",\n \"firstName\": \"Test\",\n \"lastName\": \"User005\",\n \"voiceMail\": false,\n \"greeting\": false\n }\n]"}],"_postman_id":"1c431437-85c1-41e7-8f3e-16c0237db03c"},{"name":"Get Access Numbers","id":"6276f57d-cb9a-4243-842d-088a72e4dcf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer現在割り当てられているアクセス番号のリストを返します。
\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","phone","ext"],"query":[],"variable":[{"description":{"content":"コンタクトセンターのドメイン名（例：example.brightpattern.com）。
\n","type":"text/plain"},"type":"any","value":"","key":"tenant_url"}]}},"response":[{"id":"7bf96f93-dfd1-4b19-b74d-031d8f9c6995","name":"Get Access Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://:tenant/configapi/v2/phone/ext","protocol":"https","port":"tenant","path":["configapi","v2","phone","ext"],"variable":[{"key":"tenant","value":"yourcompany.brightpattern.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Tue, 26 Feb 2019 00:07:42 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"91"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"number\": \"16505555555\",\n \"media\": \"voice_text\",\n \"type\": \"scenario\",\n \"scenario\": \"Main Inbound\"\n }\n]"}],"_postman_id":"6276f57d-cb9a-4243-842d-088a72e4dcf0"}],"id":"5461d661-7843-4397-bdff-7ec969ed2c38","description":"https://:tenant/configapi/v2/phone エンドポイントを使用すると、以下のことができます：
\n