This API allows you to access the data of an HiperME plataform.
\nAll HiperME platforms from version 1.5 have the API and all the endpoints of the API has the prefix api. Example: https://example.hiperpbx.com/api/endpointexample
\n\nYou can only access the following resources if the user has the role 'ROLE_ADMIN'.
\n
When working with Postman, make sure that the variable hiperme_url is defined.
When creating or updating, you will see that almost everytime, you have to send a Endpoint. An Endpoint indicates the resource to use, for example, when creating an Extension, you have to indicate the organization that the is releated to by using the value /api/organizations/:id where id indicates the id of the organization.
When getting a resource, it will have three additional properties @id, that contains the endpoint of the resource, @type that is the type of resource and @context.
When getting a list of resources, the JSON response it will look like this.
\n{\n \"@context\": \"/api/contexts/Extension\",\n \"@id\": \"/api/extensions\",\n \"@type\": \"hydra:Collection\",\n \"hydra:member\": [\n ...\n ],\n \"hydra:totalItems\": 2\n}\n\nThe resources are in the property hydra:member
An JWT Token is required to be sent as part of every request to the HiperME API (except in the Get JWT Token endpoint) in the form of an Bearer Token request header.
If an JWT Token is missing, malformed or invalid, you will receive a 401 Unauthorised response code and one of the following JSON response.
{\n \"code\": 401,\n \"message\": \"Invalid credentials.\"\n}\n\n{\n \"code\": 401,\n \"message\": \"Expired JWT Token\"\n}\n\nThe HiperMe API uses convetional HTTP response codes to indicate the success of failure of an request. Code in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, validation errors, resource not found, etc.)
When creating or updating a resource, if the body request is invalid, you will recive a 400 Bad Request response code and a JSON response like this.
{\n \"@context\": \"/api/contexts/ConstraintViolationList\",\n \"@type\": \"ConstraintViolationList\",\n \"hydra:title\": \"An error occurred\",\n \"hydra:description\": \"name: This value is already used.\",\n \"violations\": [\n {\n \"propertyPath\": \"name\",\n \"message\": \"This value is already used.\"\n }\n ]\n}\n\nIn the violations property, you will get an array of objects with all the validation errors. Every object will have \"propertyPath\" (this is the name of the invalid field) and \"message\" containing the error.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Getting started","slug":"getting-started"},{"content":"Authorization","slug":"authorization"},{"content":"Errors","slug":"errors"}],"owner":"5674311","collectionId":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","publishedId":"TW73DQTM","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-04-21T16:16:48.000Z"},"item":[{"name":"Authorization and user data","item":[{"name":"Recover password","item":[{"name":"Forgot password","id":"dfaeb241-c96f-47d8-9dfd-083addc1e00a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"example@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/forgot-password","description":"This endpoint is use to recover the user password.
\nWhen is endpoint is requested, the system will send a email to the uses with the instructions to recover the password
\nThe body of the request is a JSON with the propierty email
\n","urlObject":{"path":["forgot-password"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"4d94ed75-b01f-484f-ac73-2d37047f6e97","name":"Forgot password","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"example@example.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/forgot-password"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Fri, 16 Jul 2021 17:24:08 GMT"},{"key":"Date","value":"Fri, 16 Jul 2021 17:24:07 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Link","value":"The token to validate the change of password
\n","type":"text/plain"},"type":"any","value":"$2y$13$Ce7oPtXPRgY0mOssHIm5.ro3y3SSqKNEHiZ7pZrOQDBTV6CPSkR6","key":"token"}]}},"response":[],"_postman_id":"746f03f0-c087-4994-a9e7-0d5c1c51b8b0"},{"name":"Change password","id":"832104a4-7364-4381-b067-c34f88d460c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"password\" : \"example\",\r\n \"repeatPassword\" : \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/recover-password/:token","urlObject":{"path":["recover-password",":token"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"The token to validate the change of password
\n","type":"text/plain"},"type":"any","value":"$2y$13$Ce7oPtXPRgY0mOssHIm5.ro3y3SSqKNEHiZ7pZrOQDBTV6CPSkR6","key":"token"}]}},"response":[],"_postman_id":"832104a4-7364-4381-b067-c34f88d460c7"}],"id":"adafdf2d-3dc7-492d-ad20-6d7863c62c2a","_postman_id":"adafdf2d-3dc7-492d-ad20-6d7863c62c2a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Get JWT Token with Username and Password","event":[{"listen":"test","script":{"id":"c2eb4d53-8e5e-4e0b-b88d-d03fd1f779b2","exec":["var json = pm.response.json();\r","\r","if (json.token) {\r"," pm.collectionVariables.set('hiperme_token', json.token)\r"," pm.environment.set('hiperme_token', json.token)\r","}\r",""],"type":"text/javascript","packages":{}}},{"listen":"prerequest","script":{"id":"d4f2473b-463e-46fa-8aec-b4291561b48a","exec":[""],"type":"text/javascript","packages":{}}}],"id":"3674f686-7e7b-4a60-8ed1-916074ddedbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\" : \"john.doe@example.com\",\r\n \"password\" : \"example\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/login_check","description":"This endpoint allows you to get the JWT Token that is required in every endpoint.
\n\n\nFor ease of use inside Postman, every time that you send this request, automatically it will save the token in the variable environment
\nhiperme_token.
On success, the response returns the token
\nThe body of the request is:
\n{\n \"username\" : \"This is the email of the user\",\n \"password\" : \"This is the password of the user\"\n}\nThis endpoint it's used to check if is available session to login. If the are, it will response with:
\nIf the aren't, it will response the following
\n{\n \"status\" : false,\n \"sessions\" 10\n}\nA media server is a Janus WebRTC Server, is used to work with the SIP extensions of the HiperPBX.
\nThis endpoint returns a list of all the media servers.
\n","urlObject":{"path":["media_servers"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"af6c36d5-5794-45a5-965d-e7bfb7fca886","name":"Media Servers","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/media_servers"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 14:01:02 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 14:01:02 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint returns a list of all the firebases configured in the HiperMe Plataform.
\n","urlObject":{"path":["firebases"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"39f0b43b-99c8-4588-a9a5-407bd43e303b","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/firebases"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 17:00:54 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 17:00:54 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint returns a list of all the mail centers
\n","urlObject":{"path":["ostickets"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"efcced8a-07e0-4307-895e-4caf4bb51dc3","name":"Mail Center (Success)","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/ostickets"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 18:07:14 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 18:07:14 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint returns a list of all the chat centers.
\n","urlObject":{"path":["live_helper_chats"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"ab92c59d-572f-41a7-9788-0a8486de2253","name":"Mail Center (Success)","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/ostickets"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 18:07:14 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 18:07:14 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint returns a list of all the organizations that accessible by you.
\n\n\nYou can only access the organzations if you have the rol 'ROLE_ADMIN'
\n
The following is the description of the fields.
\n","urlObject":{"path":["organizations"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Name of the organization
\n","type":"text/plain"},"key":"name","value":null},{"disabled":true,"key":"","value":null}],"variable":[]}},"response":[{"id":"a76c3ec2-dc37-4ee9-8dd5-b71f5b18be7e","name":"Get all the organizations","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/organizations"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 16:54:55 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 16:54:55 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint allows the creation of organizations.
\nOnly a user with the rol ROLE_ADMIN can create organizations.
This is the description of the body request.
\n","urlObject":{"path":["organizations"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"bcd27603-f2e6-4f62-8b6f-b69aa18afc91","name":"Validation Errors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"LiveHelperChat\": \"/api/live_helper_chats/1\",\r\n \"agentSessions\": 10,\r\n \"dataSetAlt\": \"yes\",\r\n \"domain\": null,\r\n \"firebase\": \"/api/firebases/1\",\r\n \"logo\": null,\r\n \"mediaServerAlt\": \"/api/media_servers/1\",\r\n \"name\": \"PostmanDoc\",\r\n \"osticket\": null,\r\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\r\n \"recordingUrlAlt\": \"https://localhost:8081\",\r\n \"restApiAddressAlt\": \"https://localhost:8080\",\r\n \"sessions\": 10,\r\n \"status\": \"Activo\",\r\n \"theme\": null,\r\n \"users\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/organizations"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint allows the editing of organizations.
\nOnly a user with the rol ROLE_ADMIN can edit organizations.
This is the description of the body request.
\n","urlObject":{"path":["organizations",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"Id of the organization to edit
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"26ccfa41-c774-4bf2-a8a6-e45b28153cbb","name":"Validation Errors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"LiveHelperChat\": \"/api/live_helper_chats/1\",\r\n \"agentSessions\": 10,\r\n \"dataSetAlt\": \"yes\",\r\n \"domain\": null,\r\n \"firebase\": \"/api/firebases/1\",\r\n \"logo\": null,\r\n \"mediaServerAlt\": \"/api/media_servers/1\",\r\n \"name\": \"PostmanDoc\",\r\n \"osticket\": null,\r\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\r\n \"recordingUrlAlt\": \"https://localhost:8081\",\r\n \"restApiAddressAlt\": \"https://localhost:8080\",\r\n \"sessions\": 10,\r\n \"status\": \"Activo\",\r\n \"theme\": null,\r\n \"users\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/organizations"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Image of the logo
\n","type":"text"}]},"url":"https://me.hiperpbx.com/api/organizations/:id/update-logo","urlObject":{"path":["organizations",":id","update-logo"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"id":"7bfeeed6-379f-4a31-b7b7-bd427315119c","description":{"content":"Id of the organization to edit
\n","type":"text/plain"},"type":"string","value":"3","key":"id"}]}},"response":[{"id":"c1c85f23-aae0-4e8c-af06-617ff7c5f112","name":"Validation Errors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"LiveHelperChat\": \"/api/live_helper_chats/1\",\r\n \"agentSessions\": 10,\r\n \"dataSetAlt\": \"yes\",\r\n \"domain\": null,\r\n \"firebase\": \"/api/firebases/1\",\r\n \"logo\": null,\r\n \"mediaServerAlt\": \"/api/media_servers/1\",\r\n \"name\": \"PostmanDoc\",\r\n \"osticket\": null,\r\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\r\n \"recordingUrlAlt\": \"https://localhost:8081\",\r\n \"restApiAddressAlt\": \"https://localhost:8080\",\r\n \"sessions\": 10,\r\n \"status\": \"Activo\",\r\n \"theme\": null,\r\n \"users\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/organizations"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Id of the organization to edit
\n","type":"text/plain"},"type":"string","value":"2","key":"id"}]}},"response":[{"id":"828a1b28-ef1f-427a-a62b-c0ac871552f9","name":"Validation Errors","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"LiveHelperChat\": \"/api/live_helper_chats/1\",\r\n \"agentSessions\": 10,\r\n \"dataSetAlt\": \"yes\",\r\n \"domain\": null,\r\n \"firebase\": \"/api/firebases/1\",\r\n \"logo\": null,\r\n \"mediaServerAlt\": \"/api/media_servers/1\",\r\n \"name\": \"PostmanDoc\",\r\n \"osticket\": null,\r\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\r\n \"recordingUrlAlt\": \"https://localhost:8081\",\r\n \"restApiAddressAlt\": \"https://localhost:8080\",\r\n \"sessions\": 10,\r\n \"status\": \"Activo\",\r\n \"theme\": null,\r\n \"users\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/organizations"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000","uuid":"e83e7de7-dcc9-4c9b-b863-608d86a1726b"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT","uuid":"658eb27d-6c15-4992-b903-653a815a3866"},{"key":"Date","value":"Tue, 24 Nov 2020 17:36:34 GMT","uuid":"658eb27d-6c15-4992-b903-653a815a3866"},{"key":"Connection","value":"close","uuid":"f8ee5b3d-d16e-437d-92a9-4ff6d03c0636"},{"key":"X-Powered-By","value":"PHP/7.4.10","uuid":"0c78da74-fc18-4529-9099-e3afe8f967fe"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8","uuid":"08761c17-7336-48b0-ac74-a674af0abe74"},{"key":"X-Content-Type-Options","value":"nosniff","uuid":"d64a99f3-ea31-414d-bf05-57e38ad52bb9"},{"key":"X-Frame-Options","value":"deny","uuid":"030e7991-83b3-4d9c-beed-29cbdfbd60cf"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private","uuid":"7c285642-d6b6-43b6-aa30-c577ffbf6040"},{"key":"Link","value":"This endpoint returns a list of all the extensions
\n","urlObject":{"path":["extensions"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search extensions by organization id
\n","type":"text/plain"},"key":"organization.id","value":""},{"disabled":true,"description":{"content":"Search extensions by organization name
\n","type":"text/plain"},"key":"organization.name","value":""},{"disabled":true,"description":{"content":"Search extension by number
\n","type":"text/plain"},"key":"extension","value":""},{"disabled":true,"description":{"content":"Search extension by name
\n","type":"text/plain"},"key":"name","value":null}],"variable":[]}},"response":[{"id":"573cf4ab-4a16-4375-9e0f-dafa3f75b9e5","name":"Success","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/extensions"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 18:30:36 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 18:30:36 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint allows the creation of extensions
\nThis is the description of the body request.
\n\n\nThe password must have:
\n
This endpoint allows the editing of a extension
\nThis is the description of the body request.
\n\n\nThe password must have:
\n
Id of the extension to update
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"9c1294c5-f627-45de-80b7-9f82dc62fca5","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"extension\" : \"789\",\r\n \"name\" : \"Postman\",\r\n \"organization\" : \"/api/organizations/1\",\r\n \"secret\" : \"Q1w2e3r4t5&\"\r\n}"},"url":"https://me.hiperpbx.com/api/extensions"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 19:30:14 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 19:30:14 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Id of the extension to delete
\n","type":"text/plain"},"type":"string","value":"0","key":"id"}]}},"response":[{"id":"729f21df-f728-49de-9813-eee902c13c41","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"extension\" : \"789\",\r\n \"name\" : \"Postman\",\r\n \"organization\" : \"/api/organizations/1\",\r\n \"secret\" : \"Q1w2e3r4t5&\"\r\n}"},"url":"https://me.hiperpbx.com/api/extensions"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 19:30:14 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 19:30:14 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This is the description of the body request.
\n","urlObject":{"path":["url_iframes"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"23284dbd-1d3a-49bd-942c-64fa9eaeff4d","name":"Create new Url","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"Example\",\r\n \"link\" : \"https://example.com\",\r\n \"organization\" : \"/api/organizations/1\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/url_iframes"},"status":"Created","code":201,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 13:47:58 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 13:47:58 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This is the description of the body request.
\n","urlObject":{"path":["url_iframes",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"Url id
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"631dd4b6-dcdf-44f1-bab9-e6001018e262","name":"Update URL","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"Example\",\r\n \"link\" : \"https://example.update.com\",\r\n \"organization\" : \"/api/organizations/2\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://me.hiperpbx.com/api/url_iframes/:id","host":["https://me.hiperpbx.com/api"],"path":["url_iframes",":id"],"variable":[{"key":"id","value":"4","description":"Url id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 13:53:28 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 13:53:28 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Url id
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"5f35d763-bfef-44c2-be37-d91f2d67dcfc","name":"Update URL Copy","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"Example\",\r\n \"link\" : \"https://example.update.com\",\r\n \"organization\" : \"/api/organizations/2\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://me.hiperpbx.com/api/url_iframes/:id","host":["https://me.hiperpbx.com/api"],"path":["url_iframes",":id"],"variable":[{"key":"id","value":"4","description":"Url id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 13:55:38 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 13:55:38 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Searches can be performed using the following keys in the query parameters:
\nKeep in mind that if you use the 2 keys, it makes \"AND\" criteria.
\nNote: If the `lastLogin` field is null, the user has not logged in yet.
\n","urlObject":{"path":["users"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search in the organizations.name
\n","type":"text/plain"},"key":"organizations.name","value":"example"},{"disabled":true,"description":{"content":"Search in the fields: name, lastname, email or username
\n","type":"text/plain"},"key":"simplesearch","value":"john"},{"disabled":true,"description":{"content":"Search in the organizations.id
\n","type":"text/plain"},"key":"organizations.id","value":"1"},{"disabled":true,"description":{"content":"Search users by status. Posible values: 0 or 1
\n","type":"text/plain"},"key":"isActive","value":null}],"variable":[]}},"response":[{"id":"fc7881c1-da7c-4132-8988-6bd741d745a1","name":"Get all the users","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Mon, 09 May 2022 19:58:51 GMT"},{"key":"Date","value":"Mon, 09 May 2022 19:58:51 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.29"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint allows you to create users.
\nThis is the description of the body request.
\n\n\nThe avaliable roles are:
\n
ROLE_USER
\nROLE_ADMIN
\nROLE_AGENT
\nROLE_MANAGER
\nROLE_AGENT_SUPERVISOR
\n\n\nThe password must be:
\n
At least one letter
\nAt least one capital letter
\nAt least one Number
\nAt least one special character ($%&*!#)
\nMinimum of 10 characters
\nThis endpoint allows you to update users.
\nThis is the description of the body request.
\n\n\nThe avaliable roles are:
\n
\n\nThe password must be:
\n
Users ids
\n","type":"text/plain"},"type":"string","value":"2","key":"id"}]}},"response":[{"id":"d0d826ee-2111-4d0a-9cb5-e9aaa26c7dcc","name":"Success","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"John\",\r\n \"lastname\" : \"Doe\",\r\n \"email\" : \"john.doe@example.postman.com\",\r\n \"password\" : \"Q1w2e3r4t5&\",\r\n \"organizations\" : [\"/api/organizations/2\"],\r\n \"hasVideoCall\" : \"no\",\r\n \"roles\" : [\"ROLE_USER\"],\r\n \"organizationSessionAlt\" : \"/api/organizations/2\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://me.hiperpbx.com/api/users/:id","host":["https://me.hiperpbx.com/api"],"path":["users",":id"],"variable":[{"key":"id","value":"24","description":"Users ids"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 12:02:06 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 12:02:06 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This endpoint allows you to activate/deactivate an user
\nThis is the description of the body request.
\nUse 1 to active the user
\nUse 0 to deactivate the user
\n","urlObject":{"path":["users",":id","active"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"The user id that you want to desactivate
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[{"id":"87302c71-5639-4e4b-9d3f-b658d1304819","name":"Get all the users","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/users"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 11:55:55 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 11:55:55 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Id of the user
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"2d0cd90b-c693-471f-a15a-9aa58786f95b"},{"name":"Get all users without agent","id":"dcecd926-d7c0-4ff3-8c32-e85db3d811f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"https://me.hiperpbx.com/api/users-without-agent","urlObject":{"path":["users-without-agent"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"dcecd926-d7c0-4ff3-8c32-e85db3d811f5"},{"name":"Change profile picture of the user","id":"8b420ab1-b9a6-4d55-a2aa-f381d437ceaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://firebasestorage.googleapis.com/v0/b/simplificloud-1534336262931.appspot.com/o/profile-pictures%2FyrTesZxYAwNVYIOBaqZHZbTeFeT2?alt=media&token=5c87ae78-e458-4899-9b6a-c8f35e836d64\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/change-profile-picture","urlObject":{"path":["change-profile-picture"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b420ab1-b9a6-4d55-a2aa-f381d437ceaf"},{"name":"Notify user usign email","id":"561df4bc-0127-4b4c-8d62-4aa13f328e83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\" : \"john.doe@example.com\",\r\n \"title\" : \"Title of the notification\",\r\n \"body\" : \"Body of the notification\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/users/notify-by-email","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["users","notify-by-email"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"561df4bc-0127-4b4c-8d62-4aa13f328e83"}],"id":"99d995e1-a762-45c7-8ed9-8098fa4032e0","description":"\n\nWhen you register or update a user, you must follow these rules:
\n
Search agents by number
\n","type":"text/plain"},"key":"number","value":""},{"disabled":true,"description":{"content":"Search agents by organization name
\n","type":"text/plain"},"key":"organization.name","value":null},{"disabled":true,"description":{"content":"Search agents by organization id
\n","type":"text/plain"},"key":"organization.id","value":null},{"disabled":true,"description":{"content":"Search agents by user name
\n","type":"text/plain"},"key":"user.name","value":null},{"disabled":true,"description":{"content":"Search agents by user email
\n","type":"text/plain"},"key":"user.email","value":null}],"variable":[]}},"response":[{"id":"20a1c07e-1ecf-40c1-938a-7114359023ad","name":"Get all the agents","originalRequest":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/agents"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 26 Jan 2021 11:34:11 GMT"},{"key":"Date","value":"Tue, 26 Jan 2021 11:34:11 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This is the description of the body request.
\n\n\nWhen creating or updating the agent, you must consider the following:
\n
This is the description of the body request.
\n\n\nWhen creating or updating the agent, you must consider the following:
\n
Agents id
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"0bf5bb01-fd55-4dd9-98d8-06dff3abd76c","name":"Update agent","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"user\" : \"/api/users/24\",\r\n \"extension\" : \"/api/extensions/7\",\r\n \"number\" : 1000,\r\n \"groupNumber\" : 1,\r\n \"call\" : \"yes\",\r\n \"chat\" : \"no\",\r\n \"mail\" : \"no\",\r\n \"chatCenterAlt\" : null,\r\n \"organizationSession\" : \"/api/organizations/2\",\r\n \"mailCenterAlt\" : null,\r\n \"hasDashboard\" : \"no\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://me.hiperpbx.com/api/agents/:id","host":["https://me.hiperpbx.com/api"],"path":["agents",":id"],"variable":[{"key":"id","value":"20","description":"Agents id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 13:19:17 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 13:19:17 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Agent id
\n","type":"text/plain"},"type":"string","value":"","key":"id"}]}},"response":[{"id":"ed5a141a-9245-4327-9a58-0cddb98895d4","name":"Delete agent","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"https://me.hiperpbx.com/api/agents/:id","host":["https://me.hiperpbx.com/api"],"path":["agents",":id"],"variable":[{"key":"id","value":"9","description":"Agent id"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 25 Nov 2020 13:29:05 GMT"},{"key":"Date","value":"Wed, 25 Nov 2020 13:29:05 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"Id of the agent to clean
\n","type":"text/plain"},"type":"any","value":"","key":"agentId"}]}},"response":[],"_postman_id":"5b5ebab5-b3e6-4971-ae65-be9cb000d9a1"}],"id":"4e678094-4eef-4258-9d9a-1e4ae9cc9b18","_postman_id":"4e678094-4eef-4258-9d9a-1e4ae9cc9b18","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Mail Center Proxy","item":[{"name":"Authorization","id":"1f066ebc-7ef2-42a5-a1d8-b821bf0aac33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://me.hiperpbx.com/api/mail-center/auth","urlObject":{"path":["mail-center","auth"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1f066ebc-7ef2-42a5-a1d8-b821bf0aac33"},{"name":"Get tickets","id":"64543115-217f-467d-b657-6b979a374ac6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Osticket-Authorization","value":"{{mail_center_token}}"}],"url":"https://me.hiperpbx.com/api/mail-center/tickets","urlObject":{"path":["mail-center","tickets"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"64543115-217f-467d-b657-6b979a374ac6"},{"name":"Download file","id":"91aa2d92-6638-42d6-b180-4efe1308c6e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Osticket-Authorization","value":"{{mail_center_token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/mail-center/file?key=tQiLElQcMm6IfK6S5yHJJILpQKAITMLk&signature=lQcMm6IfK6S5yHJJ8tqqwXn29RChRKwd","urlObject":{"path":["mail-center","file"],"host":["https://me.hiperpbx.com/api"],"query":[{"key":"key","value":"tQiLElQcMm6IfK6S5yHJJILpQKAITMLk"},{"key":"signature","value":"lQcMm6IfK6S5yHJJ8tqqwXn29RChRKwd"}],"variable":[]}},"response":[],"_postman_id":"91aa2d92-6638-42d6-b180-4efe1308c6e3"},{"name":"Get canned response","id":"a3b1e5e0-9d2e-4bed-a168-c2d3d7dc4ca7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Osticket-Authorization","value":"Bearer {{mail_center_token}}"}],"url":"https://me.hiperpbx.com/api/mail-center/tickets/:ticketId/canned-response/:cannedId","urlObject":{"path":["mail-center","tickets",":ticketId","canned-response",":cannedId"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"type":"any","value":"","key":"ticketId"},{"type":"any","value":"","key":"cannedId"}]}},"response":[],"_postman_id":"a3b1e5e0-9d2e-4bed-a168-c2d3d7dc4ca7"}],"id":"9ab06e8d-6f1f-4bf5-8633-30d09b3fd1b5","description":"All the request in this section are the same that are in \"Mail Center API\", but with the prefix mail-center in the request path.
For example, to get the tickets is http://example.com/api/mail-center/tickets.
Authorization
\nAll the requests needs the header \"Osticket-Authorization\"
\n","event":[{"listen":"prerequest","script":{"id":"a3f46467-681b-4213-93b9-d67bd603d5f3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"54a483d6-005d-47bf-83f0-f822d21dba33","type":"text/javascript","exec":[""]}}],"_postman_id":"9ab06e8d-6f1f-4bf5-8633-30d09b3fd1b5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Side Images","item":[{"name":"Get all side images","id":"a040d0a5-79e6-49ed-a441-19b18b60b7b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/side_images","urlObject":{"path":["side_images"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a040d0a5-79e6-49ed-a441-19b18b60b7b2"},{"name":"Get active image","id":"f3824e70-a6af-4dd4-924a-33622972ea4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/side_images/active","urlObject":{"path":["side_images","active"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"f3824e70-a6af-4dd4-924a-33622972ea4d"},{"name":"Create new side image","id":"da2c0736-463c-4f7c-9af8-ccc257189150","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"testing2","type":"text"},{"key":"active","value":"1","type":"text"},{"key":"file","type":"file","src":"/C:/Users/Gabriel/Pictures/Saved Pictures/wallhaven-32609.jpg"}]},"url":"https://me.hiperpbx.com/api/side_images","urlObject":{"path":["side_images"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"da2c0736-463c-4f7c-9af8-ccc257189150"},{"name":"Update active status","id":"ab771077-509e-40f0-88ee-1f5fc123b623","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"active\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/side_images/:id/active","urlObject":{"path":["side_images",":id","active"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"id":"adad9f09-a644-4744-b200-517d863ce714","type":"any","value":"12","key":"id"}]}},"response":[],"_postman_id":"ab771077-509e-40f0-88ee-1f5fc123b623"}],"id":"7fb4b388-8543-4c6f-8a02-71c377e103ba","_postman_id":"7fb4b388-8543-4c6f-8a02-71c377e103ba","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Actions","item":[{"name":"Click 2 Call","id":"1c004998-2458-41c7-8df3-8dc09454bf81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/click2call/:organizationId/:agentNumber/:number","description":"This endpoint allows you to make a call and connected it to and agent.
\nTo use this endpoint, you have to had the role ROLE_CLICK_2_CALL.
This endpoint allows hangup the active call of an agent.
\nTo use this endpoint, you have to had the role ROLE_CLICK_2_CALL.
Id of the organization to which the agent belongs
\n","type":"text/plain"},"type":"any","value":"2","key":"organizationId"},{"description":{"content":"Number of the agent
\n","type":"text/plain"},"type":"any","value":"3000","key":"agentNumber"}]}},"response":[],"_postman_id":"aab3ce17-abd9-4895-8f96-5212f2919370"},{"name":"Remove tab","id":"a51ff79a-f5c7-4203-b9dc-076de04661d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://me.hiperpbx.com/api/click2call/:organizationId/:agentNumber/remove-tab/:tabId","urlObject":{"path":["click2call",":organizationId",":agentNumber","remove-tab",":tabId"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"Organization Id of the agent
\n","type":"text/plain"},"type":"any","value":"","key":"organizationId"},{"description":{"content":"Number of the agent
\n","type":"text/plain"},"type":"any","value":"","key":"agentNumber"},{"description":{"content":"The tab id that you want to delete
\n","type":"text/plain"},"type":"any","value":"","key":"tabId"}]}},"response":[],"_postman_id":"a51ff79a-f5c7-4203-b9dc-076de04661d6"},{"name":"Reload janus","id":"980afaa7-c7ee-4ac2-824d-d65b9856bd4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/reload-janus-from-user-by-extension?number=&organizationId=","urlObject":{"path":["reload-janus-from-user-by-extension"],"host":["https://me.hiperpbx.com/api"],"query":[{"key":"number","value":""},{"key":"organizationId","value":""}],"variable":[]}},"response":[],"_postman_id":"980afaa7-c7ee-4ac2-824d-d65b9856bd4b"},{"name":"Reload janus of agent","id":"18df14d5-b68c-41f9-ab38-87392483eb43","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/reload-janus-from-agent-by-number?number=&organizationId=","urlObject":{"path":["reload-janus-from-agent-by-number"],"host":["https://me.hiperpbx.com/api"],"query":[{"key":"number","value":""},{"key":"organizationId","value":""}],"variable":[]}},"response":[],"_postman_id":"18df14d5-b68c-41f9-ab38-87392483eb43"}],"id":"64f55433-0964-4ab3-8d70-3f2db9b89efd","_postman_id":"64f55433-0964-4ab3-8d70-3f2db9b89efd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Sessions","item":[{"name":"Agent can loggin","id":"da8eaa45-54ff-40fa-9e03-a0f61adb2712","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/sessions/agents","description":"This endpoint is used to check if the agent can loggin based on the agentSession property of the organization
Returns a boolean
\n","urlObject":{"path":["sessions","agents"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"da8eaa45-54ff-40fa-9e03-a0f61adb2712"}],"id":"d91a9b3c-489e-4742-8892-ac30afc69f68","_postman_id":"d91a9b3c-489e-4742-8892-ac30afc69f68","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Organization Contacts","item":[{"name":"Get all the organization contacts","id":"2507bd13-d28c-41aa-9ea0-a839053fc8d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/organization_contacts","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["organization_contacts"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"2507bd13-d28c-41aa-9ea0-a839053fc8d6"},{"name":"Create organization contact","id":"20bfa6d8-9381-4b29-af80-a5458648239b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"\",\r\n \"lastname\" : \"\",\r\n \"organization\" : \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/organization_contacts","description":"This is the description of the body request.
\n","urlObject":{"path":["organization_contacts"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"7747e585-5716-4bb2-be83-8dce78090c8d","name":"Create new organization contact","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"John\",\r\n \"lastname\" : \"Doe\",\r\n \"organization\" : \"/api/organizations/2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/organization_contacts"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Wed, 04 Aug 2021 16:56:06 GMT"},{"key":"Date","value":"Wed, 04 Aug 2021 16:56:06 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Content-Type","value":"application/ld+json; charset=utf-8"},{"key":"Vary","value":"Accept"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"deny"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Link","value":"This is the description of the body request.
\n","urlObject":{"path":["organization_contacts","1"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"d285d2f0-9443-4c0d-bbda-9e988c56590a"},{"name":"Delete organization contact","id":"0a92cef3-add4-4e05-bc83-6d430f54326b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://me.hiperpbx.com/api/organization_contacts/1","urlObject":{"path":["organization_contacts","1"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a92cef3-add4-4e05-bc83-6d430f54326b"},{"name":"Masive creation","id":"b9b51227-1025-4420-af73-bf203a3be6fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"b9b51227-1025-4420-af73-bf203a3be6fa"}],"id":"03bacb26-4a4c-4df6-b5bc-55c455c23f3f","_postman_id":"03bacb26-4a4c-4df6-b5bc-55c455c23f3f","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Contacts","item":[{"name":"Import contacts","id":"a40bc742-19ea-4437-9bf0-4cbcc56ecf4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"file","value":"","type":"default","disabled":true},{"key":"file","type":"file","src":"/C:/Users/Gabriel/Downloads/contacts.vcf"}]},"url":"https://me.hiperpbx.com/api/contacts/import","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["contacts","import"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"a40bc742-19ea-4437-9bf0-4cbcc56ecf4d"},{"name":"Get contacts","id":"85494315-9fc8-43f0-b66a-6821ef75ce56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/contacts","urlObject":{"path":["contacts"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"85494315-9fc8-43f0-b66a-6821ef75ce56"}],"id":"0f0120df-2bfa-461c-87ad-8a2863e34a7e","_postman_id":"0f0120df-2bfa-461c-87ad-8a2863e34a7e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Zoho","item":[{"name":"Get info","id":"627a08ef-1303-46bd-9445-04993a74bb71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"627a08ef-1303-46bd-9445-04993a74bb71"},{"name":"Get actions to the user","id":"9afe4ede-60f5-4752-ae83-696ced9f4771","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/zoho/action/:actionName","urlObject":{"path":["zoho","action",":actionName"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"type":"any","value":"answer","key":"actionName"}]}},"response":[],"_postman_id":"9afe4ede-60f5-4752-ae83-696ced9f4771"}],"id":"84da5804-b0a6-4b53-b5e3-463ca5673ddd","_postman_id":"84da5804-b0a6-4b53-b5e3-463ca5673ddd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"PBX Proxy","item":[{"name":"Get token of the HiperPBX API","id":"cb158a10-2cea-49a2-95e7-d765e330c151","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://me.hiperpbx.com/api/pbx/:id/auth","urlObject":{"path":["pbx",":id","auth"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"Id of the organization
\n","type":"text/plain"},"type":"any","value":"2","key":"id"}]}},"response":[],"_postman_id":"cb158a10-2cea-49a2-95e7-d765e330c151"}],"id":"04be630d-e9b1-4bb8-99e3-1a7f5b605900","_postman_id":"04be630d-e9b1-4bb8-99e3-1a7f5b605900","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Favorites","item":[{"name":"Save favorite","id":"1cd68e3f-8aee-43dc-b38f-bee57b3467e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"favoritableId\" : 3,\r\n \"favoritableType\": \"HiperMe\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/favorites","urlObject":{"path":["favorites"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"1cd68e3f-8aee-43dc-b38f-bee57b3467e4"},{"name":"Get favorites","id":"37859f43-c014-421e-93d4-4f567a4a6dd3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/favorites","urlObject":{"path":["favorites"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"37859f43-c014-421e-93d4-4f567a4a6dd3"},{"name":"Delete favorite","id":"398e0932-a312-49e1-9e15-f48ff38e6681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://me.hiperpbx.com/api/favorites/:id","urlObject":{"path":["favorites",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"id":"4abde8d3-df92-4b9a-83bb-ddd04deaeb10","type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"398e0932-a312-49e1-9e15-f48ff38e6681"}],"id":"51e6ac02-f1f3-4e70-adc5-6147f30478fe","_postman_id":"51e6ac02-f1f3-4e70-adc5-6147f30478fe","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"UserContacts","item":[{"name":"Get user contacts","id":"fb6f0607-6ac1-4724-b6ec-82c9ec8b4027","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/user_contacts","description":"Get the contacts created by the logged user
\n","urlObject":{"path":["user_contacts"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb6f0607-6ac1-4724-b6ec-82c9ec8b4027"},{"name":"Edit user contact","id":"242009a5-5cd8-43d9-8de0-259c64a8dc77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"\",\r\n \"lastname\" : \"\",\r\n \"phone\" : \"\",\r\n \"extension\" : \"\",\r\n \"email\" : \"\",\r\n \"department\" : \"\",\r\n \"phoneOne\" : \"\",\r\n \"phoneTwo\" : \"\",\r\n \"address\" : \"\",\r\n \"notes\" : \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/user_contacts","description":"This endpoint allows the edit of user contact of the logged user
\nThis is the description of the body request.
\n","urlObject":{"path":["user_contacts"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"242009a5-5cd8-43d9-8de0-259c64a8dc77"},{"name":"Edit user contact","id":"1aa57eba-2cb6-4e9f-84cb-38d5c517da45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"\",\r\n \"lastname\" : \"\",\r\n \"phone\" : \"\",\r\n \"extension\" : \"\",\r\n \"email\" : \"\",\r\n \"department\" : \"\",\r\n \"phoneOne\" : \"\",\r\n \"phoneTwo\" : \"\",\r\n \"address\" : \"\",\r\n \"notes\" : \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/user_contacts/:id","description":"Delete the user contact
\n","urlObject":{"path":["user_contacts",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"id":"d6969fb0-a62a-4393-a8c5-161179d6354d","type":"any","value":null,"key":"id"}]}},"response":[],"_postman_id":"1aa57eba-2cb6-4e9f-84cb-38d5c517da45"},{"name":"Delete user contact","id":"60239df6-e08a-4dcb-802e-7ed44b129c92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"url":"https://me.hiperpbx.com/api/user_contacts/:id","urlObject":{"path":["user_contacts",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"60239df6-e08a-4dcb-802e-7ed44b129c92"}],"id":"cedd38bf-2f4e-4037-af3b-ce55919735c9","_postman_id":"cedd38bf-2f4e-4037-af3b-ce55919735c9","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Licenses","item":[{"name":"Get all licenses","id":"0dc39097-eba5-4eed-8454-e686901da01d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/licenses","urlObject":{"path":["licenses"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0dc39097-eba5-4eed-8454-e686901da01d"},{"name":"Create licenses","id":"0d189a8b-28e9-4232-a7c7-563fc82877cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"organization\" : \"/api/organizations/2\",\r\n \"type\" : \"agent_session\",\r\n \"licenseKey\" : \"asdf-asdf\",\r\n \"orderId\" : \"1234\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/licenses","urlObject":{"path":["licenses"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"0d189a8b-28e9-4232-a7c7-563fc82877cb"}],"id":"23bfa1db-1b42-4924-8344-f1022ef2424c","_postman_id":"23bfa1db-1b42-4924-8344-f1022ef2424c","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Notifications","item":[{"name":"Create notification for agent","id":"f1105cf3-f5fc-4499-9a8e-fdc862de65cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"organizationId\" : \"214\",\r\n \"agentsNumber\" : [1001],\r\n \"title\" : \"The title of the notification\",\r\n \"body\" : \"The body of the notification\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/notifications/agent","description":"The HTTP POST request to /notifications/agent endpoint is used to send notifications to an agent. The request should include the organizationId, agentNumber, title, and body in the payload.
organizationId (number): The ID of the organization.
agentNumber (number): The number of the agent.
title (string): The title of the notification.
body (string): The body content of the notification.
This endpoint allows you to create form inputs by sending an HTTP POST request to https://me.hiperpbx.com/api/form_inputs.
form_id (string): The ID of the form.
\nlabel (string): The label for the form input.
\ndescription (string): The description of the form input.
\ntype (string): The type of the form input. The allowed values for type are:
text: Text field.
number: Numeric field.
email: Email field.
select: Dropdown list.
date: Date field.
datetime: Date and time field.
link: Link field.
configuration (string): A JSON string representing the configuration settings for the form input. It can contain the following:
\nrequired: A boolean value indicating whether the input is required. This can be included for all types.
\nminDate: Applicable only for fields of type date. The value should be a date or null.
maxDate: Applicable only for fields of type date. The value should be a date or null.
options: Applicable only for fields of type select. The value should be an array of strings representing the options.
multiple: Applicable only for fields of type select. The value should be a boolean indicating whether multiple selections are allowed.
url: Applicable only for fields of type link. The value should be a string representing the URL.
order (integer): The order of the form input.
\nThis endpoint allows you to create form inputs by sending an HTTP POST request to https://me.hiperpbx.com/api/form_inputs.
form_id (string): The ID of the form.
\nlabel (string): The label for the form input.
\ndescription (string): The description of the form input.
\ntype (string): The type of the form input. The allowed values for type are:
text: Text field.
number: Numeric field.
email: Email field.
select: Dropdown list.
date: Date field.
datetime: Date and time field.
link: Link field.
configuration (string): A JSON string representing the configuration settings for the form input. It can contain the following:
\nrequired: A boolean value indicating whether the input is required. This can be included for all types.
\nminDate: Applicable only for fields of type date. The value should be a date or null.
maxDate: Applicable only for fields of type date. The value should be a date or null.
options: Applicable only for fields of type select. The value should be an array of strings representing the options.
multiple: Applicable only for fields of type select. The value should be a boolean indicating whether multiple selections are allowed.
url: Applicable only for fields of type link. The value should be a string representing the URL.
order (integer): The order of the form input.
\nThis endpoint allows you to create form inputs by sending an HTTP POST request to https://me.hiperpbx.com/api/form_inputs.
form_id (string): The ID of the form.
\nlabel (string): The label for the form input.
\ndescription (string): The description of the form input.
\ntype (string): The type of the form input. The allowed values for type are:
text: Text field.
number: Numeric field.
email: Email field.
select: Dropdown list.
date: Date field.
datetime: Date and time field.
link: Link field.
configuration (string): A JSON string representing the configuration settings for the form input. It can contain the following:
\nrequired: A boolean value indicating whether the input is required. This can be included for all types.
\nminDate: Applicable only for fields of type date. The value should be a date or null.
maxDate: Applicable only for fields of type date. The value should be a date or null.
options: Applicable only for fields of type select. The value should be an array of strings representing the options.
multiple: Applicable only for fields of type select. The value should be a boolean indicating whether multiple selections are allowed.
url: Applicable only for fields of type link. The value should be a string representing the URL.
order (integer): The order of the form input.
\nThis endpoint allows you to create form inputs by sending an HTTP POST request to https://me.hiperpbx.com/api/form_inputs.
form_id (string): The ID of the form.
\nlabel (string): The label for the form input.
\ndescription (string): The description of the form input.
\ntype (string): The type of the form input. The allowed values for type are:
text: Text field.
number: Numeric field.
email: Email field.
select: Dropdown list.
date: Date field.
datetime: Date and time field.
link: Link field.
configuration (string): A JSON string representing the configuration settings for the form input. It can contain the following:
\nrequired: A boolean value indicating whether the input is required. This can be included for all types.
\nminDate: Applicable only for fields of type date. The value should be a date or null.
maxDate: Applicable only for fields of type date. The value should be a date or null.
options: Applicable only for fields of type select. The value should be an array of strings representing the options.
multiple: Applicable only for fields of type select. The value should be a boolean indicating whether multiple selections are allowed.
url: Applicable only for fields of type link. The value should be a string representing the URL.
order (integer): The order of the form input.
\nSearch forms of organization
\n","type":"text/plain"},"key":"organization.id","value":""}],"variable":[]}},"response":[],"_postman_id":"32ab17a2-3426-4353-b31a-ce141cef8134"},{"name":"Get form by id","id":"776e7632-e0a7-40b0-890e-7773fd282ae2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/forms/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["forms",":id"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search forms of organization
\n","type":"text/plain"},"key":"organization.id","value":""}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"776e7632-e0a7-40b0-890e-7773fd282ae2"},{"name":"Create form","id":"62647c92-a5e0-426e-b90a-33bbe09e84d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"Name of the form\",\r\n \"description\" : \"The description of the form\",\r\n \"organization\" : \"IRI of the Organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/forms","description":"This endpoint is used to submit a new form.
\nname (string, required): The name of the form.
description (string, required): The description of the form.
organization (string, required): The organization associated with the form.
The response for this request follows the JSON schema below:
\n{\n \"@context\": \"/api/contexts/Form\",\n \"@id\": \"/api/forms/1\",\n \"@type\": \"Form\",\n \"id\": 1,\n \"name\": \"Example\",\n \"description\": \"This is the descriptioon of the form\",\n \"organization\": {\n \"@id\": \"/api/organizations/1\",\n \"@type\": \"Organization\",\n \"id\": 1,\n \"name\": \"Default\",\n \"logo\": null,\n \"logoMin\": null,\n \"theme\": null,\n \"domain\": null,\n \"mediaServers\": [],\n \"sessions\": 10,\n \"agentSessions\": 10,\n \"osticket\": null,\n \"LiveHelperChat\": null,\n \"status\": null,\n \"firebase\": \"/api/firebases/1\",\n \"redirect\": null,\n \"watchRTC\": 0,\n \"bigQuery\": \"HiperMe_Dev\",\n \"stunServer\": null,\n \"pbxRestApi\": null,\n \"pbxRestApiUsername\": null,\n \"pbxRestApiPassword\": null,\n \"timezone\": null,\n \"customersEnabled\": 0,\n \"chatApiKey\": null,\n \"callCenterApiKey\": null,\n \"callCenterId\": null,\n \"callCenterApiUrl\": null,\n \"agentActivityTimeout\": 1440,\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\n \"dataSetAlt\": \"yes\",\n \"mediaServerAlt\": \"/api/media_servers/1\",\n \"callCenter\": true\n },\n \"inputs\": [],\n \"createdAt\": \"2024-08-09T15:31:40+00:00\",\n \"updatedAt\": \"2024-08-09T15:31:40+00:00\"\n}\n\nThis endpoint is used to submit a new form.
\nname (string, required): The name of the form.
description (string, required): The description of the form.
organization (string, required): The organization associated with the form.
The response for this request follows the JSON schema below:
\n{\n \"@context\": \"/api/contexts/Form\",\n \"@id\": \"/api/forms/1\",\n \"@type\": \"Form\",\n \"id\": 1,\n \"name\": \"Example\",\n \"description\": \"This is the descriptioon of the form\",\n \"organization\": {\n \"@id\": \"/api/organizations/1\",\n \"@type\": \"Organization\",\n \"id\": 1,\n \"name\": \"Default\",\n \"logo\": null,\n \"logoMin\": null,\n \"theme\": null,\n \"domain\": null,\n \"mediaServers\": [],\n \"sessions\": 10,\n \"agentSessions\": 10,\n \"osticket\": null,\n \"LiveHelperChat\": null,\n \"status\": null,\n \"firebase\": \"/api/firebases/1\",\n \"redirect\": null,\n \"watchRTC\": 0,\n \"bigQuery\": \"HiperMe_Dev\",\n \"stunServer\": null,\n \"pbxRestApi\": null,\n \"pbxRestApiUsername\": null,\n \"pbxRestApiPassword\": null,\n \"timezone\": null,\n \"customersEnabled\": 0,\n \"chatApiKey\": null,\n \"callCenterApiKey\": null,\n \"callCenterId\": null,\n \"callCenterApiUrl\": null,\n \"agentActivityTimeout\": 1440,\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\n \"dataSetAlt\": \"yes\",\n \"mediaServerAlt\": \"/api/media_servers/1\",\n \"callCenter\": true\n },\n \"inputs\": [],\n \"createdAt\": \"2024-08-09T15:31:40+00:00\",\n \"updatedAt\": \"2024-08-09T15:31:40+00:00\"\n}\n\nId of the form to update
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ee287e43-102c-4ebe-b97b-67b666d943cb"},{"name":"Delete form","id":"1f88ee33-6271-4daf-a33c-fd880a557c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"Name of the form\",\r\n \"description\" : \"The description of the form\",\r\n \"organization\" : \"IRI of the Organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/forms/:id","description":"This endpoint is used to submit a new form.
\nname (string, required): The name of the form.
description (string, required): The description of the form.
organization (string, required): The organization associated with the form.
The response for this request follows the JSON schema below:
\n{\n \"@context\": \"/api/contexts/Form\",\n \"@id\": \"/api/forms/1\",\n \"@type\": \"Form\",\n \"id\": 1,\n \"name\": \"Example\",\n \"description\": \"This is the descriptioon of the form\",\n \"organization\": {\n \"@id\": \"/api/organizations/1\",\n \"@type\": \"Organization\",\n \"id\": 1,\n \"name\": \"Default\",\n \"logo\": null,\n \"logoMin\": null,\n \"theme\": null,\n \"domain\": null,\n \"mediaServers\": [],\n \"sessions\": 10,\n \"agentSessions\": 10,\n \"osticket\": null,\n \"LiveHelperChat\": null,\n \"status\": null,\n \"firebase\": \"/api/firebases/1\",\n \"redirect\": null,\n \"watchRTC\": 0,\n \"bigQuery\": \"HiperMe_Dev\",\n \"stunServer\": null,\n \"pbxRestApi\": null,\n \"pbxRestApiUsername\": null,\n \"pbxRestApiPassword\": null,\n \"timezone\": null,\n \"customersEnabled\": 0,\n \"chatApiKey\": null,\n \"callCenterApiKey\": null,\n \"callCenterId\": null,\n \"callCenterApiUrl\": null,\n \"agentActivityTimeout\": 1440,\n \"pbxDomainAlt\": \"192.168.0.1:5038\",\n \"dataSetAlt\": \"yes\",\n \"mediaServerAlt\": \"/api/media_servers/1\",\n \"callCenter\": true\n },\n \"inputs\": [],\n \"createdAt\": \"2024-08-09T15:31:40+00:00\",\n \"updatedAt\": \"2024-08-09T15:31:40+00:00\"\n}\n\nId of the form to delete
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1f88ee33-6271-4daf-a33c-fd880a557c11"}],"id":"13f3c71e-800f-4b60-903f-371ee17b1a5f","description":"This forms can be used by:
\nSearch by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[]}},"response":[],"_postman_id":"c4fc9215-8285-4b46-b343-0a447337fd33"},{"name":"Edit chat classification","id":"1478eca9-b116-4da0-8c25-fbf6810c15a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"The name of the chat classification\",\r\n \"description\" : \"The name of the description\",\r\n \"form\" : \"The IRI of the form to use by this classification\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/chat_classifications/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat_classifications",":id"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"1478eca9-b116-4da0-8c25-fbf6810c15a2"},{"name":"Get chat classifications","id":"29b27fc2-4fac-48ea-a4ef-fb539d0b28fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/chat_classifications","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat_classifications"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[]}},"response":[],"_postman_id":"29b27fc2-4fac-48ea-a4ef-fb539d0b28fc"},{"name":"Get chat classification by id","id":"90153fb1-993f-4c48-bcb9-86520d1e2801","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/chat_classifications/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat_classifications",":id"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"90153fb1-993f-4c48-bcb9-86520d1e2801"},{"name":"Delete chat classification","id":"74e13d89-6281-4622-a715-07a776dd91a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\" : \"The name of the chat classification\",\r\n \"description\" : \"The name of the description\",\r\n \"form\" : \"The IRI of the form to use by this classification\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/chat_classifications/:id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat_classifications",":id"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"description":{"content":"Search by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"74e13d89-6281-4622-a715-07a776dd91a5"}],"id":"b3e5f076-a2c2-4ac2-8d71-8d4a51d6fadb","_postman_id":"b3e5f076-a2c2-4ac2-8d71-8d4a51d6fadb","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Providers","item":[{"name":"Get chat providers","id":"78e93f03-82f3-4d08-88f6-fc4858d17d3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/chat-providers","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat-providers"],"host":["https://me.hiperpbx.com/api"],"query":[{"disabled":true,"key":"organization.id","value":null}],"variable":[]}},"response":[],"_postman_id":"78e93f03-82f3-4d08-88f6-fc4858d17d3e"},{"name":"Create chat provider","id":"97967006-573b-4eed-837b-f5c094b1b812","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Name of the provider\",\r\n \"type\": \"Gupshup\",\r\n \"appName\": \"\",\r\n \"apiKey\": \"iyqycgrw608npyzllgbevaf8y1ltzine\",\r\n \"appIgId\": \"\",\r\n \"apiKeyIg\": \"\",\r\n \"organization\": \"Id of the organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/chat-providers","description":"This endpoint makes an HTTP POST request to https://me.hiperpbx.com/api/chat-providers/:id in order to add a new chat provider. The request should include the following parameters in the raw request body:
\nname (string): The name of the chat provider.
\ntype (string): The type of the chat provider. The allowed values for type are:
\ngupshup
\ntwilio
\ncustom
\nhiperme
\norganization (string): The organization associated with the chat provider.
\ngupshup
\nappName (string): The application name.
apiKey (string): The API key.
appIgId (string): The application ID.
apiKeyIg (string): The API key ID.
twilio
\naccountSid (string): The account SID.
authToken (string): The authentication token.
custom
\nwebhook (string): The webhook URL.hiperme
\nUpon a successful request, the response will contain the details of the newly added chat provider.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat-providers"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"97967006-573b-4eed-837b-f5c094b1b812"},{"name":"Edit chat provider","id":"662b8298-ca6d-435b-b083-8a2584dcb3ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Name of the provider\",\r\n \"type\": \"Gupshup\",\r\n \"appName\": \"\",\r\n \"apiKey\": \"\",\r\n \"appIgId\": \"\",\r\n \"apiKeyIg\": \"\",\r\n \"organization\": \"Id of the organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/chat-providers/:id","description":"This endpoint makes an HTTP POST request to https://me.hiperpbx.com/api/chat-providers/:id in order to add a new chat provider. The request should include the following parameters in the raw request body:
\nname (string): The name of the chat provider.
\ntype (string): The type of the chat provider.
\nappName (string): The name of the application.
\napiKey (string): The API key for the chat provider.
\nappIgId (string): The Instagram ID of the application.
\napiKeyIg (string): The Instagram API key.
\naccountSid (string): The account SID for authentication.
\nauthToken (string): The authentication token.
\nwebhook (string): The webhook URL for the chat provider.
\norganization (string): The organization associated with the chat provider.
\nUpon a successful request, the response will contain the details of the newly added chat provider.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat-providers",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"662b8298-ca6d-435b-b083-8a2584dcb3ac"},{"name":"Delete chat provider","id":"746dd027-1a45-4f2c-947b-1a99c6629bb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://me.hiperpbx.com/api/chat-providers/:id","description":"This endpoint makes an HTTP POST request to https://me.hiperpbx.com/api/chat-providers/:id in order to add a new chat provider. The request should include the following parameters in the raw request body:
\nname (string): The name of the chat provider.
\ntype (string): The type of the chat provider.
\nappName (string): The name of the application.
\napiKey (string): The API key for the chat provider.
\nappIgId (string): The Instagram ID of the application.
\napiKeyIg (string): The Instagram API key.
\naccountSid (string): The account SID for authentication.
\nauthToken (string): The authentication token.
\nwebhook (string): The webhook URL for the chat provider.
\norganization (string): The organization associated with the chat provider.
\nUpon a successful request, the response will contain the details of the newly added chat provider.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["chat-providers",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"746dd027-1a45-4f2c-947b-1a99c6629bb4"}],"id":"46bf8088-cfae-4238-a35c-c8b3f7409cab","_postman_id":"46bf8088-cfae-4238-a35c-c8b3f7409cab","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Bots","item":[{"name":"Get bots","id":"5e65317d-50a1-497f-8b50-0a1a340a477d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/bots","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["bots"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e65317d-50a1-497f-8b50-0a1a340a477d"},{"name":"Edit bot","id":"fa715ec3-c97a-4977-90af-aaecb0e2e06d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"The name of the bot\",\r\n \"type\": \"Type of the bot\",\r\n \"organization\": \"The ID of the organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/bots/bot-platform/bot_52_676305bb925f8_1734542779","description":"Endpoint: POST https://me.hiperpbx.com/api/bots/:id
This endpoint allows update a bot. The request should include the following parameters in the raw request body:
\nname (string): The name of the bot.
\ntype (string): The type of the bot. The allowed values for type are:
\nLiveHelperChat
\nBotPlatform
\nGupshup
\norganization (string): The organization to which the bot belongs.
\nLiveHelperChat
\nurl (string): The URL for the LiveHelperChat instance.
username (string): The username for authentication.
password (string): The password for authentication.
dept_id (string): The department ID associated with the bot.
BotPlatform
\nbot_platform_id (string): The ID of the bot platform.Gupshup
\nurl (string): The URL for the Gupshup instance.The response for this request can be documented as a JSON schema, detailing the structure of the returned data
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["bots","bot-platform","bot_52_676305bb925f8_1734542779"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa715ec3-c97a-4977-90af-aaecb0e2e06d"},{"name":"Create bot","id":"61b91097-fe2b-4498-be8a-3be8cd68bd4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"The name of the bot\",\r\n \"type\": \"Type of the bot\",\r\n \"organization\": \"The ID of the organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/bots","description":"Endpoint: POST https://me.hiperpbx.com/api/bots
This endpoint allows the creation of a new bot. The request should include the following parameters in the raw request body:
\nname (string): The name of the bot.
\ntype (string): The type of the bot. The allowed values for type are:
\nLiveHelperChat
\nBotPlatform
\nGupshup
\norganization (string): The organization to which the bot belongs.
\nLiveHelperChat
\nurl (string): The URL for the LiveHelperChat instance.
username (string): The username for authentication.
password (string): The password for authentication.
dept_id (string): The department ID associated with the bot.
BotPlatform
\nbot_platform_id (string): The ID of the bot platform.Gupshup
\nurl (string): The URL for the Gupshup instance.The response for this request can be documented as a JSON schema, detailing the structure of the returned data
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["bots"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"61b91097-fe2b-4498-be8a-3be8cd68bd4f"},{"name":"Set active/inactive bot","id":"13716575-6ad9-495a-a28f-8e8a1a2a2286","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"isActive\" : 0\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/bots/:id/toggle-active","description":"This endpoint allows you to activate/deactivate an user
\nThis is the description of the body request.
\nUse 1 to active the user
\nUse 0 to deactivate the user
\n","urlObject":{"path":["bots",":id","toggle-active"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"description":{"content":"The bot id that you want to desactivate
\n","type":"text/plain"},"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"13716575-6ad9-495a-a28f-8e8a1a2a2286"},{"name":"Delete bot","id":"ba12c9ed-983e-429f-96ca-f36681286794","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/bots/:id","description":"Endpoint: POST https://me.hiperpbx.com/api/bots
This endpoint allows the creation of a new bot. The request should include the following parameters in the raw request body:
\nname (string): The name of the bot.
\ntype (string): The type of the bot. The allowed values for type are:
\nLiveHelperChat
\nBotPlatform
\nGupshup
\norganization (string): The organization to which the bot belongs.
\nLiveHelperChat
\nurl (string): The URL for the LiveHelperChat instance.
username (string): The username for authentication.
password (string): The password for authentication.
dept_id (string): The department ID associated with the bot.
BotPlatform
\nbot_platform_id (string): The ID of the bot platform.Gupshup
\nurl (string): The URL for the Gupshup instance.The response for this request can be documented as a JSON schema, detailing the structure of the returned data
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["bots",":id"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ba12c9ed-983e-429f-96ca-f36681286794"}],"id":"09552157-a3d6-44ad-bf38-a4db61653dfd","_postman_id":"09552157-a3d6-44ad-bf38-a4db61653dfd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Departments","item":[{"name":"Get departments","id":"4880bbcf-166e-49d8-9815-5ce9f80c87a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/departments?organization.id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"path":["departments"],"host":["https://me.hiperpbx.com/api"],"query":[{"description":{"content":"Search by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[]}},"response":[],"_postman_id":"4880bbcf-166e-49d8-9815-5ce9f80c87a1"},{"name":"Create department","id":"4c824369-4521-46d2-962b-057facf9e78d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Name of the department\",\r\n \"chatProvider\": \"IRI of the Chat Provider\",\r\n \"enableSysMsgClient\": 0,\r\n \"showAgentName\": 1,\r\n \"whatsappNumber\": \"Number of whatsapp\",\r\n \"strategy\": \"Type of strategy\",\r\n \"bot\": \"IRI of the Bot\",\r\n \"botAutoStart\": 1,\r\n \"showImageFromClient\": 1,\r\n \"lang\": \"es\",\r\n \"organization\": \"IRI of the Organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/departments","description":"This endpoint allows you to create a new department.
\nname (string, required): The name of the department.
chatProvider (string, required): The chat provider for the department.
enableSysMsgClient (integer, required): Indicates whether system messages are enabled for the client.
showAgentName (integer, required): Indicates whether the agent's name is shown.
whatsappNumber (string, required): The WhatsApp number associated with the department.
strategy (string, null, required): The strategy for the department. Values secuencial, null
bot (string, null, required): The bot associated with the department.
botAutoStart (integer, required): Indicates whether the bot auto starts.
showImageFromClient (integer, required): Indicates whether images from the client are shown.
lang (string, required): The language setting for the department. Values: es, en
organization (string, required): The organization to which the department belongs.
{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"departmentId\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nThis endpoint allows you to update the department
\nname (string, required): The name of the department.
chatProvider (string, required): The chat provider for the department.
enableSysMsgClient (integer, required): Indicates whether system messages are enabled for the client.
showAgentName (integer, required): Indicates whether the agent's name is shown.
whatsappNumber (string, required): The WhatsApp number associated with the department.
strategy (string, null, required): The strategy for the department. Values secuencial, null
bot (string, null, required): The bot associated with the department.
botAutoStart (integer, required): Indicates whether the bot auto starts.
showImageFromClient (integer, required): Indicates whether images from the client are shown.
lang (string, required): The language setting for the department. Values: es, en
organization (string, required): The organization to which the department belongs.
{\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\"\n },\n \"message\": {\n \"type\": \"string\"\n },\n \"data\": {\n \"type\": \"object\",\n \"properties\": {\n \"departmentId\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n\nSearch by organization id
\n","type":"text/plain"},"key":"organization.id","value":null}],"variable":[]}},"response":[],"_postman_id":"064891d2-5a94-4b14-9ab3-4f5d4a8ec5bf"},{"name":"Create chat disposition","id":"4aeb8579-08fb-47f9-bfc4-a986894f64d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Name of the chat disposition\",\r\n \"description\": \"Description of the chat disposition\",\r\n \"color\": \"CSS Var name\",\r\n \"organization\": \"IRI of the Organization\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/chat_dispositions","description":"This endpoint allows the user to create a new chat disposition.
\nname (string, required): The name of the chat disposition.
description (string, required): The description of the chat disposition.
color (string, required): The name of the CSS variable name
organization (string, required): The organization to which the chat disposition belongs.
The response for this request is a JSON object conforming to the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"color\": {\n \"type\": \"string\"\n },\n \"organization\": {\n \"type\": \"string\"\n }\n }\n}\n\nThis endpoint allows the user to update a chat disposition.
\nname (string, required): The name of the chat disposition.
description (string, required): The description of the chat disposition.
color (string, required): The name of the CSS variable name
organization (string, required): The organization to which the chat disposition belongs.
The response for this request is a JSON object conforming to the following schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"color\": {\n \"type\": \"string\"\n },\n \"organization\": {\n \"type\": \"string\"\n }\n }\n}\n\n(Required) Id ot the organization
\n","type":"text/plain"},"key":"organization_id","value":"2"},{"disabled":true,"description":{"content":"(Optional) Search by phone
\n","type":"text/plain"},"key":"phone","value":null},{"disabled":true,"description":{"content":"(Optional) Search by roomId
\n","type":"text/plain"},"key":"roomId","value":"4d3bc8ea-ab84-44bd-a422-2d28904e9c92"}],"variable":[]}},"response":[],"_postman_id":"c919a486-9139-47d1-b4eb-32e9a07f579d"}],"id":"7b6ba945-35fc-422c-a578-307ed452484b","_postman_id":"7b6ba945-35fc-422c-a578-307ed452484b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Customer","item":[{"name":"Get customers","id":"d81b6acc-8e39-46e9-b970-2c787d4f431e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/customers?organization=2","description":"The response will be in JSON format with a status code of 200. It will contain an array of customer objects with the following properties:
\nid (string): The unique identifier of the customer.
\nname (string): The first name of the customer.
\nlastname (string): The last name of the customer.
\nphone (string): The phone number of the customer.
\nwa_phone (string): The WhatsApp phone number of the customer.
\nemail (string): The email address of the customer.
\nbusiness (string): The business associated with the customer.
\ndepartment (string): The department associated with the customer.
\ncountry (string): The country of the customer.
\ncreatedAt (string): The timestamp of when the customer was created.
\nupdatedAt (string): The timestamp of when the customer was last updated.
\norganization (number): The ID of the organization to which the customer belongs.
\nAdditionally, the response includes:
\nBy default, the API returns 30 items per page. To retrieve the next page, you must include the value of lastDocument returned in the previous response as a query parameter in the request for the next page.
The id of the organization (Required)
\n","type":"text/plain"},"key":"organization","value":"2"},{"disabled":true,"description":{"content":"The name or the property to search (Optional)
\n","type":"text/plain"},"key":"property","value":"email"},{"disabled":true,"description":{"content":"The value of the property to search (Required when property is present)
\n","type":"text/plain"},"key":"value","value":"jane.doe@example.com"},{"disabled":true,"description":{"content":"The value of the property \"lastDocument\" of the request
\n","type":"text/plain"},"key":"lastDoc","value":"ulP3YwK1pCYO6aZpCqfI"}],"variable":[]}},"response":[],"_postman_id":"d81b6acc-8e39-46e9-b970-2c787d4f431e"},{"name":"Create customer","id":"b386e399-c15e-4f1e-a706-a9fe60f66e94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Jane\",\r\n \"lastname\": \"Doe\",\r\n \"phone\": \"12345\",\r\n \"wa_phone\": \"\",\r\n \"email\": \"jane.doe@example.com\",\r\n \"business\": \"\",\r\n \"department\": \"\",\r\n \"country\": null,\r\n \"organization\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/customers","description":"This endpoint allows you to create a new customer.
\nname (string, required): The first name of the customer.
lastname (string, required): The last name of the customer.
phone (string, required): The customer's phone number.
wa_phone (string, optional): The customer's WhatsApp phone number.
email (string, optional): The customer's email address.
business (string, optional): The customer's business name.
department (string, optional): The department of the customer.
country (string, optional): The country of the customer.
organization (number, required): The organization ID of the customer.
This endpoint allows you to update/create the details of a specific customer for a given organization.
\nThe body of the request should include an array of data with the following keys:
\nkey (string, required):
The unique identifier for the property being edited or added. This key is used to find the matching property in the customer data.
value (mixed, required):
The value to be assigned to the property. This can be any data type depending on the context of the property.
label (string, optional):
A descriptive text label for the property. If not provided, the existing label will be used (if updating) or an empty string will be assigned.
editable (boolean, optional):
Indicates whether the property is editable by the user. If not provided, the existing value will be retained (if updating) or false will be assigned by default.
deletable (boolean, optional):
Indicates whether the property can be deleted. If not provided, the existing value will be retained (if updating) or false will be assigned by default.
searchable (boolean, optional):
Indicates whether the property is searchable. If not provided, the existing value will be retained (if updating) or false will be assigned by default.
{\n \"key\": \"email\",\n \"value\": \"example@example.com\",\n \"label\": \"Primary Email\",\n \"editable\": true,\n \"deletable\": false,\n \"searchable\": true\n}\nThe id of the organization
\n","type":"text/plain"},"key":"organization","value":"2"}],"variable":[{"description":{"content":"The id of the Customer
\n","type":"text/plain"},"type":"any","value":"9e39154915e24753866b","key":"customerId"}]}},"response":[],"_postman_id":"3f16d613-f275-4358-a839-c2dc5f1e44d1"},{"name":"Delete customer","id":"acd94c4e-6c1e-4498-afe7-fb51b931b93f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/customers/:customerId?organization=2","urlObject":{"path":["customers",":customerId"],"host":["https://me.hiperpbx.com/api"],"query":[{"key":"organization","value":"2"}],"variable":[{"type":"any","value":"","key":"customerId"}]}},"response":[],"_postman_id":"acd94c4e-6c1e-4498-afe7-fb51b931b93f"},{"name":"Add chat to customer","id":"d0435d42-c48e-47c2-b073-c9b8f8d736fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"chatId\": \"00cc1e8c-a5be-4284-852c-1543e98f54dt\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/customers/:customerId/chats?organization=0","urlObject":{"path":["customers",":customerId","chats"],"host":["https://me.hiperpbx.com/api"],"query":[{"key":"organization","value":"0"}],"variable":[{"description":{"content":"The id of the customer
\n","type":"text/plain"},"type":"any","value":"","key":"customerId"}]}},"response":[],"_postman_id":"d0435d42-c48e-47c2-b073-c9b8f8d736fd"}],"id":"bd1de440-198c-4690-8213-387b24b04224","_postman_id":"bd1de440-198c-4690-8213-387b24b04224","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Agent Console","item":[{"name":"Get breaks","id":"9785cb1a-7900-4431-a066-b6eca32fde69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"https://me.hiperpbx.com/api/agent-console/breaks","urlObject":{"path":["agent-console","breaks"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"9785cb1a-7900-4431-a066-b6eca32fde69"},{"name":"Login action","id":"410bf177-8664-42c5-bb0a-1e9c17d20882","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://me.hiperpbx.com/api/agent-console/login","urlObject":{"path":["agent-console","login"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"410bf177-8664-42c5-bb0a-1e9c17d20882"},{"name":"Logout action","id":"60d9297b-8bb4-419a-bc0c-ef61e2e03fcb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://me.hiperpbx.com/api/agent-console/logout","urlObject":{"path":["agent-console","logout"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"60d9297b-8bb4-419a-bc0c-ef61e2e03fcb"},{"name":"Break","id":"e7f1b505-03a6-42a7-8606-9bc3ed9eba77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\" : 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/agent-console/break","urlObject":{"path":["agent-console","break"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"e7f1b505-03a6-42a7-8606-9bc3ed9eba77"},{"name":"Unbreak","id":"6b348272-a0ae-48d7-8c51-b51dc41f1c8d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"url":"https://me.hiperpbx.com/api/agent-console/unbreak","urlObject":{"path":["agent-console","unbreak"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[],"_postman_id":"6b348272-a0ae-48d7-8c51-b51dc41f1c8d"}],"id":"8e76da82-99ca-4bc4-a3ef-1cd0c56a6a3b","_postman_id":"8e76da82-99ca-4bc4-a3ef-1cd0c56a6a3b","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Media Servers","item":[{"name":"Sessions","item":[{"name":"Store session","id":"e31f567a-b86f-45ae-a582-b6b98385f17f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"e31f567a-b86f-45ae-a582-b6b98385f17f"}],"id":"ccb8af6b-c043-4570-8105-80e0c40ed38e","_postman_id":"ccb8af6b-c043-4570-8105-80e0c40ed38e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}}],"id":"c7091ccb-8a5c-4604-9408-e3e6e31483fc","_postman_id":"c7091ccb-8a5c-4604-9408-e3e6e31483fc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","id":"c70ef614-bd43-4167-8d28-3a3fcb5a0162","name":"HiperMe Rest API","type":"collection"}}},{"name":"Notification","event":[{"listen":"test","script":{"id":"e835c780-954e-45ea-a0da-d0f79f7040d3","exec":["if (pm.response.json().token) {\r"," pm.environment.set(\"hiperme_token\", pm.response.json().token);\r","}"],"type":"text/javascript"}}],"id":"d18a8ac9-3de3-4bf4-ac20-1a925e03e736","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"organizationId\" : 2,\r\n \"numberCalled\" : 100,\r\n \"extensionCalling\" : 500\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/notification","urlObject":{"path":["notification"],"host":["https://me.hiperpbx.com/api"],"query":[],"variable":[]}},"response":[{"id":"4f02bb46-6ec0-44d8-ac73-693786dce5ae","name":"Do Login (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\" : \"john.doe@example.com\",\r\n \"password\" : \"123456\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://me.hiperpbx.com/api/login_check"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Host","value":"localhost:8000"},{"key":"Date","value":"Tue, 24 Nov 2020 12:17:21 GMT"},{"key":"Date","value":"Tue, 24 Nov 2020 12:17:21 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/7.4.10"},{"key":"Set-Cookie","value":"PHPSESSID=5jv7h0hssnkv6pd14e7r9ejfd4; path=/; HttpOnly"},{"key":"Cache-Control","value":"max-age=0, must-revalidate, private"},{"key":"Content-Type","value":"application/json"},{"key":"Link","value":"