{"info":{"_postman_id":"1f855e9c-58e3-4d05-aad1-fe23a9d60370","name":"BPCC Configuration API","description":"

With the Bright Pattern Contact Center (BPCC) Configuraiton API you currently can:

Create, update and delete your contact center users.
Assign and change agent skills and update skill levels.
Unlock a user account that may have been locked according to the security policy.
Get a list of all existing users with their internal and external (DID) phone numbers.
Get a list of all existing extenal numbers with thier current assignments (DID, routing points, etc.)

This document specifies the corresponding REST API methods, with example requests and responses. You can load this API into the Postman API Development Environment to interact with the API with your own access tokens.

Notes

Either HTTP or HTTPS transport can be configured. The same setting applies to the entire Configuration Web Portal server. For production deployments on public Internet only, HTTPS is enabled.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6711197","collectionId":"1f855e9c-58e3-4d05-aad1-fe23a9d60370","publishedId":"S1EUtanN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-03T02:11:12.000Z"},"item":[{"name":"Authentication","item":[{"name":"Get Access Token","id":"e44ccfc8-15e6-4baf-8f2c-727c62e8a56a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"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":"","description":"

Username 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":"

Returns an access token that will be used to authenticate each subsequent request made via this API.

\n","urlObject":{"protocol":"https","port":"tenant-URL","path":["configapi","v2","oauth","token"],"query":[],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"boromir.bugfocus.com","key":"tenant-URL"}]}},"response":[{"id":"43618db3-fda9-4ac6-9318-8170945fd838","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/5.3:Contact-center-administrator-guide/Users#Username) of a BP user authorized to [manage users](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Privileges#Manage_users) and/or [phones](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/Privileges#Manage_phones).","type":"text"},{"key":"client_secret","value":"X0vhlwMc6YoEbQDDqQGM9nOw8p7v9110rjTL1COxGBnpIAZvY6ryrrBQT5N28qS9","description":"[API secret key](https://help.brightpattern.com/5.3:Contact-center-administrator-guide/UsersandTeams/Users#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":"e44ccfc8-15e6-4baf-8f2c-727c62e8a56a"}],"id":"a7ee14bb-8948-43c7-8f61-0ba8fcea4d84","description":"

The OAuth 2.0 Client Credentials Grant is used to authenticate clients of this API. The authenticated user is checked for having appropriate privileges to perform the requested operation. The complete list of privileges can be found here. Privileges are assigned to users via one or more Roles.

To obtain an access token:

Login to your BPCC configuraiton portal.
Navigate to Users page.
Select or create a user with privileges corresponding to the tasks you wish to perform via the BPCC Configuraiton API.
Click the Generate button to generate an API secret key. Copy the generated key and note the username for the next steps.
Use the Get Access Token method to obtain an access token. Set the client_id to the username and client_secret to the generated API secrect key.
Use the value of access_token returned in the response to set the Authorization: Bearer [access token] header of each subsequent request made via the BPCC Configuraiton API.

\n","event":[{"listen":"prerequest","script":{"id":"830434b2-fdf6-4177-acf1-6ecaaa137df8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6541e414-87ee-4fbb-a0fc-359229bd1659","type":"text/javascript","exec":[""]}}],"_postman_id":"a7ee14bb-8948-43c7-8f61-0ba8fcea4d84"},{"name":"Users","item":[{"name":"Create User","id":"bd617cc7-5fc8-4a52-a029-c2126f1d76f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"loginId\": \"testuser006\",\r\n \"password\": \"$$$999aaa\",\r\n \"firstName\": \"Test\",\r\n \"lastName\": \"User006\",\r\n \"team\": \"Support Team\",\r\n \"workPhone\": \"6373335656\",\r\n \"mobilePhone\": \"6374128990\",\r\n \"email\": \"testuser006@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}"},"url":"https://:tenant_url/configapi/v2/user","description":"

Creates a new user in your contact center configuration.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user"],"query":[],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[{"id":"3ecd3d34-b69b-4654-878b-f0e8ff75185d","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":"bd617cc7-5fc8-4a52-a029-c2126f1d76f4"},{"name":"Get User Data","id":"3f951cb4-137f-4785-8805-12630fd2c200","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer "}],"url":"https://:tenant_url/configapi/v2/user/:username","description":"

Returns user data, such as name, team, extension, skills, and login information

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user",":username"],"query":[],"variable":[{"description":{"content":"

Username of the user whose data is requested.

\n","type":"text/plain"},"type":"string","value":"","key":"username"}]}},"response":[{"id":"8aebf8b4-a0a1-4c83-acf2-8b0056d391e1","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/5.2:Contact-center-administrator-guide/Users#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":"3f951cb4-137f-4785-8805-12630fd2c200"},{"name":"Update User ","id":"7dc826bb-4d67-437f-a6bb-03a99ce4dbbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"disabled\": \"true\",\r\n \"team\": \"Accounting\"\r\n}"},"url":"https://:tenant_url/configapi/v2/user/:username","description":"

Updates one or more attributes of an existing user. Currently the can be used to update the following properties:

skills
disabled
password
changePassword
team

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user",":username"],"query":[],"variable":[{"description":{"content":"

Username of the user whose data is to be updated.

\n","type":"text/plain"},"type":"string","value":"","key":"username"}]}},"response":[{"id":"99035590-d165-4176-a9a1-4fb5bee5923b","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/5.2:Contact-center-administrator-guide/Users#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":"7dc826bb-4d67-437f-a6bb-03a99ce4dbbd"},{"name":"Get User Lock State","id":"5d3f7cce-fd05-4aa6-9447-45923a58c8e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://:tenant_url/configapi/v2/user/lock/:username","description":"

Checks whether user's account has been temporarily locked out after too many invalid login attempts.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user","lock",":username"],"query":[],"variable":[{"description":{"content":"

Username of the user whose lock state is to be checked.

\n","type":"text/plain"},"type":"string","value":"","key":"username"}]}},"response":[{"id":"b088bc7e-35c0-429e-8b5e-630e4d4f1824","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/5.2:Contact-center-administrator-guide/Users#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":"5d3f7cce-fd05-4aa6-9447-45923a58c8e6"},{"name":"Clear User Lock State","id":"c0317dec-0685-488a-b55f-b4de2ebed7df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://:tenant_url/configapi/v2/user/lock/:username","description":"

Unlocks user's account that has been temporarily locked out after too many invalid login attempts.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user","lock",":username"],"query":[],"variable":[{"description":{"content":"

Username of the user to be unlocked.

\n","type":"text/plain"},"type":"string","value":"","key":"username"}]}},"response":[{"id":"2766f68b-928f-4760-bc69-e1e6693bc609","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/5.2:Contact-center-administrator-guide/Users#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":"c0317dec-0685-488a-b55f-b4de2ebed7df"},{"name":"Delete User","id":"77572468-23da-4b41-878b-1d6a7173936e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"DELETE","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://:tenant_url/configapi/v2/user/:username","description":"

Deletes an existing user.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","user",":username"],"query":[],"variable":[{"description":{"content":"

Username of the user to be deleted.

\n","type":"text/plain"},"type":"string","value":"","key":"username"}]}},"response":[{"id":"4fa33e84-8538-4da7-863b-a36c18f4ee37","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":"77572468-23da-4b41-878b-1d6a7173936e"},{"name":"Get Teams","id":"ebfd4da3-823c-4777-a716-d2032f5e714a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://:tenant_URL/configapi/v2/team","description":"

This method returns a list of all existing teams in your contact center.

\n","urlObject":{"protocol":"https","port":"tenant_URL","path":["configapi","v2","team"],"query":[],"variable":[]}},"response":[{"id":"7eba4d75-d34f-4253-aa30-edd1ed6200cb","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":"ebfd4da3-823c-4777-a716-d2032f5e714a"}],"id":"07429641-ac88-42d3-95c4-b765c19e8ae0","description":"

With the https://:tenant_url/configapi/v2/user endpoint you can:

Create new users and define most of their attributes
Update existing users
Check and clear user lockout state
Manage agents' skills
Delete existing users

Below 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.

All attributes are strings unless otherwise noted.
All attributes are optional unless otherwise noted.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Attribute	Description
loginId	Username. Required to create user. Used to identify the user in all subsequent User Management API operations.
password	Password. Format must comply with security policy.
changePassword	Indicates whether user must change password on next login. Boolean. Default is false.
firstName	First name. Required to create user.
lastName	Last name. Required to create user.
team	Team that the user is assigned to. Required to create user.
extension	User's extension number. If not specified, an extension will be created and assigned automatically.
workPhone	User's work phone number.
mobilePhone	User's mobile phone number.
email	User's email address.
disabled	Indication whether the user account is disabled or enabled. Boolean (true/flase).
skills	For agents an array of skills with levels (e.g., \"Support\": 75).
roles	An array of user's roles (e.g., Agent).

","event":[{"listen":"prerequest","script":{"id":"9efd7ea2-dc6b-42c7-8ca6-f9ea0f325188","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cdd514ba-915a-4bcd-839a-0570ebd9d6ea","type":"text/javascript","exec":[""]}}],"_postman_id":"07429641-ac88-42d3-95c4-b765c19e8ae0"},{"name":"Phones","item":[{"name":"Get Directory","id":"18eeb7dd-6ba9-4035-8e1c-f7c0dd715d46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://:tenant_url/configapi/v2/phone/user","description":"

Returns list of users with thier extensions and assigned external (DID) numbers.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","phone","user"],"query":[],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[{"id":"5ee5a768-3384-4f18-92af-0cc1d60a133a","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":"18eeb7dd-6ba9-4035-8e1c-f7c0dd715d46"},{"name":"Get Access Numbers","id":"e024d71b-8b16-46c4-9fd2-26ce52750d54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text"}],"url":"https://:tenant_url/configapi/v2/phone/ext","description":"

Returns a list of access numbers with current assignments.

\n","urlObject":{"protocol":"https","port":"tenant_url","path":["configapi","v2","phone","ext"],"query":[],"variable":[{"description":{"content":"

Your contact center domain name, e.g., example.brightpattern.com.

\n","type":"text/plain"},"type":"string","value":"","key":"tenant_url"}]}},"response":[{"id":"dcab109e-63f4-495b-9bfb-902fd87e9b08","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":"e024d71b-8b16-46c4-9fd2-26ce52750d54"}],"id":"1fb70f69-56b6-4190-ad4c-e5835944fe6a","description":"

With the https://:tenant/configapi/v2/phone endpoint you can:

Get a list of all contact center users with their extensions and DID numbers
Get a list of all access numbers with thier current assignments (assigned users for DIDs and assigned scenarios for routing points)

\n","event":[{"listen":"prerequest","script":{"id":"6794d6f5-999d-4cb0-829d-6959398ad43e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5c345008-e387-4d9a-9c27-b35112c8a424","type":"text/javascript","exec":[""]}}],"_postman_id":"1fb70f69-56b6-4190-ad4c-e5835944fe6a"},{"name":"Error Codes","item":[],"id":"2046c86a-7853-4edf-8cfd-b499a92ab97a","description":"

400 Bad Request - Indicates that the requested operation cannot be performed either because it violates data integrity rules or not supported by the API. The body of the error message may contain information about a specific element of the request (e.g., a specific object property) that is causing the request to be rejected.
\n
404 Not Found - For GET methods, indicates that the requested object cannot be found. For POST and PUT methods, indicates that one of the objects referred to in the properties specified in the request cannot be found. The body of the error message may indicate the type of object that could not be found (e.g., user team not found).
\n
409 Conlict - Indicates that an object with the given value of a unique parameter (e.g., username) already exists.
\n
415 Unsupported Media Type - The media type is either not specified or specified incorrectly.
\n
500 Request Failed - Incorrect endpoint specification.
\n

\n","event":[{"listen":"prerequest","script":{"id":"ac38d5c5-5a7d-4e9b-bbc3-26257f04957f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a87c926b-7d3e-47ba-900a-9fd2c1b32830","type":"text/javascript","exec":[""]}}],"_postman_id":"2046c86a-7853-4edf-8cfd-b499a92ab97a"}],"event":[{"listen":"prerequest","script":{"id":"2ce1b78e-67eb-400d-b684-230f2796d7e4","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"85c3d2a4-8697-4260-aa27-ecf4f85f1876","type":"text/javascript","exec":[""]}}]}