{"info":{"_postman_id":"4a7c7404-5c5c-4e13-b68a-e7374b3c5489","name":"MRE 3.x","description":"<html><head></head><body><p>This collection contains API requests for MRE 3.x. It does not contain Mre Microservice REST API requests.</p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8262326","collectionId":"4a7c7404-5c5c-4e13-b68a-e7374b3c5489","publishedId":"Tz5qbJ8j","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-03-15T05:24:44.000Z"},"item":[{"name":"v2","item":[{"name":"Get Estimated Wait Time","id":"1ce5bf56-cf84-4946-8341-49cff7fecf9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mre/api/v2/ewt?qid=<queue-id OR skillgroup OR queue-name>&priority=<priority-integer-value>&convid=<conversation-id>&taskid=<task-id>","description":"<p>API version 2.\nUsed to get estimated wait time of a task currently enqueued in a routing queue.\nIt can also be used to fetch estimated position and estimated wait time of a task in a queue before enqueuing the task.</p>\n","urlObject":{"path":["mre","api","v2","ewt"],"query":[{"description":{"content":"<p>Optional. Mention skillgroup/queue name to get EWT of a task in the queue. If this parameter is not added in the request or is empty, MRE will return ewt for Default Precision Queue.</p>\n","type":"text/plain"},"key":"qid","value":"<queue-id OR skillgroup OR queue-name>"},{"description":{"content":"<p>Optional. Integer priority value from 1 to 10 where 1 is the lowest and 10 is the highest. If it is not available in the request or contains non-integer values, MRE considers the routing priority as 1 (the lowest). However, in case of any integer ≥ 10, MRE sets the routing priority value to 10. If mentioned value of this parameter is ≤ 1, MRE sets the routing priority value to 1.</p>\n","type":"text/plain"},"key":"priority","value":"<priority-integer-value>"},{"description":{"content":"<p>Optional. This is used to fetch the estimated wait time of a task in queue. Use only queueid and conversation id to fetch the EWT of a task currently in queue. Priority value is ignored when conversation id is present in request parameters</p>\n","type":"text/plain"},"key":"convid","value":"<conversation-id>"},{"description":{"content":"<p>Optional. This is used to fetch the estimated wait time of a task in queue. Use only queueid and task id to fetch the EWT of a task currently in queue. Priority value is ignored when task id is present in request parameters.\nTask Id and conversation Id are alternatives to each other, a user may use any of them to fetch current EWT of a task</p>\n","type":"text/plain"},"key":"taskid","value":"<task-id>"}],"variable":[]}},"response":[{"id":"2d3c47e5-4131-4fa3-909c-6e4bffcea6b1","name":"Get Estimated Wait Time","originalRequest":{"method":"GET","header":[],"url":{"raw":"/api/v2/ewt?qid=<queue-id OR skillgroup OR queue-name>&priority=<priority-integer-value>&convid=<conversation-id>&taskid=<task-id>","path":["api","v2","ewt"],"query":[{"key":"qid","value":"<queue-id OR skillgroup OR queue-name>","description":"Optional. Mention skillgroup/queue name to get EWT of a task in the queue. If this parameter is not added in the request or is empty, MRE will return ewt for Default Precision Queue."},{"key":"priority","value":"<priority-integer-value>","description":"Optional. Integer priority value from 1 to 10 where 1 is the lowest and 10 is the highest. If it is not available in the request or contains non-integer values, MRE considers the routing priority as 1 (the lowest). However, in case of any integer ≥ 10, MRE sets the routing priority value to 10. If mentioned value of this parameter is ≤ 1, MRE sets the routing priority value to 1."},{"key":"convid","value":"<conversation-id>","description":"Optional. This is used to fetch the estimated wait time of a task in queue. Use only queueid and conversation id to fetch the EWT of a task currently in queue. Priority value is ignored when conversation id is present in request parameters"},{"key":"taskid","value":"<task-id>","description":"Optional. This is used to fetch the estimated wait time of a task in queue. Use only queueid and task id to fetch the EWT of a task currently in queue. Priority value is ignored when task id is present in request parameters.\nTask Id and conversation Id are alternatives to each other, a user may use any of them to fetch current EWT of a task"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 22 Aug 2021 16:03:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Length","value":"91"},{"key":"Server","value":"Jetty(9.4.35.v20201120)"}],"cookie":[],"responseTime":null,"body":"{\n    \"ConversationId\": \"\",\n    \"EWT\": 100, // Estimated wait time\n    \"TaskId\": \"\",\n    \"Position\": 1, // Position for already enqueued task. Estimated position of a task before enqueuing\n    \"QueueName\": \"DefaultPrecisionQueue\" // Queue name\n}"}],"_postman_id":"1ce5bf56-cf84-4946-8341-49cff7fecf9b"}],"id":"73297c7b-839b-450d-b93e-1ef138c95204","_postman_id":"73297c7b-839b-450d-b93e-1ef138c95204","description":""},{"name":"Agent Info","id":"33c16fb2-5479-4dea-9124-7f2fccaf30ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mre/api/Agent?agentId=<agent-id>","description":"<p>This request is used to get Agent information. It returns agent information and the list of queues the agent is part of. The agent information is returned only if the agent is a <strong>Chat Agent</strong>.</p>\n","urlObject":{"path":["mre","api","Agent"],"query":[{"description":{"content":"<p>Change this to your agent login id</p>\n","type":"text/plain"},"key":"agentId","value":"<agent-id>"}],"variable":[]}},"response":[{"id":"0407f6fd-1f6f-48c9-8a73-56a6fc0cc881","name":"Agent Info","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://192.168.2.56/mre/api/Agent?agentId=awais","protocol":"https","host":["192","168","2","56"],"path":["mre","api","Agent"],"query":[{"key":"agentId","value":"awais","description":"Change this to your agent login id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Date","value":"Fri, 12 Mar 2021 12:39:06 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains"},{"key":"Public-Key-Pins","value":"pin-sha256=\"klO23nT2ehFDXCfx3eHTDRESMz3asj1muO+4aIdjiuY=\"; pin-sha256=\"633lt352PKRXbOwf4xSEa1M517scpD3l5f79xMD9r9Q=\"; max-age=2592000; includeSubDomains"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"MRE_Agent\": true,\n    \"Queues\": [\n        \"DefaultPrecisionQueue\",\n        \"QueueOne\",\n        \"QueueTwo\",\n        \"QueueThree\",\n        \"QueueFour\"\n    ],\n    \"AgentId\": \"awais\"\n}"}],"_postman_id":"33c16fb2-5479-4dea-9124-7f2fccaf30ef"},{"name":"System Status","id":"49208df8-b254-4fff-ad3d-c74326a1d9b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mre/api/status","description":"<p>Can be used for Health Check, this API returns system status</p>\n","urlObject":{"path":["mre","api","status"],"query":[],"variable":[]}},"response":[{"id":"aca1ef30-a8a1-4f49-bd99-c6f5f7524860","name":"System Status","originalRequest":{"method":"GET","header":[],"url":"https://192.168.2.56/mre/api/status"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Date","value":"Fri, 12 Mar 2021 12:39:59 GMT"},{"key":"Content-Length","value":"14"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains"},{"key":"Public-Key-Pins","value":"pin-sha256=\"klO23nT2ehFDXCfx3eHTDRESMz3asj1muO+4aIdjiuY=\"; pin-sha256=\"633lt352PKRXbOwf4xSEa1M517scpD3l5f79xMD9r9Q=\"; max-age=2592000; includeSubDomains"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"}],"cookie":[],"responseTime":null,"body":"MRE#IN_SERVICE"}],"_postman_id":"49208df8-b254-4fff-ad3d-c74326a1d9b7"},{"name":"Estimated Wait Time","id":"0ec16d9e-1216-4fab-ad3d-a9e68d05a46a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mre/api/EWT?SkillGroup=<skillgroup>&ConversationId=<conversation-id>&TaskId=<task-id>","description":"<p>Used to get estimated wait time for a task. This API returns estimated wait time in seconds. It also returns task position in the queue with Queue Name.</p>\n","urlObject":{"path":["mre","api","EWT"],"query":[{"description":{"content":"<p>Skill group is same as queue name for MRE. Replace  with queue name</p>\n","type":"text/plain"},"key":"SkillGroup","value":"<skillgroup>"},{"description":{"content":"<p>Conversation if for the task for which EWT is required</p>\n","type":"text/plain"},"key":"ConversationId","value":"<conversation-id>"},{"description":{"content":"<p>Task Id for the task for which EWT is required</p>\n","type":"text/plain"},"key":"TaskId","value":"<task-id>"}],"variable":[]}},"response":[{"id":"25918310-acc4-4d83-a6d3-135f29792e32","name":"Estimated Wait Time","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://192.168.2.56/mre/api/EWT?SkillGroup=VIP&ConversationId=VgbTOskqYxLORWQYDeSB8&TaskId=","protocol":"https","host":["192","168","2","56"],"path":["mre","api","EWT"],"query":[{"key":"SkillGroup","value":"VIP","description":"Skill group is same as queue name for MRE. Replace <skillgroup> with queue name"},{"key":"ConversationId","value":"VgbTOskqYxLORWQYDeSB8","description":"Conversation if for the task for which EWT is required"},{"key":"TaskId","value":"","description":"Task Id for the task for which EWT is required"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Date","value":"Fri, 12 Mar 2021 12:44:45 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains"},{"key":"Public-Key-Pins","value":"pin-sha256=\"klO23nT2ehFDXCfx3eHTDRESMz3asj1muO+4aIdjiuY=\"; pin-sha256=\"633lt352PKRXbOwf4xSEa1M517scpD3l5f79xMD9r9Q=\"; max-age=2592000; includeSubDomains"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n    \"ConversationId\": \"VgbTOskqYxLORWQYDeSB8\",\n    \"EWT\": 10,\n    \"TaskId\": \"70fcfbaf-31e7-465a-8f5c-1f38cee1b7c5\",\n    \"Position\": 1,\n    \"QueueName\": \"DefaultPrecisionQueue\"\n}"}],"_postman_id":"0ec16d9e-1216-4fab-ad3d-a9e68d05a46a"},{"name":"Agent States per Queue","id":"c92719d7-c5c7-4877-bee3-005ca1c47b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mre/api/AgentStats","description":"<p>This API is used to fetch agent states for every queue. It returns number of agents in every state for every step in a queue. An agent can have one of the following states:</p>\n<ul>\n<li>Active </li>\n<li>Busy</li>\n<li>Ready</li>\n<li>Not Ready</li>\n<li>Pending Not Ready</li>\n</ul>\n","urlObject":{"path":["mre","api","AgentStats"],"query":[],"variable":[]}},"response":[{"id":"4bb22683-66f5-47aa-a8a9-6c8ae330a40f","name":"Agent States per Queue","originalRequest":{"method":"GET","header":[],"url":"https://192.168.2.56/mre/api/AgentStats"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Date","value":"Fri, 12 Mar 2021 12:40:28 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains"},{"key":"Public-Key-Pins","value":"pin-sha256=\"klO23nT2ehFDXCfx3eHTDRESMz3asj1muO+4aIdjiuY=\"; pin-sha256=\"633lt352PKRXbOwf4xSEa1M517scpD3l5f79xMD9r9Q=\"; max-age=2592000; includeSubDomains"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"QueueSteps\": [\n            {\n                \"StepStats\": {\n                    \"READY\": 0,\n                    \"WORK_NOT_READY\": 0,\n                    \"LOGOUT\": 1,\n                    \"WORK_READY\": 0,\n                    \"ACTIVE\": 0,\n                    \"NOT_READY\": 0,\n                    \"BUSY\": 0,\n                    \"LOGIN\": 0,\n                    \"RESERVED\": 0,\n                    \"UNKNOWN\": 0,\n                    \"INTERRUPTED\": 0\n                },\n                \"StepName\": \"step1\"\n            }\n        ],\n        \"StatesCount\": {\n            \"READY\": 0,\n            \"WORK_NOT_READY\": 0,\n            \"LOGOUT\": 1,\n            \"WORK_READY\": 0,\n            \"ACTIVE\": 0,\n            \"NOT_READY\": 0,\n            \"BUSY\": 0,\n            \"LOGIN\": 0,\n            \"RESERVED\": 0,\n            \"UNKNOWN\": 0,\n            \"INTERRUPTED\": 0\n        },\n        \"MaxTime\": 0,\n        \"Labels\": {},\n        \"QueueName\": \"DefaultPrecisionQueue\"\n    },\n    {\n        \"QueueSteps\": [\n            {\n                \"StepStats\": {\n                    \"READY\": 0,\n                    \"WORK_NOT_READY\": 0,\n                    \"LOGOUT\": 1,\n                    \"WORK_READY\": 0,\n                    \"ACTIVE\": 0,\n                    \"NOT_READY\": 0,\n                    \"BUSY\": 0,\n                    \"LOGIN\": 0,\n                    \"RESERVED\": 0,\n                    \"UNKNOWN\": 0,\n                    \"INTERRUPTED\": 0\n                },\n                \"StepName\": \"step_1\"\n            }\n        ],\n        \"StatesCount\": {\n            \"READY\": 0,\n            \"WORK_NOT_READY\": 0,\n            \"LOGOUT\": 1,\n            \"WORK_READY\": 0,\n            \"ACTIVE\": 0,\n            \"NOT_READY\": 0,\n            \"BUSY\": 0,\n            \"LOGIN\": 0,\n            \"RESERVED\": 0,\n            \"UNKNOWN\": 0,\n            \"INTERRUPTED\": 0\n        },\n        \"MaxTime\": 0,\n        \"Labels\": {},\n        \"QueueName\": \"QueueOne\"\n    },\n    {\n        \"QueueSteps\": [\n            {\n                \"StepStats\": {\n                    \"READY\": 0,\n                    \"WORK_NOT_READY\": 0,\n                    \"LOGOUT\": 1,\n                    \"WORK_READY\": 0,\n                    \"ACTIVE\": 0,\n                    \"NOT_READY\": 0,\n                    \"BUSY\": 0,\n                    \"LOGIN\": 0,\n                    \"RESERVED\": 0,\n                    \"UNKNOWN\": 0,\n                    \"INTERRUPTED\": 0\n                },\n                \"StepName\": \"step_1\"\n            }\n        ],\n        \"StatesCount\": {\n            \"READY\": 0,\n            \"WORK_NOT_READY\": 0,\n            \"LOGOUT\": 1,\n            \"WORK_READY\": 0,\n            \"ACTIVE\": 0,\n            \"NOT_READY\": 0,\n            \"BUSY\": 0,\n            \"LOGIN\": 0,\n            \"RESERVED\": 0,\n            \"UNKNOWN\": 0,\n            \"INTERRUPTED\": 0\n        },\n        \"MaxTime\": 0,\n        \"Labels\": {},\n        \"QueueName\": \"QueueTwo\"\n    },\n    {\n        \"QueueSteps\": [\n            {\n                \"StepStats\": {\n                    \"READY\": 0,\n                    \"WORK_NOT_READY\": 0,\n                    \"LOGOUT\": 1,\n                    \"WORK_READY\": 0,\n                    \"ACTIVE\": 0,\n                    \"NOT_READY\": 0,\n                    \"BUSY\": 0,\n                    \"LOGIN\": 0,\n                    \"RESERVED\": 0,\n                    \"UNKNOWN\": 0,\n                    \"INTERRUPTED\": 0\n                },\n                \"StepName\": \"step_1\"\n            }\n        ],\n        \"StatesCount\": {\n            \"READY\": 0,\n            \"WORK_NOT_READY\": 0,\n            \"LOGOUT\": 1,\n            \"WORK_READY\": 0,\n            \"ACTIVE\": 0,\n            \"NOT_READY\": 0,\n            \"BUSY\": 0,\n            \"LOGIN\": 0,\n            \"RESERVED\": 0,\n            \"UNKNOWN\": 0,\n            \"INTERRUPTED\": 0\n        },\n        \"MaxTime\": 0,\n        \"Labels\": {},\n        \"QueueName\": \"QueueThree\"\n    },\n    {\n        \"QueueSteps\": [\n            {\n                \"StepStats\": {\n                    \"READY\": 0,\n                    \"WORK_NOT_READY\": 0,\n                    \"LOGOUT\": 1,\n                    \"WORK_READY\": 0,\n                    \"ACTIVE\": 0,\n                    \"NOT_READY\": 0,\n                    \"BUSY\": 0,\n                    \"LOGIN\": 0,\n                    \"RESERVED\": 0,\n                    \"UNKNOWN\": 0,\n                    \"INTERRUPTED\": 0\n                },\n                \"StepName\": \"step_1\"\n            }\n        ],\n        \"StatesCount\": {\n            \"READY\": 0,\n            \"WORK_NOT_READY\": 0,\n            \"LOGOUT\": 1,\n            \"WORK_READY\": 0,\n            \"ACTIVE\": 0,\n            \"NOT_READY\": 0,\n            \"BUSY\": 0,\n            \"LOGIN\": 0,\n            \"RESERVED\": 0,\n            \"UNKNOWN\": 0,\n            \"INTERRUPTED\": 0\n        },\n        \"MaxTime\": 0,\n        \"Labels\": {},\n        \"QueueName\": \"QueueFour\"\n    }\n]"}],"_postman_id":"c92719d7-c5c7-4877-bee3-005ca1c47b05"},{"name":"Agents Availability Check for Chat","id":"f430e3f8-e3d7-4b85-8465-04421a3e80cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/mre/api/AvailableAgents","description":"<p>Thsi API is used to check if there are any agents available to serve chat requests. An agent is considered for Chat if the agent is logged in and has one of the following states:</p>\n<ul>\n<li>Ready</li>\n<li>Busy</li>\n<li>Active</li>\n<li>Reserved</li>\n</ul>\n","urlObject":{"path":["mre","api","AvailableAgents"],"query":[],"variable":[]}},"response":[{"id":"6f5be090-6086-41f1-8455-309a341f9486","name":"Agents Availability Check for Chat","originalRequest":{"method":"GET","header":[],"url":"https://192.168.2.56/mre/api/AvailableAgents"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Date","value":"Fri, 12 Mar 2021 12:40:43 GMT"},{"key":"Content-Length","value":"26"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains"},{"key":"Public-Key-Pins","value":"pin-sha256=\"klO23nT2ehFDXCfx3eHTDRESMz3asj1muO+4aIdjiuY=\"; pin-sha256=\"633lt352PKRXbOwf4xSEa1M517scpD3l5f79xMD9r9Q=\"; max-age=2592000; includeSubDomains"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"}],"cookie":[],"responseTime":null,"body":"{\"isAgentAvailable\":false}"}],"_postman_id":"f430e3f8-e3d7-4b85-8465-04421a3e80cc"}]}