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.
\nUsername of a CX user authorized to manage users and/or phones.
\n","type":"text"},{"key":"client_secret","value":"myapikeyhereXXXXXXXXXXXXXXXXXX","description":"API secret key generated for the above user.
\n","type":"text"},{"key":"scope","value":"mytenant.cx.onecloud.com","description":"Your contact center domain name, e.g., example.cx.onecloud.com.
\n","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Grant type. Must be set to client_credentials.
\n","type":"text"}]},"url":"https://mytenant.cx.onecloud.com/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","path":["configapi","v2","oauth","token"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"fafe0b1f-c60a-48d9-a1d2-2811a411747a","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 of a CX user authorized to manage users and/or phones.","type":"text"},{"key":"client_secret","value":"X0vhlwMc6YoEbQDDqQGM9nOw8p7v9110rjTL1COxGBnpIAZvY6ryrrBQT5N28qS9","description":"[API secret key] generated for the above user.","type":"text"},{"key":"scope","value":"example.cx.onecloud.com","description":"Your contact center domain name, e.g., *example.cx.onecloud.com*.","type":"text"},{"key":"grant_type","value":"client_credentials","description":"Grant type. Must be set to *client_credentials*.","type":"text"}]},"url":"https://mytenant.cx.onecloud.com/configapi/v2/oauth/token"},"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\": \"example.cx.onecloud.com\"\n}"}],"_postman_id":"f5d49557-0235-4ef8-8bf1-4f1ae41f8c09"}],"id":"931d70f6-62d1-43bc-ab70-d5374cfd38a3","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. Privileges are assigned to users via one or more Roles.
\nTo obtain an access token:
\nCreates a new user in your contact center configuration.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","user"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"e5da634e-14af-466a-9d8d-58cd0a4b9575","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 myapikeyhereXXXXXXXXXXXXXXXXXX","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":"https://mytenant.cx.onecloud.com/configapi/v2/user"},"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":""}],"_postman_id":"45a609ba-e506-4beb-bf46-00cf7539a384"},{"name":"Get User Data","id":"c0eaabe6-9b93-4f87-b504-3f2dfa992bde","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/user/:username","description":"Returns detailed configuraiton information about an existing user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","user",":username"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"1ed3cff4-1a12-4b49-a700-8d4cb1140aab","description":{"content":"Username of the user whose data is requested.
\n","type":"text/plain"},"type":"string","value":"admin","key":"username"}]}},"response":[{"id":"d6505df9-15aa-416b-9b77-6fa463e2752c","name":"Get user data","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Bearer XXXXXXXX"}],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/user/:username","protocol":"https","host":["mytenant.cx.onecloud.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\": true,\n \"skills\": {\n \"Cable\": 70,\n \"Support\": 100,\n \"Mobile\": 100\n },\n \"loginId\": \"testuser005\",\n \"firstName\": \"Test\",\n \"lastName\": \"User005\",\n \"team\": \"Support Team\",\n \"extension\": \"2005\",\n \"workPhone\": \"6373335656\",\n \"mobilePhone\": \"6374128990\",\n \"email\": \"testuser005@nowhere.net\",\n \"roles\": [\n \"Agent\"\n ]\n}"}],"_postman_id":"c0eaabe6-9b93-4f87-b504-3f2dfa992bde"},{"name":"Update User ","id":"e5bb1952-95d6-4744-8c1c-8d8c4cefb3ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"disabled\": \"true\",\r\n \"team\": \"Accounting\"\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/user/:username","description":"Updates one or more attributes of an existing user. Currently the can be used to update the following properties:
\nUsername of the user whose data is to be updated.
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"e72091e1-c609-47d0-a18c-0e9be771c729","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://mytenant.cx.onecloud.com/configapi/v2/user/:username","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","user",":username"],"variable":[{"key":"username","value":"testuser004","description":"Username of the OneCloud CX 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":""}],"_postman_id":"e5bb1952-95d6-4744-8c1c-8d8c4cefb3ea"},{"name":"Get User Lock State","id":"dea7e525-021c-4fd3-ad53-b44624a03e95","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/user/lock/:username","description":"Checks whether user's account has been temporarily locked out after too many invalid login attempts.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","user","lock",":username"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"0abcd69f-f29e-46df-b6d5-b94821667b77","description":{"content":"Username of the user whose lock state is to be checked.
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"d52770a0-f99f-4e63-829a-6fdb35b4d8d9","name":"Get User Lock State","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/user/lock/:username","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","user","lock",":username"],"variable":[{"key":"username","value":"testuser005","description":"Username of the OneCloud CX 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":"dea7e525-021c-4fd3-ad53-b44624a03e95"},{"name":"Clear User Lock State","id":"c0f28384-3aaa-41f0-964d-3c25e7b11556","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/user/lock/:username","description":"Unlocks user's account that has been temporarily locked out after too many invalid login attempts.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","user","lock",":username"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"28f6bb43-455a-4360-808c-b832cc8e2513","description":{"content":"Username of the user to be unlocked.
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"082e4275-5ddd-4201-a03b-729b30af2b3a","name":"Clear User Lock State","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/user/lock/:username","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","user","lock",":username"],"variable":[{"key":"username","value":"testuser005","description":"Username of the OneCloud CX 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":"c0f28384-3aaa-41f0-964d-3c25e7b11556"},{"name":"Delete User","id":"e38c373b-1665-4522-950e-5dea8ef60d7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/user/:username","description":"Deletes an existing user.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","user",":username"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"2820433d-00cc-4938-a990-88e77ec4ef97","description":{"content":"Username of the user to be deleted.
\n","type":"text/plain"},"type":"any","value":"","key":"username"}]}},"response":[{"id":"afecff37-6093-48e0-9e41-d0bf62da0d2e","name":"Delete User","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/user/:username","protocol":"https","host":["mytenant.cx.onecloud.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":""}],"_postman_id":"e38c373b-1665-4522-950e-5dea8ef60d7a"},{"name":"Get Teams","id":"51642bf5-14e1-49d1-8804-8d136294adc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/team","description":"This method returns a list of all existing teams in your contact center.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","team"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"934bde48-0b50-4926-83bd-1ada05a64de1","name":"Get Teams","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/team"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"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":"51642bf5-14e1-49d1-8804-8d136294adc0"}],"id":"5aa57d88-2156-4221-ba87-f91810f34268","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.
\nThis method creates a new user in your contact center configuration.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","scim","users"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"408012a4-5e16-42e5-af23-6330f25bfa6e","name":"Create user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"userName\": \"bjensen@example.com\",\n \"name\": {\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\"\n },\n \"nickName\": \"Babs\",\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\"\n }\n ],\n \"addresses\": [\n {\n \"locality\": \"Hollywood\",\n \"region\": \"CA\",\n \"country\": \"US\"\n }\n ],\n \"phoneNumbers\": [\n {\n \"value\": \"555-555-5555\",\n \"type\": \"work\"\n },\n {\n \"value\": \"555-555-4444\",\n \"type\": \"mobile\"\n }\n ],\n \"photos\": [\n {\n \"value\": \"https://secure.gravatar.com/avatar/506c1f645ad2266f2353a50230c52f84.jpg\",\n \"type\": \"photo\"\n }\n ],\n \"title\": \"TSR Level 3\",\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Location","value":"http://localhost:8080/configapi/v2/scim/users/65625121-E207-4AA6-9C9D-317EE309FFBA"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"696"},{"key":"Server","value":"Jetty(9.4.12.v20180830)"}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"65625121-E207-4AA6-9C9D-317EE309FFBA\",\n \"externalId\": \"\",\n \"meta\": {\n \"resourceType\": \"USER\",\n \"location\": \"http://tenant.cx.onecloud.com/configapi/v2/scim/users/65625121-E207-4AA6-9C9D-317EE309FFBA\"\n },\n \"userName\": \"bjensen@example.com\",\n \"nickName\": \"Babs\",\n \"name\": {\n \"familyName\": \"Jensen\",\n \"givenName\": \"Barbara\"\n },\n \"title\": \"TSR Level 3\",\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true,\n \"emails\": [\n {\n \"value\": \"bjensen@example.com\",\n \"primary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"work\",\n \"value\": \"555-555-5555\"\n },\n {\n \"type\": \"mobile\",\n \"value\": \"555-555-4444\"\n },\n {\n \"type\": \"extension\",\n \"value\": \"2083\"\n }\n ],\n \"addresses\": [\n {\n \"locality\": \"Hollywood\",\n \"country\": \"US\"\n }\n ],\n \"roles\": [\n \"System Administrator\"\n ]\n}"}],"_postman_id":"412f70cb-7cae-4273-951e-85dd20c35332"},{"name":"Get User by ID","id":"f945a6cb-091c-4ccd-b8a8-1abb20cf00f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json OR application/scim+json","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/:id","description":"This method returns detailed configuration information about an existing user via the user’s ID.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","scim","users",":id"],"host":["mytenant.cx.onecloud.com"],"query":[{"disabled":true,"key":"","value":""}],"variable":[{"id":"9c6e61e3-d5f9-4e08-8e1b-a23db6ae533f","description":{"content":"The ID of the user whose data is requested (e.g., 5974D6AE-66BD-4B2A-A9D6-1AEADD18F669)
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"353b1828-da47-4992-bd03-b0afa972ba0d","name":"Get User by ID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/5974D6AE-66BD-4B2A-A9D6-1AEADD18F669"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"696"},{"key":"Server","value":"Jetty(9.4.12.v20180830)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n ],\r\n \"id\": \"5974D6AE-66BD-4B2A-A9D6-1AEADD18F669\",\r\n \"meta\": {\r\n \"resourceType\": \"USER\",\r\n \"created\": \"06-03-2020T10:04:30\",\r\n \"lastModified\": \"06-03-2020T10:35:28\",\r\n \"location\": \"http://tenant.cx.onecloud.com/configapi/v2/scim/users/5974D6AE-66BD-4B2A-A9D6-1AEADD18F669\"\r\n },\r\n \"userName\": \"elizabeth\",\r\n \"name\": {\r\n \"familyName\": \"Smith\",\r\n \"givenName\": \"Liza\"\r\n },\r\n \"active\": true,\r\n \"emails\": [\r\n {\r\n \"value\": \"liza@smith.com\",\r\n \"primary\": true\r\n }\r\n ],\r\n \"phoneNumbers\": [\r\n {\r\n \"type\": \"extension\",\r\n \"value\": \"2064\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {}\r\n ],\r\n \"roles\": [\r\n \"System Administrator\",\r\n \"Campaign Administrator\",\r\n \"Supervisor\",\r\n \"Quality Evaluator\",\r\n \"Quality Evaluator Admin\",\r\n \"Security Administrator\",\r\n \"Campaign Operator\",\r\n \"Service Administrator\",\r\n \"Reviewer\",\r\n \"Manager\",\r\n \"Agent\"\r\n ]\r\n}"}],"_postman_id":"f945a6cb-091c-4ccd-b8a8-1abb20cf00f6"},{"name":"Replace User Properties (by replacing all existing attributes with a specified set of replacement attributes)","id":"3a882114-8fbc-47c8-b3c6-0eda9f7962fa","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n ],\r\n \"userName\": \"bjinsin\",\r\n \"name\": {\r\n \"familyName\": \"Jinsin\",\r\n \"givenName\": \"Borbora\"\r\n },\r\n \"nickName\": \"Bobs\",\r\n \"emails\": [\r\n {\r\n \"value\": \"bjinsin@example.com\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"locality\": \"Hollywood\",\r\n \"region\": \"CA\",\r\n \"country\": \"US\"\r\n }\r\n ],\r\n \"phoneNumbers\": [\r\n {\r\n \"value\": \"555-555-5555\",\r\n \"type\": \"work\"\r\n },\r\n {\r\n \"value\": \"888-888-8888\",\r\n \"type\": \"mobile\"\r\n }\r\n ],\r\n \"title\": \"TSR Level 3\",\r\n \"timezone\": \"America/Los_Angeles\",\r\n \"active\": true\r\n}\r\n"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/:id","description":"Replaces all attributes of an existing user with a specified set of replacement attributes. Note that in accordance with RFC7644, the PUT method updates users by replacing all of their current attributes with the ones specified in the body of the method.
\nNote also that in order for usernames to be changed, service providers must allow this feature for your contact center. For more information, see the CX Administrator Guide, section Users.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","scim","users",":id"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"aaf28802-767a-4aa9-92df-ead7271ff887","description":{"content":"The ID of the user whose data is to be updated (e.g., 5974D6AE-66BD-4B2A-A9D6-1AEADD18F669)
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"0ef69ff9-44c1-4485-99fb-d122f9a64057","name":"Replace User","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n ],\r\n \"userName\": \"bjinsin\",\r\n \"name\": {\r\n \"familyName\": \"Jinsin\",\r\n \"givenName\": \"Borbora\"\r\n },\r\n \"nickName\": \"Bobs\",\r\n \"emails\": [\r\n {\r\n \"value\": \"bjinsin@example.com\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"locality\": \"Hollywood\",\r\n \"region\": \"CA\",\r\n \"country\": \"US\"\r\n }\r\n ],\r\n \"phoneNumbers\": [\r\n {\r\n \"value\": \"555-555-5555\",\r\n \"type\": \"work\"\r\n },\r\n {\r\n \"value\": \"888-888-8888\",\r\n \"type\": \"mobile\"\r\n }\r\n ],\r\n \"title\": \"TSR Level 3\",\r\n \"timezone\": \"America/Los_Angeles\",\r\n \"active\": true\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/7D6A5564-2104-442F-82DA-D55B6D7CFAE9"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"660"},{"key":"Server","value":"Jetty(9.4.12.v20180830)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n ],\r\n \"id\": \"7D6A5564-2104-442F-82DA-D55B6D7CFAE9\",\r\n \"meta\": {\r\n \"resourceType\": \"USER\",\r\n \"created\": \"09-03-2020T05:58:01\",\r\n \"lastModified\": \"09-03-2020T09:21:44\",\r\n \"location\": \"http://tenant.cx.onecloud.com/configapi/v2/scim/users/7D6A5564-2104-442F-82DA-D55B6D7CFAE9\"\r\n },\r\n \"userName\": \"bjinsin\",\r\n \"nickName\": \"Bobs\",\r\n \"name\": {\r\n \"familyName\": \"Jinsin\",\r\n \"givenName\": \"Borbora\"\r\n },\r\n \"title\": \"TSR Level 3\",\r\n \"timezone\": \"America/Los_Angeles\",\r\n \"active\": true,\r\n \"emails\": [\r\n {\r\n \"value\": \"bjinsin@example.com\",\r\n \"primary\": true\r\n }\r\n ],\r\n \"phoneNumbers\": [\r\n {\r\n \"type\": \"work\",\r\n \"value\": \"555-555-5555\"\r\n },\r\n {\r\n \"type\": \"mobile\",\r\n \"value\": \"888-888-8888\"\r\n },\r\n {\r\n \"type\": \"extension\",\r\n \"value\": \"2065\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {\r\n \"locality\": \"Hollywood\",\r\n \"region\": \"CA\",\r\n \"country\": \"US\"\r\n }\r\n ],\r\n \"roles\": []\r\n}\r\n"}],"_postman_id":"3a882114-8fbc-47c8-b3c6-0eda9f7962fa"},{"name":"Update User (updates only the properties indicated in the specified set)","id":"a9d98283-3e93-4bff-886c-b19724c1a434","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\r\n ],\r\n \"Operations\":[\r\n {\r\n \"op\":\"replace\",\r\n \"path\":\"active\",\r\n \"value\": false\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC","description":"Updates attributes of an existing user. Note that in accordance with RFC7644, the PATCH method modifies a user with a set of client-specified changes (partial update).
\nNote also that in order for usernames to be changed, service providers must allow this feature for your contact center. For more information, see the Contact Center Administrator Guide, section Users.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","scim","users","6BE15F09-BF39-4E20-AB31-A9355CBC01FC"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"e578bd3f-60e6-4083-b6b0-7ffff76c7544","name":"Update User (updates only the properties indicated in the specified set)","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json OR application/scim+json","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:api:messages:2.0:PatchOp\"\r\n ],\r\n \"Operations\":[\r\n {\r\n \"op\":\"replace\",\r\n \"path\":\"active\",\r\n \"value\": false\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.10"},{"key":"Date","value":"Fri, 01 Apr 2022 01:07:15 GMT"},{"key":"Content-Type","value":"application/scim+json"},{"key":"Content-Length","value":"707"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"6BE15F09-BF39-4E20-AB31-A9355CBC01FC\",\n \"meta\": {\n \"resourceType\": \"USER\",\n \"lastModified\": \"2022-04-01T01:07:15\",\n \"location\": \"http://alexei-maintenance.pl.bugfocus.com/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC\"\n },\n \"userName\": \"carlos.clapper\",\n \"name\": {\n \"familyName\": \"Clapper\",\n \"givenName\": \"Carlos\"\n },\n \"timezone\": \"America/Los_Angeles\",\n \"active\": false,\n \"emails\": [\n {\n \"value\": \"carlos.clapper@servicepattern.sb.office\",\n \"primary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"extension\",\n \"value\": \"2025\"\n }\n ],\n \"addresses\": [],\n \"roles\": [\n {\n \"value\": \"System Administrator\"\n },\n {\n \"value\": \"Agent\"\n }\n ],\n \"groups\": [\n {\n \"value\": \"84FB1AD4-1B27-4CFA-A1E0-B8A972F3EFA7\",\n \"display\": \"CSIM Support\"\n }\n ]\n}"}],"_postman_id":"a9d98283-3e93-4bff-886c-b19724c1a434"},{"name":"Delete User","id":"ae8ab602-b218-4dae-82a9-8170797583d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json OR application/scim+json"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users/:id","description":"Deletes an existing user
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","scim","users",":id"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"005f9c76-2063-467c-94ef-636d96981c2b","description":{"content":"The ID of the user to be deleted (e.g., 7D6A5564-2104-442F-82DA-D55B6D7CFAE9)
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"dae741bb-9241-419d-8057-52d86035c483","name":"Delete User","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"url":"https://yourcompany.brightpattern.com/configapi/v2/scim/users/7D6A5564-2104-442F-82DA-D55B6D7CFAE9"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"Jetty(9.4.12.v20180830)"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ae8ab602-b218-4dae-82a9-8170797583d8"},{"name":"Get User by userName","event":[{"listen":"test","script":{"id":"a7e98e3b-931b-4fb0-b023-6c44f01a04a7","exec":[""],"type":"text/javascript"}}],"id":"a0680517-5c7d-493c-b000-6b9099d6282a","protocolProfileBehavior":{"disableBodyPruning":true,"followOriginalHttpMethod":true,"disabledSystemHeaders":{"connection":true}},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users?filter=userName%20eq%20%22carlos.clapper%22","description":"This method returns detailed configuration information about an existing user via the userName filter.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","scim","users"],"host":["mytenant.cx.onecloud.com"],"query":[{"key":"filter","value":"userName%20eq%20%22carlos.clapper%22"}],"variable":[]}},"response":[{"id":"3c3649d9-f24f-431b-8893-787400ab074d","name":"Get User by userName","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users?filter=userName eq \"carlos.clapper\"","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","scim","users"],"query":[{"key":"filter","value":"userName eq \"carlos.clapper\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/scim+json"},{"key":"Content-Length","value":"861"},{"key":"Server","value":"Jetty(9.4.12.v20180830)"}],"cookie":[],"responseTime":null,"body":"{\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\r\n ],\r\n \"totalResults\": 1,\r\n \"Resources\": [\r\n {\r\n \"schemas\": [\r\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\r\n ],\r\n \"id\": \"1F148A86-BF13-4478-A102-F11A8B664FF8\",\r\n \"meta\": {\r\n \"resourceType\": \"USER\",\r\n \"created\": \"06-03-2020T07:46:33\",\r\n \"location\": \"http://yourcompany.cx.onecloud.com/configapi/v2/scim/users/1F148A86-BF13-4478-A102-F11A8B664FF8\"\r\n },\r\n \"userName\": \"carlos.clapper\",\r\n \"name\": {\r\n \"familyName\": \"Clapper\",\r\n \"givenName\": \"Carlos\"\r\n },\r\n \"active\": true,\r\n \"emails\": [\r\n {\r\n \"value\": \"carlos.clapper@contactcenter.office\",\r\n \"primary\": true\r\n }\r\n ],\r\n \"phoneNumbers\": [\r\n {\r\n \"type\": \"extension\",\r\n \"value\": \"2025\"\r\n }\r\n ],\r\n \"addresses\": [\r\n {}\r\n ],\r\n \"roles\": [\r\n \"Agent\"\r\n ]\r\n }\r\n ]\r\n}\r\n"},{"id":"21e3772b-58a0-4a35-8966-d3f5c28d0ae1","name":"Get User by userName","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json OR application/scim+json","type":"text","disabled":true}],"body":{"mode":"raw","raw":""},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/scim/users?filter=userName%20eq%20%22carlos.clapper%22","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","scim","users"],"query":[{"key":"filter","value":"userName%20eq%20%22carlos.clapper%22"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.19.10"},{"key":"Date","value":"Tue, 15 Mar 2022 23:22:39 GMT"},{"key":"Content-Type","value":"application/scim+json"},{"key":"Content-Length","value":"806"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"schemas\": [\n \"urn:ietf:params:scim:api:messages:2.0:ListResponse\"\n ],\n \"totalResults\": 1,\n \"Resources\": [\n {\n \"schemas\": [\n \"urn:ietf:params:scim:schemas:core:2.0:User\"\n ],\n \"id\": \"6BE15F09-BF39-4E20-AB31-A9355CBC01FC\",\n \"meta\": {\n \"resourceType\": \"USER\",\n \"lastModified\": \"2022-03-15T09:41:34\",\n \"location\": \"http://alexei-maintenance.pl.bugfocus.com/configapi/v2/scim/users/6BE15F09-BF39-4E20-AB31-A9355CBC01FC\"\n },\n \"userName\": \"carlos.clapper\",\n \"name\": {\n \"familyName\": \"Clapper\",\n \"givenName\": \"Carlos\"\n },\n \"timezone\": \"America/Los_Angeles\",\n \"active\": true,\n \"emails\": [\n {\n \"value\": \"carlos.clapper@servicepattern.sb.office\",\n \"primary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"type\": \"extension\",\n \"value\": \"2025\"\n }\n ],\n \"addresses\": [\n {}\n ],\n \"roles\": [\n {\n \"value\": \"System Administrator\"\n },\n {\n \"value\": \"Agent\"\n }\n ],\n \"groups\": [\n {\n \"value\": \"84FB1AD4-1B27-4CFA-A1E0-B8A972F3EFA7\",\n \"display\": \"CSIM Support\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"a0680517-5c7d-493c-b000-6b9099d6282a"}],"id":"f8f3540b-5b50-4ee1-b43e-81fb8f5a7d16","description":"With the https://mytenant.cx.onecloud.com/configapi/v2/scim/users endpoint, you
can do the following:
Below is a description of user attributes that can be accessed via this API. All attributes are strings unless otherwise noted. All attributes are required unless otherwise noted. Note: If a certain SCIM field is not listed, it is not supported by BPCC.
\n","event":[{"listen":"prerequest","script":{"id":"53f7d0bc-17a0-4829-9b7a-c33f79c9fe56","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a3583d37-469c-4bcd-9274-44424088e7a4","type":"text/javascript","exec":[""]}}],"_postman_id":"f8f3540b-5b50-4ee1-b43e-81fb8f5a7d16","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}}},{"name":"Phones","item":[{"name":"Get Directory","id":"ca9ea0dd-1a7d-4d90-a46f-caa6ff7af9af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/phone/user","description":"Returns list of users with thier extensions and assigned external (DID) numbers.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","phone","user"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"29cbc318-52df-46be-a604-a0970e728183","name":"Get Directory","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/phone/user"},"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":"ca9ea0dd-1a7d-4d90-a46f-caa6ff7af9af"},{"name":"Get Access Numbers","id":"9c3a48a4-3673-4a33-bace-c66914b8a42e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/phone/ext","description":"Returns a list of access numbers with current assignments.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","phone","ext"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"5b5b942b-88e6-425e-91e7-e8a27718f583","name":"Get Access Numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXXXXXX","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/phone/ext"},"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":"9c3a48a4-3673-4a33-bace-c66914b8a42e"}],"id":"517b6a43-fcc5-45cb-97c1-90e912bb0b72","description":"With the https://tenant.cx.onecloud.com/configapi/v2/phone endpoint you can:
\nReturns an audio file with voices of all participants for the specified call recording in the GSM format.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","recordings","audio"],"host":["mytenant.cx.onecloud.com"],"query":[{"description":{"content":"Global interaction identifier.
\n","type":"text/plain"},"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"},{"description":{"content":"Identifier of the step of the interaction for which the recording is to be retrieved. Can be obtained via scenario variable $(item.interactionStepId) or the callee_interaction_step_id field of the call_detail table of the Reporting Database.
\n","type":"text/plain"},"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA"},{"key":"","value":""}],"variable":[]}},"response":[{"id":"63fbae16-b3a5-43e0-a925-094609b71d4c","name":"Get Audio File","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://:tenant_url/configapi/v2/recordings/audio?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA&=","protocol":"https","port":"tenant_url","path":["configapi","v2","recordings","audio"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"Global interaction identifier"},{"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","description":"Identifier of the step of the interaction for which the recording is to be retrieved. Can be obtained via scenario variable *$(item.interactionStepId)* or the *caller_interaction_step_id* field of the *call_detail* table of the Reporting Database."},{"key":"","value":""}],"variable":[{"key":"tenant_url","value":"teanant.cx.onecloud.com","description":"Your contact center domain name, e.g., tenant.cx.onecloud.com"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3b0b4be5-ffa3-4c63-82d1-d0db11e00ee1"},{"name":"Get Interaction Metadata","id":"625a76e1-1e81-477c-959e-61715657d7a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/recordings/metadata?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","description":"Returns the following metadata for the specified interaction:
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","recordings","metadata"],"host":["mytenant.cx.onecloud.com"],"query":[{"description":{"content":"[Global interaction identifier] (https://support.onecloud.com/portal/en/kb/articles/cx-global-interaction-identifier)
\n","type":"text/plain"},"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"},{"description":{"content":"Identifier of the step of the interaction for which metadata is being requested. Can be obtained via scenario variable $(item.interactionStepId) or the callee_interaction_step_id field of the call_detail table of the Reporting Database.
\n","type":"text/plain"},"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA"}],"variable":[]}},"response":[{"id":"ea95b025-d2c6-4d43-a211-2b5667483c61","name":"Metadata of IVR-only Call","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/recordings/metadata?giid=9F63B008-4BA3-4022-90F7-A8B99ED1A3E8&stepid=89B5E090-F584-4AAA-973A-02C0524BF9CB","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","recordings","metadata"],"query":[{"key":"giid","value":"9F63B008-4BA3-4022-90F7-A8B99ED1A3E8","description":"Global interaction identifier"},{"key":"stepid","value":"89B5E090-F584-4AAA-973A-02C0524BF9CB","description":"Identifier of the interaction step to be retrieved. Can be obtained via scenario variable *$(item.interactionStepId)* or the *caller_interaction_step_id* field of the *call_detail* table of the Reporting Database."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Fri, 15 Mar 2019 19:41:22 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"583"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Start Time\": \"02/27/2019 01:04:52 AM UTC +00:00\",\n \"Agent loginId\": null,\n \"Agent First Name\": null,\n \"Agent Last Name\": null,\n \"Customer phone\": \"Restricted\",\n \"Direction\": \"INBOUND\",\n \"Service\": \"Sales\",\n \"Disposition\": \"No agent\",\n \"Notes\": \"\",\n \"Voice Signature\": \"0\",\n \"Flagged\": \"0\",\n \"Talk Time\": \"0:11\",\n \"RecordingId\": \"20190226170452_Restricted_89B5E090F5844AAA973A02C0524BF9CB.wav\",\n \"Global Interaction ID\": \"9F63B008-4BA3-4022-90F7-A8B99ED1A3E8\",\n \"Review URL\": \"https://tenant.cx.onecloud.com/admin?giid=9F63B008-4BA3-4022-90F7-A8B99ED1A3E8&stepId=89B5E090-F584-4AAA-973A-02C0524BF9CB\",\n \"Screen Recording\": \"0\"\n}"},{"id":"847fa860-cb25-42d7-8009-154565f4df33","name":"Metadata for a call with a live agent","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/recordings/metadata?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepid=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","recordings","metadata"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"Global interaction identifier"},{"key":"stepid","value":"C6A1ECF1-6C4E-4D13-B848-718273ECB0CA","description":"Identifier of the interaction step to be retrieved. Can be obtained via scenario variable *$(item.interactionStepId)* or the *caller_interaction_step_id* field of the *call_detail* table of the Reporting Database."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Fri, 15 Mar 2019 20:21:33 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"603"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"Start Time\": \"03/15/2019 07:49:31 PM UTC +00:00\",\n \"Agent loginId\": \"navarro\",\n \"Agent First Name\": \"Jose\",\n \"Agent Last Name\": \"Navarro\",\n \"Customer phone\": \"Restricted\",\n \"Direction\": \"INBOUND\",\n \"Service\": \"Support\",\n \"Disposition\": \"Solved\",\n \"Notes\": \"\",\n \"Voice Signature\": \"0\",\n \"Flagged\": \"0\",\n \"Talk Time\": \"0:38\",\n \"RecordingId\": \"20190315124931_Restricted_navarro_C6A1ECF16C4E4D13B848718273ECB0CA.wav\",\n \"Global Interaction ID\": \"A44B62DE-75FB-47CD-A103-8F778CD1032A\",\n \"Review URL\": \"https://teanant.cx.onecloud.com/admin?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A&stepId=C6A1ECF1-6C4E-4D13-B848-718273ECB0CA\",\n \"Screen Recording\": \"0\"\n}"}],"_postman_id":"625a76e1-1e81-477c-959e-61715657d7a8"},{"name":"Erase Call Recordings","id":"57bebb9a-3887-4c4f-9fe3-105a62e59287","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/recordings/audio?giid=This method erases locally stored call recordings; the interaction’s Global Interaction Identifier (GIID) must be included as a query parameter in the request URL
\nThe interaction's Global Interaction Identifier
\n","type":"text/plain"},"key":"giid","value":"(Optional) The reason for erasing the recording(s)
\n","type":"text/plain"},"key":"reason","value":"These methods enable retrieval of regular voice recordings (i.e., recordings where voices of all participating parties are recorded in the same audio file) and the related call metadata. Both audio files and metadata can be retrieved immediately upon call termination. Parameters required for recording identificaiton can be obtained via scenario variables $(item.globalInteractionId) and $(item.interactionStepId).
Regular call recordings are exported in GSM format.
This method is used to get information about the structure of a specific multichannel call recording. The call is identified by the Global Inteaciton Identifier (GIID). This article describes the various ways the GIID of a call can be obtained.
\nGlobal interaction identifier
\n","type":"text/plain"},"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A"}],"variable":[]}},"response":[{"id":"2067dccb-4162-46a6-af1a-51fd20b29bff","name":"Multichannel recording description for a simple call","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://:tenant_url/configapi/v2/multi_channel_recordings?giid=A44B62DE-75FB-47CD-A103-8F778CD1032A","protocol":"https","port":"tenant_url","path":["configapi","v2","multi_channel_recordings"],"query":[{"key":"giid","value":"A44B62DE-75FB-47CD-A103-8F778CD1032A","description":"[Global interaction identifier](https://help.brightpattern.com/5.2:Reporting-reference-guide/GlobalInteractionIdentifier)."}],"variable":[{"key":"tenant_url","value":"sasha.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":"Fri, 15 Mar 2019 21:22:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"668"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"_id\": {\n \"$oid\": \"5c8c01f6d04fd77ef2f96144\"\n },\n \"tenant_id\": \"2B699762-370C-4F76-A684-A85B5F93DF84\",\n \"global_interaction_id\": \"A44B62DE-75FB-47CD-A103-8F778CD1032A\",\n \"interaction_id\": \"FD64061C-0C45-4C73-879D-295A30F14646\",\n \"parties\": [\n {\n \"party_id\": \"704384191\",\n \"party_type\": \"UNIDENTIFIED\",\n \"phone\": \"Restricted\",\n \"recordings\": [\n {\n \"duration\": \"26\",\n \"start_time\": {\n \"$date\": 1552679373768\n }\n }\n ]\n },\n {\n \"first_name\": \"Jose\",\n \"last_name\": \"Navarro\",\n \"party_id\": \"704384193\",\n \"party_type\": \"USER\",\n \"phone\": \"1001\",\n \"recordings\": [\n {\n \"duration\": \"17\",\n \"start_time\": {\n \"$date\": 1552679383002\n }\n }\n ],\n \"user_id\": \"64832C51-68C9-402B-BA4D-FFF7DB017F3F\"\n }\n ]\n}"}],"_postman_id":"46ade385-f600-43e3-accf-3baac6b14842"},{"name":"Get Multichannel Recording Segment Audio File","id":"49bba5e1-0d60-413e-b4b3-c94351c4d27f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://mytenant.cx.onecloud.com/configapi/v2/multi_channel_recordings/audio?giid=B3178008-47BA-4CAB-B620-CB3C8864BCB6&iid=A274FC70-770E-45B0-AC77-491EF6CD8E05&party=98141181&recid=0","description":"Gets the desired segment of a multichannel recording identified by the GIID, interaction ID, party ID, and optionally the ordinal number of the desired segement. The latter is essential only if according to your practices recording may be stopped and started again while a call is in progress.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","multi_channel_recordings","audio"],"host":["mytenant.cx.onecloud.com"],"query":[{"description":{"content":"Global interaction identifier
\n","type":"text/plain"},"key":"giid","value":"B3178008-47BA-4CAB-B620-CB3C8864BCB6"},{"description":{"content":"Identifier of the interaction for which a recording is being requested. (Returned by the Get Multi-channel Recording Metadata method.)
\n","type":"text/plain"},"key":"iid","value":"A274FC70-770E-45B0-AC77-491EF6CD8E05"},{"description":{"content":"Identifier of the party whose audio recording is being requested. (Returned by the Get Multi-channel Recording Metadata method.)
\n","type":"text/plain"},"key":"party","value":"98141181"},{"description":{"content":"Ordinal number (starting from 0) of the desired recording segment of the above party. Optional; if not specified, the first segment in the array is returned.
\n","type":"text/plain"},"key":"recid","value":"0"}],"variable":[]}},"response":[],"_postman_id":"49bba5e1-0d60-413e-b4b3-c94351c4d27f"}],"id":"82ed4b37-fe60-4a7d-a652-53a81769f81a","description":"These methods are used to extract individual segments of multichannel call recordings (i.e., recordings where voice of each paricipating party is recorded into a separate audio file).
\nThe Get Multichannel Recording Structure method should be used first to obtain the Interaction IDs, Party IDs, and optionally segments, to be used in the subsequent Get Multichannel Recording Segment Audio File requests.
\nSegments of multichannel recordings are available for export immediately upon call termination.
\nSegments of multichannel recordings are exported in uncompressed PCM format for maximun speech quality. Note that because of the large size of multichannel PCM recording files, they are typically stored in the system for a limited amount of time. Check with your service provider about your limits, and consider overnight export of selected recordings for the previous working day.
\n","event":[{"listen":"prerequest","script":{"id":"1540d080-5b84-44c0-b20e-96c1cae68231","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0cee1497-0d59-4190-a62c-1c6416b2faaf","type":"text/javascript","exec":[""]}}],"_postman_id":"82ed4b37-fe60-4a7d-a652-53a81769f81a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}}},{"name":"SMS/MMS Messaging","item":[{"name":"Send Message","id":"8633d3a7-4847-4122-b030-2728c055bdd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"To\": \"+5219843111460\",\r\n \"Body\": \"Sending a test message for BPCC SMS-MMS API.\",\r\n \"From\": \"16502505674\",\r\n \"MediaURLs\": \r\n [\r\n \"https://www.leithcars.com/assets/shared/CustomHTMLFiles/Responsive/MRP/Ford/2017/Mustang/images/2017-Ford-Mustang-01.jpg\"\r\n ]\r\n}"},"url":"https:/mytenant.cx.onecloud.com/clientweb/smsapi/v1/Messages","description":"Sends an SMS or MMS message to the designated phone number.
\nGets the current status of a previously sent SMS or MMS message. Depending on the time of the request, network conditions, etc., one of the following statuses may be returned: queued, sent, delivered, failed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["clientweb","smsapi","v1","Messages",":message-sid"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"e2116ad9-1e1c-4539-ba2f-6f646c92d8ed","description":{"content":"Message identifier - taken from parameter \"sid\" of the response to a successful Send Message request.
\n","type":"text/plain"},"type":"any","value":"","key":"message-sid"}]}},"response":[{"id":"ca9e6983-5956-490c-b715-b495547c627f","name":"Get Status of Previously Sent Message","originalRequest":{"method":"GET","header":[],"url":{"raw":"https:/mytenant.cx.onecloud.com/clientweb/smsapi/v1/Messages/:message-sid","host":["https"],"port":"","path":["mytenant.cx.onecloud.com","clientweb","smsapi","v1","Messages",":message-sid"],"variable":[{"key":"message-sid","value":"cbbb47e2-23be-452f-9b81-4a1f69300051"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.14.0"},{"key":"Date","value":"Wed, 06 Feb 2019 09:26:29 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"531"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, POST, DELETE, PUT"},{"key":"Access-Control-Allow-Headers","value":"Content-Type"}],"cookie":[],"responseTime":null,"body":"{\n \"account_sid\": \"2B699762-370C-4F76-A684-A85B5F93DF84\",\n \"api_version\": \"1\",\n \"body\": \"Sending a test message for CX SMS-MMS API.\",\n \"num_segments\": \"1\",\n \"num_media\": \"0\",\n \"date_created\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"date_sent\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"date_updated\": \"Wed, 06 Feb 2019 08:24:08 +0000\",\n \"direction\": \"outbound-api\",\n \"error_code\": null,\n \"error_message\": null,\n \"from\": \"16502505674\",\n \"price\": null,\n \"sid\": null,\n \"status\": \"delivered\",\n \"to\": \"16046496025\",\n \"uri\": \"/clientweb/smsapi/v1/Messages/cbbb47e2-23be-452f-9b81-4a1f69300051\"\n}"}],"_postman_id":"29487bce-ccb0-4c88-b18e-a19d5b8e796a"}],"id":"c15e481e-9b12-4064-a6c5-1a610e95467e","description":"The SMS/MMS API allows sending SMS/MMS messages via text-capable access numbers of the BP platform from an external application and tracking the delivery status of those messages.
\nThis document describes how to get started with developing with SMS and MMS on OneCloud CX, the methods used can be found at Send Message, with example requests and responses. You can alternatively load this API into the Postman API Development Environment to interact with the API with your own access tokens.
\nNote the following:
\nThe user account used for authentication of the SMS/MMS API requests must have privilege Use SMS/MMS API.
\nA 200 OK response to a Send Message request will always show the message status as \"queued\". Actual status of message delivery can be verified using the Get Message method with a slight delay
\nNote that in the current version, the only records created in BPCC for the SMS messages sent via this API will be records in the Carrier Usage reports.
\nPossible replies to the messages sent via the API can be directed to a chat service associated with the access number used as the sender ID (field From:) in the Send Message request. If it is important that you receive and process possible replies, consider sending your SMS messages within the service hours and stop sending them well in advance of service closure.
\nIf an SMS reply still comes outside of the service hours, you can configure your scenario to:
\nCopy the content of the message to an Email scenario block and send this email to someone who can follow up the next day.
\nThese methods enable sending of SMS and MMS messages and checking the delivery status. The response parameters are explained below.
\nThis method creates a subscription for a specific set of metrics. Each client can have only one active subscription.
\nThis method gets the statistics data of an active subscription.
\nNote:
\nThis method deletes the active subscription, and clears the data cache on the server.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["statsapi","subscription","active"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"000dec5b-6f48-4050-9270-1a1aa5be0940","name":"Delete Subscription","originalRequest":{"method":"DELETE","header":[{"key":"Cookie","value":"X-STATSAPI-TOKEN=61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721; X-STATSAPI-TENANT=yourcompany.brightpattern.com; X-STATSAPI-LOGIN=stats.user","type":"text"}],"url":"https://mytenant.cx.onecloud.com/subscription/active"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"81af4a8b-454a-43f3-b7ec-3b8147d87125"},{"name":"Get Dispositions","id":"099f7e86-1d2b-4590-a7ea-f687a1fbcc3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Cookie","value":"X-STATSAPI-TOKEN=61XXXXX2-XEX5-4XBX-81C3-14CXXXXXX721; X-STATSAPI-TENANT=tenant_URL; X-STATSAPI-LOGIN=user.name","type":"text"}],"url":"https://mytenant.cx.onecloud.com/statsapi/cfg/dispositions","description":"This method gets the disposition names for all supervised services.
\nThis method gets either the \"true\" or the \"false\" value for agents ready to handle a specific service.
\nNote:
\nThis method returns the names and internal object IDs of teams configured for the given tenant.
\nNote that in order to get the above information about a specific team, the account used for API authentication must be assigned as a supervisor to that team.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["statsapi","cfg","teams"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[]}},"response":[{"id":"a61a9144-e6ec-48b6-b9db-f75e99c66713","name":"Get Teams","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer XXXX7680DF72CE559B874A8AXXXX291451716F18XXXXC57EE5C88D16EC5DXXXX","type":"text"}],"url":"https://mytenant.cx.onecloud.com/statsapi/cfg/teams"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"[\n {\n \"id\": \"F4ED90FA-5A49-4D76-9487-4E41B24CA45F\",\n \"name\": \"Customer Service\"\n }\n]"}],"_postman_id":"6ba0124c-1239-4339-9844-fdacf568b24e"}],"id":"a0598261-6dc5-4630-b55e-fbe0f00c7b8a","description":"With the OneCloud CX Real-Time Statistics API, you can currently do the following:
\nNotes:
\nFor a list of statistics to use, please see OneCloud CX Help Documentation.
\nThe OneCloud CX Real-Time Statistics API methods are as follows.
\nNote:
\nappId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns the availability status of the configured hours of operation of the associated Messaging/Chat scenario entry. Optionally, Estimated Wait time (EWT) (in seconds) may be returned but could be missing if the server does not have enough data to estimate the EWT value. Note that the API does not check if there are any agents actually logged in.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"c4b66088-5143-404e-b4f0-aa16fef6b5c2","name":"Check Availability Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://mytenant.cx.onecloud.com/clientweb/api/v2/availability"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"chat\": \"available\",\n \"ewt\": \"3\"\n}"}],"_postman_id":"25603324-4c5b-4d06-bb50-39b778343a00"},{"name":"Expected Parameters","id":"6c8d6f41-dcdf-4205-8985-5902843c408d","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://mytenant.cx.onecloud.com/clientweb/api/v2/parameters?tenantUrl=mytenant.cx.onecloud.com","description":"This method returns an array of expected parameters. The parameters are optional. They may be used, for example, to look for the most qualified agents to handle the requested chat sessions and/or to display user information for the agents. These parameters are initially specified for the Messaging/Chat scenario entry through which this mobile application will communicate with the contact center.
\nCurrently, the following parameter types are supported:
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"c1cd041b-4402-4629-a0f7-2b36567b7ae4","name":"Expected Parameters Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/parameters?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","parameters"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"parameters\":[\r\n {\r\n \"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method initiates a chat session. It provides values of all or some of the expected parameters, and it may also contain the phone number of the mobile device. Depending on the scenario entry configuration, a callback can be initiated automatically to the specified number as soon as the chat request is delivered to the agent.
\nNotes:
\nThe Request Chat method may return the ID and parameters of an existing chat session if there are any currently existing chat sessions associated with this specific client. For example, the client app created a chat session, which was then closed or crashed, then restarted before the session timed out on the server.
\nThe is_new_chat response attribute is specified if the chat is a new session or existing session. The client application will handle these differently (e.g., if in an existing session the app may request session history and show the previous content.
\nIf the associated mobile/web scenario entry is not configured for automatic callback, the agent can still use this number to call the mobile user manually, either upon the agent's own initiative or when asked to do this via a chat message from the mobile user.
\nThe parameter from may be used to specify either the device owner’s name or phone number. It will be placed in the scenario variable $(item.from).
\nParameters returned in the parameters attribute are propagated into the scenario variable $(item.externalChatData).
\nOptionally, Estimated Wait time (EWT) (in seconds) may be returned but could be missing if the server does not have enough data to estimate the EWT value. This might be important for the clients with strict JSON serialization (i.e., the client app may fail deserializing the JSON if the attribute is missing).
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"6f4b680c-0d90-4dbd-b75b-8f167a1d185f","name":"Request Chat Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"phone_number\": \"16508888888\",\r\n \"from\": \"51.18.205.152\",\r\n \"parameters\": {\r\n \"FIRST_NAME\": \"Aiden\",\r\n \"LAST_NAME\": \"Bookbinder\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/chats?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","chats"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"state\": \"ivr\",\n \"ewt\": \"0\",\n \"chat_id\": \"d6c1adc2-385b-42e5-9e0a-1883c2bc5f81\",\n \"is_new_chat\": true,\n \"phone_number\": \"16508888888\"\n}"}],"_postman_id":"65edc33a-01f2-4da3-a84c-57343bc23116"},{"name":"Mobile Notification Subscription","id":"fd134b31-8884-43d3-b800-045fc444882b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true,"user-agent":true}},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"description":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method is a client application request for either subscribing to or canceling mobile notifications for a chat session.
\nThis method should be invoked after invoking the Request Chat method (i.e., the chatId value required for this method is returned in the Request Chat method).
\nAdditionally, this method should be invoked when its device token is changed.
\nThe client application may also opt to stop receiving mobile notifications by using this API method\nwith an empty JSON body: {}
\nThe mobile application will specify one of the following parameters, depending on the application’s\noperating system and used notification framework.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[{"id":"c71a6743-2978-4228-903b-80995a9b763b","description":{"content":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns the properties of an active chat session. Optionally, Estimated Wait time (EWT) (in seconds) may be returned but could be missing if the server does not have enough data to estimate the EWT value.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"8ff738c3-e7e6-4dc0-8aa2-1c7b30b9cb6d","name":"Get Active Chat Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/active?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","chats","active"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"chat_id\":\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"raw","raw":"{\n \"events\":[\n \"This method sends events from the client to the server side.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[{"id":"6c5de7bd-b218-4a1a-a6ff-47f31801922b","description":{"content":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"75b2d226-8944-4ed0-aaee-1018e6c2da26","name":"Send Events Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","type":"text","value":"MobileClient"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n “events”: [appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/:chatId/history?tenantUrl=mytenant.cx.onecloud.com","description":"This method returns all client events and all server events for the current session. Multiple event objects can be returned; each event's timestamp attribute can be used to restore the correct message order.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[{"id":"fa25faa1-bfa0-4c59-9987-4b7f263957bb","description":{"content":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"d651d88f-a9c8-4b41-b47f-a1b020649f4a","name":"Get Chat History Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/:chatId/history?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","chats",":chatId","history"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"events\":[\r\n \"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns new chat events for the current session. If there are no new events, the server can keep the request active during a timeout (i.e., for about 5–15 seconds). If the client sends another request to get new events while the previous request is kept active, the server will respond with error 400 (Bad request).
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[{"id":"e9678a10-1795-4bcd-99a3-d4d16af81c8e","description":{"content":"The current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"}]}},"response":[{"id":"3b754cd8-0899-415f-95d9-06c8e9b5c40a","name":"Get New Chat Events Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://yourcompany.brightpattern.com/clientweb/api/v2/chats/:chatId/events?tenantUrl=yourcompany.brightpattern.com","protocol":"https","host":["yourcompany","brightpattern","com"],"path":["clientweb","api","v2","chats",":chatId","events"],"query":[{"key":"tenantUrl","value":"yourcompany.brightpattern.com"}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"events\":[\r\n \"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","description":"The file or text to be uploaded
\n","type":"file","src":"/C:/Users/Lenovo/Desktop/important_file.txt"}]},"url":"https://mytenant.cx.onecloud.com/clientweb/api/v2/files?tenantUrl=mytenant.cx.onecloud.com","description":"This method uploads a file to the server. The maximum file size is 25 MB. The server will store up to 1000 files. Newly received files will replace the oldest files. This method can be used, for example, to send pictures from the client mobile application to the contact center agents.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"328d716b-6349-4da6-88fa-d00e4ae500a0","name":"Upload File Example","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"},{"key":"Content-Type","value":"multipart/form-data","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","src":"/C:/Users/Lenovo/Desktop/important_file.txt"}]},"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/files?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","files"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"_postman_previewlanguage":"Text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"file_id\":\"file ID to use in chat_session_file message\"\r\n}"}],"_postman_id":"7f9b2474-1729-4a60-bb49-bc6d8ec97268"},{"name":"Get File","id":"3685ba47-9a11-4568-8da3-b10b7f645ac4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"description":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method downloads a file from the server using the received file ID. See server event Chat Session File.
\nThe current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"id":"fac85b26-4de1-4cfb-955c-dd5f373a9292","description":{"content":"The file ID of the file to download
\n","type":"text/plain"},"type":"any","value":"","key":"fileId"}]}},"response":[{"id":"44d38838-d775-487b-ade5-ecd8f85eba34","name":"Get File Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/:chatId/files/:fileId","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","chats",":chatId","files",":fileId"],"query":[{"key":"","value":"","disabled":true},{"key":"","value":"","disabled":true}],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"},{"key":"fileId","value":"e1f234c35-ffec-4dcb-8f7f-755b6395a6dc"}]}},"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"File content type"}],"_postman_id":"3685ba47-9a11-4568-8da3-b10b7f645ac4"},{"name":"Get Agent Profile Photo","id":"18655dae-e1a9-4efc-9127-96c9ebad1641","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method downloads a profile photo of the specified agent.
\nThe request body is the party ID of the agent participating in the current chat session.
\nNote: The party ID is provided with the chat event (polled at https://{host:port}/clientweb/api/v1/chats/{chatId}/events?tenantUrl={tenantUrl}). For example, you can see party_ID in the event message for chat_session_party_joined.
\nThe current chat session ID. The value of this variable is returned in the body of a successful invocation of the \"Request Chat\" method.
\n","type":"text/plain"},"type":"any","value":"","key":"chatId"},{"id":"33f19358-5bc8-4c30-9053-d3d6426deecc","description":{"content":"The party ID of the agent for the current chat session
\n","type":"text/plain"},"type":"any","value":"","key":"partyId"}]}},"response":[{"id":"bf1bce22-ca3c-484f-bd47-bbeda2a72b90","name":"Get Agent Profile Photo Example","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/chats/:chatId/profilephotos/:partyId","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","chats",":chatId","profilephotos",":partyId"],"variable":[{"key":"chatId","value":"f5f68c35-ffec-4dcb-8f7f-755b6395a6dc"},{"key":"partyId","value":"e5f23c35-ffec-4dcb-8f7f-755b6395a6dd"}]}},"_postman_previewlanguage":"text","header":null,"cookie":[],"responseTime":null,"body":"File content type"}],"_postman_id":"18655dae-e1a9-4efc-9127-96c9ebad1641"},{"name":"Get ICE servers","id":"64e165d0-f3a2-4928-b6b9-182290484a18","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"description":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns a list of configured ICE servers to provide to the browser so that an audio-visual session could be added to the chat.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"17db53c6-a7cd-4f2d-8fba-f8463fcf4405","name":"Get ICE servers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/iceservers?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","iceservers"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"servers\":[{\r\n \"url\": \"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns the chat widget configuration for the launch point.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"82368e55-f6cc-4d73-a0fc-3bd994263fe5","name":"Get Chat Widget Configuration","originalRequest":{"method":"GET","header":[{"description":"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method returns the combined transcripts of all chat sessions (i.e., the chat thread) linked to the specific CRM case object. Note that this request should be made only after the chat_session_case_set server event is received; if the scenario has not specified a case, the request will return an error.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"d7b424ea-f39d-4bfd-b07e-38e697c3da0f","name":"Get Case History","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\""},{"key":"User","type":"text","value":"MobileClient"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/casehistory?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","casehistory"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"sessions\": [\r\n {\r\n \"chat_id\": \"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","key":"Authorization","type":"text","value":"MOBILE-API-140-327-PLAIN appId=\"This method invokes a client application request to close the case associated with the chat session. Note that this request should be made only after the chat_session_case_set server event is received; if the scenario has not specified a case, the request will return an error.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"4c0f884d-5d1e-4aad-b813-f62bf6aa5f7d","name":"Close Case","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/closecase?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","closecase"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"4f82a6c0-f921-4309-bfd1-3ad4a1ccfab5"},{"name":"Get Version","id":"2627619b-c502-4550-9fb5-9f2ea5e2aad3","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"user-agent":true}},"request":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"appId is the unique identifier of the Messaging/Chat scenario entry that will be used to associate your application with a specific scenario. \nclientId is the unique identifier of the client application. It is used to identify communication sessions of a particular instance of the mobile application (i.e., of a specific mobile device). It must be generated by the mobile application and should be unique for each client application/device combination. If clientId is set to \"WebChat\", HTTP cookies will be used for client identification.
\n","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":"https://mytenant.cx.onecloud.com/clientweb/api/v2/version?tenantUrl=mytenant.cx.onecloud.com","description":"This method returns the Bright Pattern Contact Center software version of the server. It may be used for informational purposes (e.g., adding the version number to the bottom of an application window or in an informational dialog window, as well as seeing the server version in the client application logs). Note that this method is not available in the Mobile/Web Messaging API v1.
\nIdentifies your contact center. It corresponds to the domain name of your contact center that you see in the upper right corner of the Contact Center Administrator application after login. Additionally, this variable allows service providers to specify a particular tenant (i.e., if the request is not sent to the tenant's domain).
\n","type":"text/plain"},"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}],"variable":[]}},"response":[{"id":"5e998794-d159-45a2-9d12-8b54a70935f3","name":"Get Version","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"MOBILE-API-140-327-PLAIN appId=\"1a2c26b0-b065-4f27-8696-cbac8f03bb57\", clientId=\"WebChat\"","type":"text"},{"key":"User-Agent","value":"MobileClient","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/clientweb/api/v2/version?tenantUrl=mytenant.cx.onecloud.com","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["clientweb","api","v2","version"],"query":[{"key":"tenantUrl","value":"mytenant.cx.onecloud.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"server_version\": \"5.5.6.12345 (Stable)\"\n}"}],"_postman_id":"2627619b-c502-4550-9fb5-9f2ea5e2aad3"}],"id":"49560ac6-78f6-4084-8518-2ccac6f3a3b3","description":"The OneCloud CX Mobile/Web Messaging API v2 is a RESTful API that allows developers to integrate chat and voice interactions with mobile devices or third-party applications. The CX Mobile/Web Messaging API v2 expands on our existing Mobile/Web Messaging API v1, and can be used for development of rich contact applications, such as customer-facing mobile, web, and messaging applications for advanced chat, voice, and video communications with OneCloud Contact Center-based contact centers.
\nIn addition to all the methods and events included in the v1 API, the Mobile/Web Messaging API v2 includes the following:
\nThe CX Mobile/Web Messaging API v2 endpoint prefix is as follows:
\nhttps://[tenant_url]/clientweb/api/v2/
\nThis documentation is intended for the IT personnel and developers of custom applications for Bright Pattern Contact Center-based contact centers. Readers of this documentation are expected to have expertise in web and mobile application development as well as a solid understanding of contact center operations and resources that are involved in such operations.
\nOneCloud provides source code of sample customer-facing rich contact applications. This source code can be used as a reference for in-house application development or it can be embedded directly into the customer-facing mobile applications and/or web applications of your organization.
\nFor web chat applications, you can download the source code by clicking the Client application button on the Messaging/Chat Scenario Entry page of the Contact Center Administrator application.
\nFor mobile applications, you can obtain the source code by submitting a service request to OneCloud Success Management.
\nExample Request
\nThe following is an example of an API request:
\nURL: https://tenant.cx.onecloud.com/clientweb/api/v2/chats?tenantUrl=yourcompany.brightpattern.com\nMethod: POST\nAuthorization: MOBILE-API-140-327-PLAIN appId=\"test\", clientId=\"123\"\nContent-Type: application/json; charset=UTF-8\nUser-Agent: MobileClient\n{\n \"phone_number\":\"3001\",\n \"parameters\": {\n \"first_name\":\"John\",\n \"last_name\":\"Lee\"\n }\n}\n\nThe following elements are used for client authentication and must be specified in every client request:
\nStandard HTTP response codes whose meaning conforms to the original specification (RFC 2616) are not discussed in this document. For specification of such responses, see section 10 of http://www.ietf.org/rfc/rfc2616.txt. This document only specifies the response codes whose description deviates from the original specification (e.g., is defined more narrowly or has a different meaning).
\nNote: A client application can only have one active communication session at a time.
\nWhen the response status code indicates an error, a JSON response body is provided by the server to
give more details about the error:
{\"error_code\": \"error code\", \"error_message\":\"error message\"}
Here is a list of the possible values of authorization-related error codes and error messages that are
common to all requests that require authorization.
Here is a list of the possible values of other error codes and error messages.
\n","_postman_id":"49560ac6-78f6-4084-8518-2ccac6f3a3b3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}}},{"name":"Events","item":[{"name":"Client Events","item":[],"id":"8aa31f77-a05c-4475-a063-4f44b7f152b3","description":"This event contains a new chat message.
\n{\n \"event\": \"chat_session_message\",\n \"msg_id\": \"<message id>\",\n \"msg\": \"<chat message>\",\n \"channel\": \"chat channel>\n}\n\nThe mobile application sends this event when it receives the message from another party.
\n{\n \"event\": \"chat_session_message_delivered\",\n \"ref_msg_id\": \"<message id>\"\n}\n\nThe mobile application sends this event when the user reads the message.
\n{\n \"event\": \"chat_session_message_read\",\n \"ref_msg_id\": \"<message id>\"\n}\n\nThis event is sent when the user of the client application starts typing.
\n{\n \"event\": \"chat_session_typing\"\n}\n\nThis event is sent when the user of the client application stops typing.
\n{\n \"event\": \"chat_session_not_typing\"\n}\n\nThis event contains the data requested by the server via the event chat_session_form_show.
\n{\n \"event\": \"chat_session_form_data\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\",\n \"form_name\": \"<form name>\",\n \"data\": {\n \"param1\": \"value1\",\n …\n }\n}\n\nThis event contains the data requested by the server via the event chat_session_secure_form_show.
\n{\n \"event\": \"chat_session_secure_form_data\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\",\n \"form_name\": \"<form name>\",\n \"data\": {\n \"param1\": \"value1\",\n …\n }\n}\n\nThis event is sent from or to the server to notify that the secure form was canceled.
\n{\n \"event\": \"chat_session_secure_form_cancel\",\n \"form_request_id\": \"<form request ID from the corresponding server event>\"\n}\n\nThis event ends the chat session.
\n{\n \"event\": \"chat_session_end\"\n}\n\nThis event ends the current chat conversation but keeps the session open (i.e., controlled by the scenario). This message can be used instead of chat_session_end when additional information may be expected from the server (e.g., a survey form).
\n{\n \"event\": \"chat_session_disconnect\"\n}\n\nThis event is a container message for WebRTC signaling messages from client to server. These messages are not stored in the chat session history.
\n{\n \"event\": \"chat_session_signaling\",\n \"msg_id\": \"<message id>\",\n \"destination_party_id\": \"<agent party id>\",\n \"data\": \"<signaling message>\"\n}\n\nThis event provides notification that the client has uploaded a file to the server.
\n{\n \"event\": \"chat_session_file\",\n \"msg_id\": \"<message id>\",\n \"file_type\": \"<image|attachment>\",\n \"file_id\": \"<file id>\"\n}\n\nThis event contains a new geographical location message.
\n{\n \"event\": \"chat_session_location\",\n \"msg_id\": \"<message id>\"\n \"url\": \"<map URL (optional)>\",\n \"latitude\": \"<latitude>\",\n \"longitude\": \"<longitude>\"\n}\n\nThis event is sent from the client with its web page location (i.e., the page name or the URL).
\n{\n \"event\": \"chat_session_navigation\",\n \"msg_id\": \"<message id>\",\n \"title\": \"<page title>\",\n \"page\": \"<page name or page url>\"\n}\n\nThis event notifies the server that the user has rejected a co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_rejected\"\n}\n\nThis event notifies the server that the user has accepted and started a co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_started\",\n \"provider_type\": \"<Name of chat co-browsing provider>\",\n \"cobrowsing_url\": \"<URL of the co-browsing session>\"\n}\n\nThis event notifies the server that the user has ended the co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_ended\"\n}\n\nThis event updates the current state of the chat session. If the state is failed, the client application will assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_status\",\n \"state\": \"queued|connecting|connected|failed|completed\",\n \"ewt\": \"<estimated waiting time for queued status>\"\n}\n\nThis event indicates a normal termination of the chat session (e.g., when the chat session is closed by the agent). The client application will assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_ended\"\n}\n\nThis event indicates that a new party (i.e., a new agent) has joined the chat session.
\n{\n \"event\": \"chat_session_party_joined\",\n \"party_id\": \"<party id>\",\n \"first_name\": \"<party first name>\",\n \"last_name\": \"<party last name>\",\n \"display_name\": \"<party display name>\",\n \"type\": \"<scenario|external|internal>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\n\nThis event indicates that one of the existing parties (e.g., an agent) has left the chat session.
\n{\n \"event\": \"chat_session_party_left\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\n\nThis event contains a new chat message.
\n{\n \"event\": \"chat_session_message\",\n \"party_id\": \"<party id>\",\n \"msg_id\": \"<message id>\",\n \"msg\": \"<chat message>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\n\nThe mobile application will receive this event when an agent or another party in the chat receives the message sent by the client application.
\n{\n \"event\": \"chat_session_message_delivered\",\n \"party_id\": \"<party id>\",\n \"ref_msg_id\": \"<message id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThe mobile application will receive this event when an agent or another party in the chat reads the message sent by the client application.
\n{\n \"event\": \"chat_session_message_read\",\n \"party_id\": \"<party id>\",\n \"ref_msg_id\": \"<message id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis event is sent when the agent starts typing.
\n{\n \"event\": \"chat_session_typing\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis event is sent when the agent stops typing.
\n{\n \"event\": \"chat_session_not_typing\",\n \"party_id\": \"<party id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis event is sent to the request user’s input from the client application to be entered via a predefined form. The client application is normally supposed to display the specified form to the user and send back the entered data via the event chat_session_form_data.
\n{\n \"event\": \"chat_session_form_show\",\n \"form_request_id\": \"<request ID that will be used by the client application to associate the response>\",\n \"form_name\": \"<predefined form name known to the client application>\",\n \"form_timeout\": \"form timeout\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis event is sent to notify the client application that it should display a secure, predefined form to the user and send back the entered data via the event chat_session_secure_form_data.
\n{\n \"event\": \"chat_session_secure_form_show\",\n \"form_request_id\": \"<request ID that will be used by the client application in chat_session_secure_form_data>\",\n \"form_id\": \"<Form ID>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis event is sent to request that the specified text be displayed to the user of the client application. Typically, it is used to display an inactivity warning message.
\n{\n \"event\": \"chat_session_timeout_warning\",\n \"msg\": \"<warning text>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\n\nThis event indicates the termination of the chat session due to the user’s inactivity and provides text to be displayed to the user. The client application will assume that the chat session no longer exists.
\n{\n \"event\": \"chat_session_inactvity_timeout\",\n \"msg\": \"<inactivity timeout text>\",\n \"timestamp\": \"<UTC timestamp in milliseconds>\"\n}\n\nThis event is a container message for WebRTC signaling messages from the server to the client. These messages are not stored in the chat session history.
\n{\n \"event\": \"chat_session_signaling\",\n \"msg_id\": \"<message id>\",\n \"data\": \"<signaling message>\"\n}\n\nThis event provides notification that a file is being sent to the client. The client can use the parameter file_id to download the file.
\n{\n \"event\": \"chat_session_file\",\n \"party_id\": \"<party id>\",\n \"msg_id\": \"<message id>\",\n \"file_id\": \"<file id>\",\n \"file_type\": \"<image|attachment>\",\n \"timestamp\": \"<event time in Unix format>\"\n}\n\nThis event contains a new location message.
\n{\n \"event\": \"chat_session_location\",\n \"msg_id\": \"<message id>\"\n \"url\": \"<map url (optional)>”,\n \"latitude\": “<latitude>”,\n \"longitude\": “<longitude>”,\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis event is sent to the client application to request a co-browsing session.
\n{\n \"event\": \"chat_session_cobrowsing_requested\",\n \"msg_id\": \"<message id>\"\n}\n\nThe mobile application will receive this event when the scenario specifies the CRM Case ID for the chat session. Once a case is set, the mobile application may use the Get Case History method and the Close Case method.
\n{\n \"event\": \"chat_session_case_set\",\n \"case_id\": \"<message id>\",\n \"timestamp\": \"<UTC timestamp in seconds>\"\n}\n\nThis message is sent from the client to request a WebRTC call.
\n{\n \"type\": \"REQUEST_CALL”,\n \"offerVideo\": \"true|false\"\n}\n\nThis message is sent from the server to indicate that a requested call was rejected.
\n{\n \"type\": \"CALL_REJECTED\",\n \"reason_code\": \"<reject reason code>\",\n \"reason\": \"TBD\"\n}\n\nThis message is sent from the server to start a WebRTC session.
\n{\n \"type\": \"OFFER_CALL\",\n \"offerVideo\": \"true|false\",\n \"sdp\": \"}\n\nThis message is sent from the client to confirm the WebRTC session started by the server.
\n{\n \"type\": \"ANSWER_CALL\",\n \"sdp\": \"<session description string>\"\n}\n\nThis message is sent from the client or server with ICE candidate description.
\n{\n \"type\": \"ICE_CANDIDATE\",\n \"sdpMid\": \"<candidate id>\",\n \"sdpMLineIndex\": \"<candidate index>\",\n \"candidate\": \"<candidate description>\"\n}\n\nThis message is sent from the client or server to end the current WebRTC session.
\n{\n \"type\": \"END_CALL\"\n}\n\nThis method adds multiple new records to the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition already exists.
\nNotes:
\nThis method adds a single new record to the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition already exists.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"}]}},"response":[{"id":"1b977787-6559-4d01-8773-fd177b74fd00","name":"Add Record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"4\",\r\n \"firstName\": \"Post\",\r\n \"lastName\": \"Melon\",\r\n \"Phone\": \"16505555555\",\r\n \"Status\": \"Platinum\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/add/:list_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","add",":list_name"],"variable":[{"key":"list_name","value":"list.csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"85740ee4-d145-4849-973e-8d27bf1bf602"},{"name":"Delete All Records","id":"d6ae3a8e-c85c-4c2c-85c5-2ee702cd9a70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/deleteAll/:list_name","description":"This method deletes all records from the calling list. List results are also deleted. It returns OK if the list exists but is empty already. Note that this method erases calling list results and it will do so regardless of whether the results have been exported or not.
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"}]}},"response":[{"id":"08ecd92c-f5fa-4410-abef-3fac65d264fa","name":"Delete All Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/deleteAll/:list_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","deleteAll",":list_name"],"variable":[{"key":"list_name","value":"list.csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d6ae3a8e-c85c-4c2c-85c5-2ee702cd9a70"},{"name":"Get All Records","id":"36094733-7ba2-4813-a522-96a0448f04da","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromIndex\": 123456,\r\n \"maxSize\": 100\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/getAll/:list_name/:campaign_name","description":"Calling list records are sequentially numbered in order of insertion, beginning from zero. This method returns a list of records in the calling list that has an index that is greater than or to equal to the requested record index.
\nInput parameters are \"initial record index\" and \"maximum size of returned list.\" Current implementation limits \"maxSize\" to 1000 records. All time values are returned in UTC.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"id":"ff583fb0-271c-45ec-b3f4-75519757c6fd","description":{"content":"The name of the outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_name"}]}},"response":[{"id":"937826c6-944e-4c2f-abd7-b15c4d9f6698","name":"Get All Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromIndex\": 0,\r\n \"maxSize\": \"100\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/getAll/:list_name/:campaign_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","getAll",":list_name",":campaign_name"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaign_name","value":"Outbound%20Campaign"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"entry\": {\n \"firstname\": \"Graham\",\n \"phone\": \"16509999999\",\n \"id\": \"1\",\n \"lastname\": \"Smith\",\n \"status\": \"Gold\"\n },\n \"index\": 0,\n \"status\": {\n \"globalInteractionID\": \"0B767156-D012-4F63-A3E2-12ACFC2F26EA\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"No disposition\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16509999999\",\n \"lastDate\": \"2021-02-19T19:11:40.000\"\n }\n },\n {\n \"entry\": {\n \"firstname\": \"Mike\",\n \"phone\": \"16507777777\",\n \"id\": \"2\",\n \"lastname\": \"Miller\",\n \"status\": \"Platinum\"\n },\n \"index\": 1,\n \"status\": {\n \"globalInteractionID\": \"3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Try again later\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16507777777\",\n \"lastDate\": \"2021-02-19T19:12:21.000\"\n }\n },\n {\n \"entry\": {\n \"firstname\": \"Katrina\",\n \"phone\": \"16505555555\",\n \"id\": \"3\",\n \"lastname\": \"Johnson\",\n \"status\": \"Silver\"\n },\n \"index\": 2,\n \"status\": {\n \"globalInteractionID\": \"9D914127-C1C4-4587-8B30-4E2A9790D184\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Product sold\",\n \"totalAttempts\": 1,\n \"completed\": true,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16505555555\",\n \"lastDate\": \"2021-02-19T19:12:37.000\"\n }\n },\n {\n \"entry\": {\n \"firstname\": \"Jenny\",\n \"phone\": \"16502222222\",\n \"id\": \"4\",\n \"lastname\": \"Green\",\n \"status\": \"Gold\"\n },\n \"index\": 3,\n \"status\": {\n \"globalInteractionID\": \"35DE77AC-5A37-4907-97CA-50B09B30ECDF\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Fast busy\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16502222222\",\n \"lastDate\": \"2021-02-19T19:13:08.000\"\n }\n }\n]"}],"_postman_id":"36094733-7ba2-4813-a522-96a0448f04da"},{"name":"Get Completed Records","id":"85891eb4-b19f-436e-a9fe-ad0513c01ffe","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromTime\": \"2013-03-01T13:15:06.456\",\r\n \"maxSize\": \"100\"\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/getCompleted/:list_name/:campaign_name","description":"This method returns a list of completed records in the calling list that have a completion time that is greater than or equal to the requested initial time (UTC). Input parameters are the initial time in ISO format and the maximum size of the returned list. Current implementation limits \"maxSize\" to 1000 records. All time values are returned in UTC.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"id":"40aeac80-b41e-437a-999b-1aafeee6db90","description":{"content":"The name of the outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_name"}]}},"response":[{"id":"3dd8633a-a243-4991-8a1e-621a1ac4d532","name":"Get Completed Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromTime\": \"2021-02-01T13:15:06.456\",\r\n \"maxSize\": \"100\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/getChanged/:list_name/:campaign_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","getChanged",":list_name",":campaign_name"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaign_name","value":"Outbound%20Campaign"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"completedTime\": \"2021-02-19T19:12:37.000\",\n \"entry\": {\n \"firstname\": \"Katrina\",\n \"phone\": \"16502222222\",\n \"id\": \"3\",\n \"lastname\": \"Johnson\",\n \"status\": \"Silver\"\n },\n \"status\": {\n \"globalInteractionID\": \"9D914127-C1C4-4587-8B30-4E2A9790D184\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Product sold\",\n \"totalAttempts\": 1,\n \"completed\": true,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16502222222\",\n \"lastDate\": \"2021-02-19T19:12:37.000\"\n }\n }\n]"}],"_postman_id":"85891eb4-b19f-436e-a9fe-ad0513c01ffe"},{"name":"Get Updated Records","id":"1cc8cf5e-b179-428d-907a-843872052f46","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromTime\": \"2013-03-01T13:15:06.456\",\r\n \"maxSize\": \"100\"\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/getCompleted/:list_name/:campaign_name","description":"This method returns records of the specified calling list that have had any activity within the specified campaign since the requested initial time.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}},"urlObject":{"protocol":"https","path":["configapi","v2","callinglist","getCompleted",":list_name",":campaign_name"],"host":["mytenant.cx.onecloud.com"],"query":[],"variable":[{"id":"a0dcf1a5-a62c-4ce3-b9b5-a5df84b95b2a","description":{"content":"The name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"id":"3dbc3705-e4ee-4be5-84d1-a989062fb584","description":{"content":"The name of the outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_name"}]}},"response":[{"id":"e4da0033-c209-44b5-b375-afe0a613f8c4","name":"Get Updated Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fromTime\": \"2021-01-01T13:15:06.456\",\r\n \"maxSize\": \"100\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/getChanged/:list_name/:campaign_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","getChanged",":list_name",":campaign_name"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaign_name","value":"Outbound%20Campaign"}]}},"status":"Success","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"entry\": {\n \"firstname\": \"Graham\",\n \"phone\": \"16509999999\",\n \"id\": \"1\",\n \"lastname\": \"Smith\",\n \"status\": \"Gold\"\n },\n \"completed\": false,\n \"recordDisposition\": \"\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"No disposition\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:11:40.000\",\n \"phone\": \"16509999999\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"0B767156-D012-4F63-A3E2-12ACFC2F26EA\",\n \"CPADuration\": 0\n }\n ]\n },\n {\n \"entry\": {\n \"firstname\": \"Mike\",\n \"phone\": \"16507777777\",\n \"id\": \"2\",\n \"lastname\": \"Miller\",\n \"status\": \"Platinum\"\n },\n \"completed\": false,\n \"recordDisposition\": \"\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"Try again later\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:12:21.000\",\n \"phone\": \"16507777777\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC\",\n \"CPADuration\": 0\n }\n ]\n },\n {\n \"entry\": {\n \"firstname\": \"Katrina\",\n \"phone\": \"16505555555\",\n \"id\": \"3\",\n \"lastname\": \"Johnson\",\n \"status\": \"Silver\"\n },\n \"completed\": true,\n \"recordDisposition\": \"Product sold\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"Product sold\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:12:37.000\",\n \"phone\": \"16505555555\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"9D914127-C1C4-4587-8B30-4E2A9790D184\",\n \"CPADuration\": 0\n }\n ]\n },\n {\n \"entry\": {\n \"firstname\": \"Jenny\",\n \"phone\": \"16502222222\",\n \"id\": \"4\",\n \"lastname\": \"Green\",\n \"status\": \"Gold\"\n },\n \"completed\": false,\n \"recordDisposition\": \"\",\n \"recordDispositionCode\": \"\",\n \"totalAttempts\": 1,\n \"attempts\": [\n {\n \"call_attempted\": false,\n \"disposition\": \"Fast busy\",\n \"dispositionCode\": \"\",\n \"date\": \"2021-02-19T19:13:08.000\",\n \"phone\": \"16502222222\",\n \"callDuration\": 0,\n \"dialingDuration\": 0,\n \"callNotes\": \"\",\n \"agent\": \"elizabeth\",\n \"globalInteractionID\": \"35DE77AC-5A37-4907-97CA-50B09B30ECDF\",\n \"CPADuration\": 0\n }\n ]\n }\n]"}],"_postman_id":"1cc8cf5e-b179-428d-907a-843872052f46"},{"name":"Query a Record","id":"bb522267-ab63-4593-9966-71fb93b7dae6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"keyfieldName_1\": \"value_1\",\r\n ...\r\n \"keyfieldName_n\": \"value_n\"\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/get/:list_name/:campaignname","description":"This method queries the status of an existing record in the specified calling list in the specified campaign. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. All time values are returned in UTC.
\nNotes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"},{"id":"fc629c22-521a-4224-addd-ab1f7fbde732","description":{"content":"The name of outbound campaign (e.g., Outbound Campaign)
\n","type":"text/plain"},"type":"any","value":"","key":"campaignname"}]}},"response":[{"id":"5b5cf51a-5321-44cb-9266-1036ba8a4edb","name":"Query a Record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": \"2\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/get/:list_name/:campaignname","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","get",":list_name",":campaignname"],"variable":[{"key":"list_name","value":"list.csv"},{"key":"campaignname","value":"Outbound%20Campaign"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"entry\": {\n \"firstname\": \"Mike\",\n \"phone\": \"16505555555\",\n \"id\": \"2\",\n \"lastname\": \"Miller\",\n \"status\": \"Platinum\"\n },\n \"status\": {\n \"globalInteractionID\": \"3F4F2ACD-1233-42E3-8092-3A9F7D9D84BC\",\n \"lastCallDuration\": 0,\n \"lastDisposition\": \"Try again later\",\n \"totalAttempts\": 1,\n \"completed\": false,\n \"lastAgent\": \"elizabeth\",\n \"lastPhone\": \"16505555555\",\n \"lastDate\": \"2021-02-19T19:12:21.000\"\n }\n}"}],"_postman_id":"bb522267-ab63-4593-9966-71fb93b7dae6"},{"name":"Update Record","id":"de52f764-9ffe-4f74-a59d-bee3401185a6","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"fieldName_1\": \"value_1\",\r\n ...\r\n \"fieldName_n\": \"value_n\"\r\n}"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/update/:list_name","description":"This method updates fields in an existing record in the specified calling list. It returns an error if a record with the same values of unique keys as configured in the list definition does not exist. The unique keys cannot be changed.
\nNote: Updating a list record requires internal reprocessing of the entire calling list. Thus, if this method is applied to a list within a running campaign, the use of this list within the given campaign will be suspended until list reprocessing is complete. The suspension time will depend on the list size and, for long lists, may amount to tens of minutes. Other lists associated with the same campaign will not be affected.
\nOther Notes:
\nThe name of the calling list (e.g., list.csv)
\n","type":"text/plain"},"type":"any","value":"","key":"list_name"}]}},"response":[{"id":"6f6b5272-da0c-4e77-a22d-79ab35ca4db8","name":"Update Record","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ID\": \"4\",\r\n \"firstName\": \"Posty\",\r\n \"lastName\": \"Melon\",\r\n \"Phone\": \"16505555555\",\r\n \"Status\": \"Platinum\"\r\n}"},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/callinglist/update/:list_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","callinglist","update",":list_name"],"variable":[{"key":"list_name","value":"list.csv"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"de52f764-9ffe-4f74-a59d-bee3401185a6"}],"id":"eef56bf6-e90e-4cbb-a64f-40d2ac9d3a37","description":"With the OneCloud CX List Management API you currently can:
\nThis 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.
\n","event":[{"listen":"prerequest","script":{"id":"a1bc3b13-0f55-4ec1-b3eb-922a3142d673","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"de86ee25-6b23-4f8f-8176-b4cbb11fcef4","type":"text/javascript","exec":[""]}}],"_postman_id":"eef56bf6-e90e-4cbb-a64f-40d2ac9d3a37","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"myAccessTokenHereXXXXXXXXXXXXX"}]},"isInherited":true,"source":{"_postman_id":"2554f124-6b57-4229-8ffe-d7778d349e25","id":"2554f124-6b57-4229-8ffe-d7778d349e25","name":"OneCloud CX","type":"collection"}}},{"name":"Campaigns","item":[{"name":"Get Campaigns","id":"80237a68-c786-453f-b515-3b9c67bd9c01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/campaign/getAll/","description":"This method returns the list of enabled campaigns and the calling lists currently associated with such campaigns. It does not return any disabled campaigns.
\nNotes:
\nThis method adds new records to the specified Do Not Call (DNC) list and returns the number of added (i.e., appended) records. Duplicates are ignored.
\nAn optional comment field value is inserted in the comment field of a geographic (postal) DNC record, campaign name field of an internal DNC record, and in the comment field of area codes DNC record. This method is supported for internal, geographic postal, area codes, and record exclusion DNC lists.
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":"","key":"do_not_call_list_name"}]}},"response":[{"id":"5ea99db1-3c6f-43a9-8ef2-09b80c56a5af","name":"Add Records to DNC","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"[\r\n [\r\n \"123456789\",\r\n \"optional comment\"\r\n ],\r\n [\r\n \"9999999999\",\r\n \"optional comment\"\r\n ]\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/donotcalllist/add/:do_not_call_list_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","donotcalllist","add",":do_not_call_list_name"],"variable":[{"key":"do_not_call_list_name","value":"DNC_List"}]}},"status":"Success","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"added\": 2\r\n}"}],"_postman_id":"53ebc70f-977c-42da-9929-cff0180b4a5e"},{"name":"Replace Records in DNC","id":"08783a90-28d0-4937-979c-18d8156cbbe9","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n [\r\n \"123456789\",\r\n \"optional comment\"\r\n ],\r\n …\r\n [\r\n \"9999999999\",\r\n \"optional comment\"\r\n ]\r\n]"},"url":"https://mytenant.cx.onecloud.com/configapi/v2/donotcalllist/replaceAll/:do_not_call_list_name","description":"The method replaces all records in the specified Do Not Call (DNC) list and returns the number of newly inserted records. Duplicates are ignored. An optional comment field value is inserted in the comment field of a geographic (postal) DNC record, campaign name field of an internal DNC record, and in the comment field of area codes DNC record. This method is supported for internal, geographic postal area codes, and accounts' DNC lists.
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":"","key":"do_not_call_list_name"}]}},"response":[{"id":"54f20486-c6f7-4bf1-bb4c-8c97c16c9eb6","name":"Replace Records in DNC","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 15490315E83EBC929978DB0AE84D0AC63F0DC38AAB701A949FDEF6054E4A1AF9","type":"text"}],"body":{"mode":"raw","raw":"[\r\n [\r\n \"123456789\",\r\n \"optional comment\"\r\n ],\r\n [\r\n \"9999999999\",\r\n \"optional comment\"\r\n ]\r\n]","options":{"raw":{"language":"json"}}},"url":{"raw":"https://mytenant.cx.onecloud.com/configapi/v2/donotcalllist/replaceAll/:do_not_call_list_name","protocol":"https","host":["mytenant.cx.onecloud.com"],"path":["configapi","v2","donotcalllist","replaceAll",":do_not_call_list_name"],"variable":[{"key":"do_not_call_list_name","value":"DNC_List"}]}},"status":"Success","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"added\": 2\r\n}"}],"_postman_id":"08783a90-28d0-4937-979c-18d8156cbbe9"},{"name":"Delete All Records","id":"5bc0ef70-b756-4e21-8077-d1a37650543e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://mytenant.cx.onecloud.com/configapi/v2/donotcalllist/deleteAll/:do_not_call_list_name","description":"This method deletes all records from the specified DNC List and returns the number of deleted records.
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":null,"key":"do_not_call_list_name"}]}},"response":[{"id":"1c3cc4a0-cc1c-47ab-aeb3-04e7f5d6d72e","name":"Delete All Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"BearerThis method deletes the list of specified records from the DNC List, returns the number of deleted records and list of errors if there are.
\nInput parameters:
\nThe name of the Do Not Call list (e.g., DNC_List)
\n","type":"text/plain"},"type":"any","value":null,"key":"do_not_call_list_name"}]}},"response":[{"id":"396a203d-3698-4356-8916-2d2e22ef1699","name":"Delete Records","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer