{"info":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","description":"

VitalPBX is a free phone system based on the solid Linux and Asterisk platforms, offering a whole new level of user experience.

This API is under construction, we are working to make this API available ASAP. If you have any question or request, please send an email to support@vitalpbx.com

Almost all the API requests should provide the tenant, if no tenant is provided, the default tenant will be used to answer the requests.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"5481262","collectionId":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","publishedId":"S17rvTgc","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-03-22T15:41:20.000Z"},"item":[{"name":"Tenants","item":[{"name":"/tenants","id":"00a333fc-3d79-438a-93a5-4a54e0627853","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"}],"url":"http://{{host}}/api/v2/tenants","description":"

Get all created tenants

Get data from an specific tenant

It allows you to change the current state of any tenant. the available states are \"enable\", and \"disable\".

It allows you to apply all the changes made on VitalPBX's GUI into Asterisk. This will perform also a full core reload after dumping all the configurations.

Endpoint to create a new tenant with all the required settings. This endpoint might take some time because it applies changes after the new tenant is created.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v2","tenants"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1edbc4cf-5050-401b-90cc-293886149cfa","name":"200 - Tenant Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"abc_company\",\r\n \"description\": \"ABC Company\",\r\n \"prefix\": \"ABC\",\r\n \"send_welcome_email\": \"yes\",\r\n \"user\": {\r\n \"full_name\": \"Jane Doe\",\r\n \"user_password\": \"SuperPassword@2021!!\",\r\n \"user_email\": \"pbx@abc_company.com\",\r\n \"startapp\": \"dashboard\",\r\n \"role_id\": 4\r\n },\r\n \"settings\": {\r\n \"addons\": \"sonata-stats,sonata-switchboard,vitxi\",\r\n \"allow_recordings\": \"yes\",\r\n \"allowed_outbound_routes\": \"\",\r\n \"allowed_tenant_trunks\": \"\",\r\n \"calls_limit\": 10,\r\n \"cid_name\": \"\",\r\n \"cid_number\": \"\",\r\n \"conferences\": \"\",\r\n \"emergency_trunks\": \"13\",\r\n \"extensions\": \"\",\r\n \"inbound_numbers\": \"16575550143,16575550119\",\r\n \"ivrs\": \"\",\r\n \"outbound_profiles\": \"5,4\",\r\n \"parking_lots\": \"\",\r\n \"queues\": \"\",\r\n \"restricted_cid\": \"disabled\",\r\n \"timezone\": \"America/New_York\",\r\n \"trunks\": \"\"\r\n },\r\n \"maintenance\": {\r\n \"cdr_preservation\": 190,\r\n \"recordings_preservation\": 190,\r\n \"voicemail_preservation\": 30,\r\n \"recordings_clear_less_nseconds\": 1,\r\n \"convert_recordings\": \"yes\",\r\n \"conversion_quality\": 16,\r\n \"maintenance_cron\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/api/v2/tenants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Aug 2021 03:19:48 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"943"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"The tenant has been created\",\n \"data\": {\n \"tenant_id\": 45,\n \"name\": \"abc_company\",\n \"description\": \"ABC Company\",\n \"default\": false,\n \"path\": \"6a733384562d2835\",\n \"prefix\": \"ABC\",\n \"enabled\": true,\n \"settings\": {\n \"addons\": \"sonata-stats,sonata-switchboard,vitxi\",\n \"allow_recordings\": \"yes\",\n \"allowed_outbound_routes\": \"\",\n \"allowed_tenant_trunks\": \"\",\n \"calls_limit\": \"10\",\n \"cid_name\": \"\",\n \"cid_number\": \"\",\n \"conferences\": null,\n \"emergency_trunks\": \"13\",\n \"extensions\": null,\n \"inbound_numbers\": \"16575550143,16575550119\",\n \"ivrs\": null,\n \"outbound_profiles\": \"5,4\",\n \"parking_lots\": null,\n \"queues\": null,\n \"restricted_cid\": \"disabled\",\n \"timezone\": \"America/New_York\",\n \"trunks\": null\n },\n \"maintenance\": {\n \"id\": \"38\",\n \"cdr_preservation\": \"190\",\n \"recordings_preservation\": \"190\",\n \"voicemail_preservation\": \"30\",\n \"recordings_clear_less_nseconds\": \"5\",\n \"convert_recordings\": \"yes\",\n \"conversion_quality\": \"16\",\n \"maintenance_cron\": \"1\",\n \"enabled\": \"yes\",\n \"default\": \"no\",\n \"tenant_id\": \"45\"\n }\n }\n}"},{"id":"16bef723-2ac6-4fa5-8735-9f54b4ac9898","name":"403 - Addon not installed","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"telesoft\",\r\n \"description\": \"Telesoft\",\r\n \"prefix\": \"TLS\",\r\n \"send_welcome_email\": \"yes\",\r\n \"user\": {\r\n \"full_name\": \"Jhon Doe\",\r\n \"user_password\": \"SuperPassword@2021!!\",\r\n \"user_email\": \"miguel@vitalpbx.com\",\r\n \"startapp\": \"dashboard\",\r\n \"role_id\": 4\r\n },\r\n \"settings\": {\r\n \"addons\": \"sonata-stats,sonata-switchboard,vitxi\",\r\n \"allow_recordings\": \"yes\",\r\n \"allowed_outbound_routes\": \"\",\r\n \"allowed_tenant_trunks\": \"\",\r\n \"calls_limit\": 10,\r\n \"cid_name\": \"\",\r\n \"cid_number\": \"\",\r\n \"conferences\": \"\",\r\n \"emergency_trunks\": \"13\",\r\n \"extensions\": \"\",\r\n \"inbound_numbers\": \"13055605776,17863643150\",\r\n \"ivrs\": \"\",\r\n \"outbound_profiles\": \"5,4\",\r\n \"parking_lots\": \"\",\r\n \"queues\": \"\",\r\n \"restricted_cid\": \"disabled\",\r\n \"timezone\": \"America/Chicago\",\r\n \"trunks\": \"\"\r\n },\r\n \"maintenance\": {\r\n \"cdr_preservation\": 190,\r\n \"recordings_preservation\": 190,\r\n \"voicemail_preservation\": 30,\r\n \"recordings_clear_less_nseconds\": 1,\r\n \"convert_recordings\": \"no\",\r\n \"conversion_quality\": 16,\r\n \"maintenance_cron\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{host}}/api/v2/tenants"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Aug 2021 01:50:00 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"82"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"message\": \"The multi-tenant add-on is not installed.\",\n \"data\": []\n}"},{"id":"9e3aad59-79d3-4b89-a454-0b1f1ce04b5a","name":"200 - Tenant created and assigned to an existing user","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"evil_corp\",\r\n \"description\": \"Evil Corp\",\r\n \"prefix\": \"EVC\",\r\n \"send_welcome_email\": \"yes\",\r\n \"user\": {\r\n \"user_id\": 48\r\n },\r\n \"settings\": {\r\n \"addons\": \"sonata-stats,sonata-switchboard,vitxi\",\r\n \"allow_recordings\": \"yes\",\r\n \"allowed_outbound_routes\": \"\",\r\n \"allowed_tenant_trunks\": \"\",\r\n \"calls_limit\": 10,\r\n \"cid_name\": \"\",\r\n \"cid_number\": \"\",\r\n \"conferences\": \"\",\r\n \"emergency_trunks\": \"13\",\r\n \"extensions\": \"\",\r\n \"inbound_numbers\": \"17755550165,17755550109\",\r\n \"ivrs\": \"\",\r\n \"outbound_profiles\": \"5,4\",\r\n \"parking_lots\": \"\",\r\n \"queues\": \"\",\r\n \"restricted_cid\": \"disabled\",\r\n \"timezone\": \"America/New_York\",\r\n \"trunks\": \"\"\r\n },\r\n \"maintenance\": {\r\n \"cdr_preservation\": 190,\r\n \"recordings_preservation\": 190,\r\n \"voicemail_preservation\": 30,\r\n \"recordings_clear_less_nseconds\": 1,\r\n \"convert_recordings\": \"yes\",\r\n \"conversion_quality\": 16,\r\n \"maintenance_cron\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/api/v2/tenants"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 16 Aug 2021 17:54:31 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"917"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"The tenant has been created\",\n \"data\": {\n \"tenant_id\": 47,\n \"name\": \"evil_corp\",\n \"description\": \"Evil Corp\",\n \"default\": false,\n \"path\": \"bca4545e5524cc10\",\n \"prefix\": \"EVC\",\n \"enabled\": true,\n \"settings\": {\n \"addons\": \"sonata-stats,sonata-switchboard,vitxi\",\n \"allow_recordings\": \"yes\",\n \"allowed_outbound_routes\": \"\",\n \"allowed_tenant_trunks\": \"\",\n \"calls_limit\": \"10\",\n \"cid_name\": \"\",\n \"cid_number\": \"\",\n \"conferences\": null,\n \"emergency_trunks\": \"13\",\n \"extensions\": null,\n \"inbound_numbers\": \"17755550165,17755550109\",\n \"ivrs\": null,\n \"outbound_profiles\": \"5,4\",\n \"parking_lots\": null,\n \"queues\": null,\n \"restricted_cid\": \"disabled\",\n \"timezone\": \"America/New_York\",\n \"trunks\": null\n },\n \"maintenance\": {\n \"id\": \"40\",\n \"cdr_preservation\": \"190\",\n \"recordings_preservation\": \"190\",\n \"voicemail_preservation\": \"30\",\n \"recordings_clear_less_nseconds\": \"5\",\n \"convert_recordings\": \"yes\",\n \"conversion_quality\": \"16\",\n \"maintenance_cron\": \"1\",\n \"enabled\": \"yes\",\n \"default\": \"no\",\n \"tenant_id\": \"47\"\n }\n }\n}"}],"_postman_id":"c19d8360-6d0e-4bbb-8b47-1ce3dc5d3f1b"},{"name":"/tenants/{id}","id":"48cc531a-4048-4713-9a04-a4b2bf64b168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"description\": \"ABC Corporation\",\r\n \"prefix\": \"ABC\",\r\n \"settings\": {\r\n \"addons\": \"sonata-stats,vitxi\",\r\n \"allow_recordings\": \"yes\",\r\n \"allowed_outbound_routes\": \"\",\r\n \"allowed_tenant_trunks\": \"\",\r\n \"calls_limit\": 20,\r\n \"cid_name\": \"\",\r\n \"cid_number\": \"\",\r\n \"conferences\": \"\",\r\n \"emergency_trunks\": \"13\",\r\n \"extensions\": \"\",\r\n \"inbound_numbers\": \"12185449807,13212451322\",\r\n \"ivrs\": \"\",\r\n \"outbound_profiles\": \"5\",\r\n \"parking_lots\": \"\",\r\n \"queues\": \"\",\r\n \"restricted_cid\": \"disabled\",\r\n \"timezone\": \"America/New_York\",\r\n \"trunks\": \"\"\r\n },\r\n \"maintenance\": {\r\n \"cdr_preservation\": 60,\r\n \"recordings_preservation\": 60,\r\n \"voicemail_preservation\": 30,\r\n \"recordings_clear_less_nseconds\": 1,\r\n \"convert_recordings\": \"yes\",\r\n \"conversion_quality\": 16,\r\n \"maintenance_cron\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/api/v2/tenants/{{tenant_id}}","description":"

Endpoint to update an existing tenant. This endpoint might take some time because it applies changes after updating the tenant.

It removes an existing tenant by ID. After removing the tenant, changes are applied. Consequently, this process can take some time.

This action is irreversible, so be careful when using this endpoint.

Endpoint to add DID/Inbound numbers to an existing tenant. You can provide a list of numbers separated by a comma.

The request to this endpoint might take some time because it applies changes after saving the DIDs to make the inbound calls work as expected.

The endpoint returns the list of the current tenant DIDs after saving the new numbers.

Endpoint to remove DID/Inbound numbers from an existing tenant. You can provide a list of numbers separated by a comma.

The request to this endpoint might take some time because it applies changes after removing the DIDs.

The endpoint returns the list of the current tenant DIDs after removing the given numbers.

Set of endpoints to manage tenants on VitalPBX. For deleting, creating, or updating tenants, you must use the main tenant or an API key with access to all the tenants.

\n","_postman_id":"db46a122-9840-48d5-b415-1c9f6ffd6d62","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Core","item":[{"name":"/core/current_plan","id":"cdf18c74-9b02-4ba0-a0cc-0bc829cd2d16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"}],"url":"https://{{host}}/api/v2/core/current_plan","description":"

Get current plan for VitalPBX, posible results are: community (free version), enterprise, and carrier

This endpoint performs or originates a call with given numbers (caller and callee). If you want to use a specific class of service, you can use the Classes of Services endpoints to list the available CoS in a tenant.

Bear in mind that when the API endpoint queues a call, it might fail due to an invalid caller or callee number. The API has no way to know if the Asterisk server placed the call or not.

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

Option Name	Type	Default Value	Description
caller	String		It represents the number that originates the call. Usually, this parameter would contain an extension number. Nonetheless, you can provide a queue number, conference number, or even an external number. Bear in mind that if you don't supply an extension number, you must provide a valid class of service.
callee	String		It represents the number that receives the call. It can be an internal or external number. If you provide an external number, make sure the format fulfills the outbound routes patterns.
cos_id	Integer		A valid ID of a class of service to be utilized for routing the call. This parameter is optional if the caller is an extension number.
cid_name	String	VitalPBX: Click to Call	Optional parameter that allows you to customize the Caller ID name shown to the caller.
cid_number	String	Callee Number	Optional parameter that allows you to customize the Caller ID number shown to the caller.
variables	Object		List of variables to be part of the call channels. The reserved variable CONTEXT allows you to define a custom context to process your Click to Call calls.

It returns the list of external add-ons installed on the PBX.

Core actions for VitalPBX

\n","_postman_id":"739f4148-1f63-407d-a701-7ac3cb4a03fa","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Classes of Services","item":[{"name":"/classes_of_services","id":"42d1758d-c72c-49d5-80f7-30a051a71dfc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/classes_of_services","description":"

Retrieve all the classes of services filtered by tenant.

Contains all the actions/request that can be performed to the classes of services

\n","_postman_id":"99753798-0d19-412c-8fe3-810510698c33","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Extensions","item":[{"name":"/extensions","id":"b6ea5ad0-647b-947d-55fd-c0020ed3b019","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"

Application key to authenticate requests

\n"},{"key":"tenant","value":"{{tenant}}","description":"

Filter by tenant

\n"}],"url":"http://{{host}}/api/v2/extensions","description":"

Get all extensions and its devices from the PBX filtered by tenant.

Application key to authenticate requests

\n"},{"key":"tenant","value":"{{tenant}}","description":"

Filter request by tenant

\n","type":"text"}],"url":"http://{{host}}/api/v2/extensions/{{extension-id}}","description":"

Get specific extension from server filtered by extension id

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"d105b2e0-152c-89d3-584e-e41e142a491d","id":"d105b2e0-152c-89d3-584e-e41e142a491d","name":"Extensions","type":"folder"}},"urlObject":{"protocol":"http","path":["api","v2","extensions","{{extension-id}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"224ab14f-ab02-4ef6-adee-906340b0fdeb","name":"/extensions/{id}","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"Application key to authenticate requests"},{"key":"tenant","value":"{{tenant}}","description":"Filter request by tenant","type":"text"}],"url":"http://{{host}}/api/v2/extensions/{{extension-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Oct 2019 23:56:18 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"939"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"extension_id\": 63,\n \"extension\": \"2000\",\n \"name\": \"Jose Rivera\",\n \"language\": \"en\",\n \"email\": \"miguel@aplitel.com\",\n \"class_of_service_id\": 1,\n \"dial_profile_id\": 1,\n \"ars_id\": null,\n \"call_limit\": 0,\n \"internal_cid\": \"\\\"Jose Rivera\\\" <2000>\",\n \"external_cid\": \"\\\"Jose Rivera\\\" <87669536>\",\n \"emergency_cid\": \"\\\"VitalPBX\\\" <809091>\",\n \"ringtime\": 0,\n \"nospy\": false,\n \"enabled_pa\": false,\n \"answermode\": \"disable\",\n \"mailbox\": \"2000@vitalpbx-voicemail\",\n \"accountcode\": \"5960859439\",\n \"features_password\": \"12345\",\n \"sendcid\": true,\n \"generate_hints\": false,\n \"hot_desking\": false,\n \"secretary\": null,\n \"music_group_id\": 3,\n \"rec_on_demand\": false,\n \"internal_rec\": true,\n \"outgoing_rec\": true,\n \"incoming_rec\": true,\n \"dictate_enable\": false,\n \"dictate_format\": \"ogg\",\n \"dictate_auto_send\": false,\n \"fax_enabled\": false,\n \"fax_auto_send\": false,\n \"absent_secretary\": false,\n \"lock\": false,\n \"call_waiting\": false,\n \"cid_on_diversions\": \"caller\",\n \"pinless\": true,\n \"dynamic_routing\": true,\n \"tenant_id\": 1,\n \"context\": \"cos-all\"\n }\n}"},{"id":"2c8df27b-96f2-49b4-afb2-7b964977a081","name":"200 - Extension retrieved","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"Application key to authenticate requests"},{"key":"tenant","value":"{{tenant}}","description":"Filter request by tenant","type":"text"}],"url":"http://{{host}}/api/v2/extensions/{{extension-id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Nov 2019 18:30:23 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"1247"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"extension_id\": 3,\n \"extension\": \"7502\",\n \"name\": \"X-Lite\",\n \"language\": \"es_NI\",\n \"email\": null,\n \"class_of_service_id\": 1,\n \"dial_profile_id\": 1,\n \"ars_id\": null,\n \"call_limit\": 0,\n \"internal_cid\": \"\\\"X-Lite\\\" <7502>\",\n \"external_cid\": \"\\\"X-Lite\\\" <7502>\",\n \"emergency_cid\": \"\\\"Telesoft\\\" <22787050>\",\n \"ringtime\": 0,\n \"nospy\": false,\n \"enabled_pa\": false,\n \"answermode\": \"disable\",\n \"mailbox\": \"7502@vitalpbx-voicemail\",\n \"accountcode\": null,\n \"features_password\": \"*56437\",\n \"sendcid\": true,\n \"generate_hints\": false,\n \"hot_desking\": false,\n \"secretary\": null,\n \"music_group_id\": null,\n \"rec_on_demand\": false,\n \"internal_rec\": true,\n \"outgoing_rec\": true,\n \"incoming_rec\": true,\n \"dictate_enable\": false,\n \"dictate_format\": \"ogg\",\n \"dictate_auto_send\": false,\n \"fax_enabled\": false,\n \"fax_auto_send\": false,\n \"absent_secretary\": false,\n \"lock\": false,\n \"call_waiting\": false,\n \"cid_on_diversions\": \"callee\",\n \"pinless\": false,\n \"dynamic_routing\": false,\n \"tenant_id\": 1,\n \"context\": \"cos-all\",\n \"has_analog_devices\": false,\n \"queues_info\": {\n \"queues\": [],\n \"queues_name\": [],\n \"queues_penalty\": []\n },\n \"devices\": [\n {\n \"device_id\": \"3\",\n \"extension_id\": \"3\",\n \"profile_id\": \"1\",\n \"user\": \"dev_7502\",\n \"secret\": \"Letacl@2010\",\n \"description\": \"X-Lite\",\n \"ring_device\": \"yes\",\n \"technology\": \"sip\",\n \"assigned_exten\": \"7502\",\n \"tenant_id\": \"1\",\n \"device_name\": \"dev_7502\"\n }\n ]\n }\n}"},{"id":"4fe09293-9c16-444f-acd3-0f331be08d50","name":"404 - Extension not found","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"Application key to authenticate requests"},{"key":"tenant","value":"{{tenant}}","description":"Filter request by tenant","type":"text"}],"url":"http://{{host}}/api/v2/extensions/1000"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Nov 2019 19:06:27 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"83"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"not_found\",\n \"message\": \"The requested extension doesn't exists\",\n \"data\": []\n}"}],"_postman_id":"10ebea1d-4cd8-0e6a-a803-a6a3db80f2f5"},{"name":"/extensions/{id}/devices","id":"1672992e-f607-4d45-b38e-1bd73cbf8537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","type":"text","value":"{{api-key}}"},{"key":"tenant","type":"text","value":"{{tenant}}"}],"url":"http://{{host}}/api/v2/extensions/{{extension-id}}/devices","description":"

Retrive all devices for a specific extension

Retrive queues info for an specific extension

Get cdr summary from a specific extension

Return all the voicemail records for an specific extension

The current collection shows all the methods available to get or put extensions information.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"11ddbe6c-d244-44e4-bf72-2ccb41d6ada9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b1b328cb-9e76-4a0f-878b-2330ca9770ac","type":"text/javascript","exec":[""]}}],"_postman_id":"d105b2e0-152c-89d3-584e-e41e142a491d"},{"name":"Voicemail","item":[{"name":"/voicemail/{extension}/{folder}/{message}","id":"87164045-0efa-40d7-a395-0ffbeffb6a8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/voicemail/2000/old/msg0002.txt","description":"

Delete an extension's voicemail recording from an specific folder

Allow updating message status from New to Listened (OLD). The parameters are: extension, the folder (inbox or urgent), and the message (msg0000.txt)

Actions to retrieve or delete voicemail of an specific extension

\n","_postman_id":"4e5cefbd-e758-4549-be3f-acdfae43da46","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Queues","item":[{"name":"/queues","id":"bd48c618-fc14-4029-857e-a3ff8572b64d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"

Application key to authenticate requests

\n","type":"text"},{"key":"tenant","value":"{{tenant}}","description":"

Filter by tenant

\n","type":"text"}],"url":"http://{{host}}/api/v2/queues","description":"

Retrive all queues by tenant

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","queues"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"92ff8b90-d79b-4377-bf0c-6bfa354e5f5d","name":"200 - Queues","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"Application key to authenticate requests","type":"text"},{"key":"tenant","value":"{{tenant}}","description":"Filter by tenant","type":"text"}],"url":"http://{{host}}/api/v2/queues"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 29 Nov 2019 20:43:28 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"3601"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"queue_id\": 1,\n \"extension\": 500,\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": 1,\n \"cron_profile_id\": 1,\n \"description\": \"Support Calls\",\n \"prefix\": \"Support:\",\n \"destination_id\": 9,\n \"hangup_destination_id\": null,\n \"strategy\": \"random\",\n \"music_group_id\": null,\n \"weight\": null,\n \"autofill\": true,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": true,\n \"servicelevel\": 10,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": \"10\",\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": true,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 10,\n \"queue_timeout\": null,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q500\",\n \"answered_elsewhere\": true,\n \"agents_context\": \"queue-call-to-agents\",\n \"members\": [\n {\n \"extension\": \"2001\",\n \"interface\": \"Local/2001@queue-call-to-agents/n\",\n \"extension_id\": 243,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\"\n },\n {\n \"extension\": \"2002\",\n \"interface\": \"Local/2002@queue-call-to-agents/n\",\n \"extension_id\": 244,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"dynamic\"\n }\n ]\n },\n {\n \"queue_id\": 2,\n \"extension\": 501,\n \"queue_vip_list_id\": null,\n \"ivr_id\": 1,\n \"queue_callback_id\": null,\n \"cron_profile_id\": null,\n \"description\": \"Sales\",\n \"prefix\": null,\n \"destination_id\": 10,\n \"hangup_destination_id\": null,\n \"strategy\": \"ringall\",\n \"music_group_id\": null,\n \"weight\": null,\n \"autofill\": true,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": true,\n \"servicelevel\": 20,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": null,\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": false,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 15,\n \"queue_timeout\": 10,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q501\",\n \"answered_elsewhere\": false,\n \"agents_context\": \"queue-call-to-agents\",\n \"members\": [\n {\n \"extension\": \"2001\",\n \"interface\": \"Local/2001@queue-call-to-agents/n\",\n \"extension_id\": 243,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"dynamic\"\n }\n ]\n },\n {\n \"queue_id\": 4,\n \"extension\": 504,\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": null,\n \"cron_profile_id\": 1,\n \"description\": \"Support Calls 2\",\n \"prefix\": null,\n \"destination_id\": 12,\n \"hangup_destination_id\": null,\n \"strategy\": \"ringall\",\n \"music_group_id\": 1,\n \"weight\": null,\n \"autofill\": false,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": true,\n \"servicelevel\": null,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": null,\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": false,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 15,\n \"queue_timeout\": 10,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q504\",\n \"answered_elsewhere\": false,\n \"agents_context\": \"queue-call-to-agents\",\n \"members\": [\n {\n \"extension\": \"2000\",\n \"interface\": \"Local/2000@queue-call-to-agents/n\",\n \"extension_id\": 63,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"dynamic\"\n }\n ]\n }\n ]\n}"},{"id":"d38a1e3c-7613-4914-818b-056814e1f0d7","name":"/queues","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","description":"Application key to authenticate requests","type":"text"},{"key":"tenant","value":"{{tenant}}","description":"Filter by tenant","type":"text"}],"url":"http://{{host}}/api/v2/queues"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Oct 2019 23:57:17 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"3627"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"queue_id\": 1,\n \"extension\": 500,\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": 1,\n \"cron_profile_id\": 1,\n \"description\": \"Support Calls\",\n \"prefix\": \"Support:\",\n \"destination_id\": 9,\n \"hangup_destination_id\": null,\n \"strategy\": \"random\",\n \"music_group_id\": null,\n \"weight\": null,\n \"autofill\": true,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": true,\n \"servicelevel\": 10,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": \"10\",\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": true,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 10,\n \"queue_timeout\": 30,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q500\",\n \"answered_elsewhere\": true,\n \"agents_context\": \"queue-call-to-agents\",\n \"members\": [\n {\n \"queue_member_id\": \"93\",\n \"queue_id\": \"1\",\n \"extension_id\": \"243\",\n \"penalty\": \"0\",\n \"diversions\": \"no\",\n \"type\": \"dynamic\",\n \"extension\": \"2001\",\n \"name\": \"Person 01\"\n },\n {\n \"queue_member_id\": \"95\",\n \"queue_id\": \"1\",\n \"extension_id\": \"244\",\n \"penalty\": \"0\",\n \"diversions\": \"no\",\n \"type\": \"dynamic\",\n \"extension\": \"2002\",\n \"name\": \"Person 02\"\n }\n ]\n },\n {\n \"queue_id\": 2,\n \"extension\": 501,\n \"queue_vip_list_id\": null,\n \"ivr_id\": 1,\n \"queue_callback_id\": null,\n \"cron_profile_id\": null,\n \"description\": \"Sales\",\n \"prefix\": null,\n \"destination_id\": 10,\n \"hangup_destination_id\": null,\n \"strategy\": \"ringall\",\n \"music_group_id\": null,\n \"weight\": null,\n \"autofill\": true,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": true,\n \"servicelevel\": 20,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": null,\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": false,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 15,\n \"queue_timeout\": 10,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q501\",\n \"answered_elsewhere\": false,\n \"agents_context\": \"queue-call-to-agents\",\n \"members\": [\n {\n \"queue_member_id\": \"89\",\n \"queue_id\": \"2\",\n \"extension_id\": \"243\",\n \"penalty\": \"0\",\n \"diversions\": \"no\",\n \"type\": \"dynamic\",\n \"extension\": \"2001\",\n \"name\": \"Person 01\"\n }\n ]\n },\n {\n \"queue_id\": 4,\n \"extension\": 504,\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": null,\n \"cron_profile_id\": 1,\n \"description\": \"Support Calls 2\",\n \"prefix\": null,\n \"destination_id\": 12,\n \"hangup_destination_id\": null,\n \"strategy\": \"ringall\",\n \"music_group_id\": 1,\n \"weight\": null,\n \"autofill\": false,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": true,\n \"servicelevel\": null,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": null,\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": false,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 15,\n \"queue_timeout\": 10,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q504\",\n \"answered_elsewhere\": false,\n \"agents_context\": \"queue-call-to-agents\",\n \"members\": [\n {\n \"queue_member_id\": \"94\",\n \"queue_id\": \"4\",\n \"extension_id\": \"63\",\n \"penalty\": \"0\",\n \"diversions\": \"no\",\n \"type\": \"dynamic\",\n \"extension\": \"2000\",\n \"name\": \"Jose Rivera\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"bd48c618-fc14-4029-857e-a3ff8572b64d"},{"name":"/queues/inbound","id":"2ee3428a-aa75-4261-89ef-336ce5c93edb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/queues/inbound","description":"

It returns the list of queues flagged as inbound.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","queues","inbound"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"71e68f9b-ba2c-450f-b29a-f5e5a6168655","name":"200 - Inbound Queues","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/queues/inbound"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 24 Nov 2021 17:33:05 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"6158"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"queue_id\": \"2\",\n \"extension\": \"500\",\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": \"1\",\n \"cron_profile_id\": null,\n \"description\": \"Common Customers\",\n \"prefix\": null,\n \"direction\": \"inbound\",\n \"dial_mode\": null,\n \"destination_id\": \"298\",\n \"hangup_destination_id\": null,\n \"strategy\": \"rrordered\",\n \"music_group_id\": \"1\",\n \"weight\": \"10\",\n \"autofill\": \"yes\",\n \"maxlen\": \"0\",\n \"announcement_id\": null,\n \"periodic_announcement_id\": \"1\",\n \"join_announcement_id\": null,\n \"record\": \"no\",\n \"servicelevel\": \"40\",\n \"wrapuptime\": \"0\",\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": \"10\",\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": \"no\",\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": \"no\",\n \"announce_holdtime\": \"no\",\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": \"no\",\n \"memberdelay\": null,\n \"timeoutrestart\": \"no\",\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": \"15\",\n \"queue_timeout\": \"0\",\n \"leavewhenempty\": \"no\",\n \"retry\": \"5\",\n \"tenant_id\": \"1\",\n \"name\": \"Q500\",\n \"answered_elsewhere\": \"no\",\n \"agents_context\": \"queue-call-to-agents\",\n \"alertinfo\": null,\n \"answerchannel\": \"yes\",\n \"members\": [\n {\n \"member_id\": 29,\n \"extension\": \"101\",\n \"interface\": \"Local/101@queue-call-to-agents/n\",\n \"extension_id\": 288,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\",\n \"name\": \"MicroSIP\"\n },\n {\n \"member_id\": 39,\n \"extension\": \"104\",\n \"interface\": \"Local/104@queue-call-to-agents/n\",\n \"extension_id\": 6374,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\",\n \"name\": \"Bulk Test 104\"\n }\n ]\n },\n {\n \"queue_id\": \"3\",\n \"extension\": \"501\",\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": null,\n \"cron_profile_id\": null,\n \"description\": \"Premium Customers\",\n \"prefix\": null,\n \"direction\": \"inbound\",\n \"dial_mode\": null,\n \"destination_id\": \"299\",\n \"hangup_destination_id\": null,\n \"strategy\": \"rrordered\",\n \"music_group_id\": \"1\",\n \"weight\": \"20\",\n \"autofill\": \"yes\",\n \"maxlen\": \"0\",\n \"announcement_id\": null,\n \"periodic_announcement_id\": \"1\",\n \"join_announcement_id\": null,\n \"record\": \"no\",\n \"servicelevel\": null,\n \"wrapuptime\": \"0\",\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": null,\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": \"no\",\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": \"no\",\n \"announce_holdtime\": \"no\",\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": \"no\",\n \"memberdelay\": null,\n \"timeoutrestart\": \"no\",\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": \"15\",\n \"queue_timeout\": \"15\",\n \"leavewhenempty\": \"no\",\n \"retry\": \"5\",\n \"tenant_id\": \"1\",\n \"name\": \"Q501\",\n \"answered_elsewhere\": \"no\",\n \"agents_context\": \"queue-call-to-agents\",\n \"alertinfo\": null,\n \"answerchannel\": \"yes\",\n \"members\": [\n {\n \"member_id\": 8,\n \"extension\": \"101\",\n \"interface\": \"Local/101@queue-call-to-agents/n\",\n \"extension_id\": 288,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"dynamic\",\n \"name\": \"MicroSIP\"\n }\n ]\n },\n {\n \"queue_id\": \"4\",\n \"extension\": \"502\",\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": null,\n \"cron_profile_id\": null,\n \"description\": \"Provider\",\n \"prefix\": null,\n \"direction\": \"inbound\",\n \"dial_mode\": null,\n \"destination_id\": \"312\",\n \"hangup_destination_id\": \"313\",\n \"strategy\": \"ringall\",\n \"music_group_id\": \"1\",\n \"weight\": null,\n \"autofill\": \"yes\",\n \"maxlen\": \"0\",\n \"announcement_id\": null,\n \"periodic_announcement_id\": \"1\",\n \"join_announcement_id\": null,\n \"record\": \"no\",\n \"servicelevel\": null,\n \"wrapuptime\": \"0\",\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": null,\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": \"no\",\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": \"no\",\n \"announce_holdtime\": \"no\",\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": \"no\",\n \"memberdelay\": null,\n \"timeoutrestart\": \"no\",\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": \"15\",\n \"queue_timeout\": \"30\",\n \"leavewhenempty\": \"no\",\n \"retry\": \"5\",\n \"tenant_id\": \"1\",\n \"name\": \"Q502\",\n \"answered_elsewhere\": \"no\",\n \"agents_context\": \"queue-call-to-agents\",\n \"alertinfo\": null,\n \"answerchannel\": \"yes\",\n \"members\": [\n {\n \"member_id\": 19,\n \"extension\": \"100\",\n \"interface\": \"Local/100@queue-call-to-agents/n\",\n \"extension_id\": 287,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"dynamic\",\n \"name\": \"Jose Rivera\"\n },\n {\n \"member_id\": 22,\n \"extension\": \"101\",\n \"interface\": \"Local/101@queue-call-to-agents/n\",\n \"extension_id\": 288,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"dynamic\",\n \"name\": \"MicroSIP\"\n },\n {\n \"member_id\": 25,\n \"extension\": \"2503\",\n \"interface\": \"Local/2503@queue-call-to-agents/n\",\n \"extension_id\": 6382,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"static\",\n \"name\": \"Mark\"\n },\n {\n \"member_id\": 28,\n \"extension\": \"2504\",\n \"interface\": \"Local/2504@queue-call-to-agents/n\",\n \"extension_id\": 6383,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"static\",\n \"name\": \"Steve\"\n },\n {\n \"member_id\": 31,\n \"extension\": \"2505\",\n \"interface\": \"Local/2505@queue-call-to-agents/n\",\n \"extension_id\": 6384,\n \"penalty\": 0,\n \"diversions\": false,\n \"type\": \"static\",\n \"name\": \"Bill\"\n }\n ]\n },\n {\n \"queue_id\": \"9\",\n \"extension\": \"510\",\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": null,\n \"cron_profile_id\": null,\n \"description\": \"VitalPBX Partners\",\n \"prefix\": null,\n \"direction\": \"inbound\",\n \"dial_mode\": null,\n \"destination_id\": \"424\",\n \"hangup_destination_id\": null,\n \"strategy\": \"rrordered\",\n \"music_group_id\": \"1\",\n \"weight\": \"0\",\n \"autofill\": \"yes\",\n \"maxlen\": \"0\",\n \"announcement_id\": null,\n \"periodic_announcement_id\": \"1\",\n \"join_announcement_id\": null,\n \"record\": \"no\",\n \"servicelevel\": \"30\",\n \"wrapuptime\": \"0\",\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": \"15\",\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": \"no\",\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": \"no\",\n \"announce_holdtime\": \"no\",\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": \"no\",\n \"memberdelay\": null,\n \"timeoutrestart\": \"no\",\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": \"15\",\n \"queue_timeout\": \"300\",\n \"leavewhenempty\": \"no\",\n \"retry\": \"5\",\n \"tenant_id\": \"1\",\n \"name\": \"Q510\",\n \"answered_elsewhere\": \"no\",\n \"agents_context\": \"queue-call-to-agents\",\n \"alertinfo\": null,\n \"answerchannel\": \"yes\",\n \"members\": [\n {\n \"member_id\": 41,\n \"extension\": \"101\",\n \"interface\": \"Local/101@queue-call-to-agents/n\",\n \"extension_id\": 288,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\",\n \"name\": \"MicroSIP\"\n },\n {\n \"member_id\": 42,\n \"extension\": \"104\",\n \"interface\": \"Local/104@queue-call-to-agents/n\",\n \"extension_id\": 6374,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\",\n \"name\": \"Bulk Test 104\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"2ee3428a-aa75-4261-89ef-336ce5c93edb"},{"name":"/queues/outbound","id":"2d94e5d2-ee2f-40e0-8371-1c45d7b2955b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/queues/outbound","description":"

It returns the list of queues flagged as outbound.

Application key to authenticate requests

\n","type":"text"},{"key":"tenant","value":"{{tenant}}","description":"

Filter request by tenant

\n","type":"text"}],"url":"http://{{host}}/api/v2/queues/{{queue-id}}","description":"

Get specific queue info

This endpoint allows you to create queues with all the required parameters. There are some missed endpoints required for some fields(Announcements, Music on Hold, etc.). Nonetheless, the current implementation allows you to create functional queues.

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

Option Name	Type	Default Value	Description
extension	String		Extension number to reach the queue.
description	String		Short description to identify the queue.
prefix	String		Prefix to append to calls in a queue. It typically indicates to the agents from which queue the call comes.
direction	String	inbound	It defines the type of call direction for a queue. This parameter is only available through API, and its possible values are \"inbound\" and \"outbound.\"
dial_mode	String		It defines the mode for outbound dialing. This parameter is only available through API and specially created for the Dialer module.
strategy	String	rrordered	It defines the ring strategy to dial the members of a queue. Possible values are: fewestcalls, leastrecent, linear, random, ringall, rrmemory, rrordered, wrandom. More info about the meaning of each parameter in this link.
weight	Integer	0	Short description to identify the queue.
servicelevel	Integer	30	Used in statistics to determine the service level of the queue (calls answered within the service level time frame).
wrapuptime	Integer	0	The number of seconds to keep a member unavailable in a queue after completing a call.
joinempty	String	yes	Controls whether a caller is added to the queue when no members are available. Possible values are: loose, no, no_inuse, strict, and yes.
leavewhenempty	String	no	Used to control whether callers are kicked out of the queue when members are no longer available to take calls. Possible values are: loose, no, no_inuse, strict, and yes.
timeoutpriority	String	app	Used to control the priority of the two possible timeout options specified for a queue. Possible values are: app and conf.
queue_timeout	Integer	0	It will cause the queue to fail out after a specified number of seconds. Setting up this parameter to zero will disable the queue timeout.
timeout	Integer	15	It specifies the number of seconds to ring a member's device.
retry	Integer	5	It specifies the number of seconds to wait before attempting the next member in the queue if the timeout value is exhausted while attempting to ring a member of the queue
alertinfo	String		It allows you to define an Alert-Info Header for generating a distinctive ringtone on members' devices associated with a queue.
autofill	Boolean	true	The old behavior of the queue (autofill=no) is to have a serial type behavior in that the queue will make all waiting callers wait in the queue even if there is more than one available member ready to take calls until the head caller is connected with the member they were trying to get to.
memberdelay	Integer		Used if you want a delay prior to the caller and queue member being connected to each other.
autopause	String		It Enables/disables the automatic pausing of members who fail to answer a call. Possible values are: All, No, and Yes. More info about this parameter in this link.
ringinuse	Boolean	false	It allows defining if busy agents will receive calls when they are busy.
record	Boolean	false	It allows defining if calls on a queue will get recorded or not.
timeoutrestart	Boolean	false	Setting up this parameter to true will reset the timeout for an agent to answer if either a BUSY or CONGESTION status is received from the channel; this can be useful if the agents are allowed to reject or cancel a call.
answered_elsewhere	Boolean	false	Mark all calls as \"answered elsewhere\" when cancelled. This avoids a missed call on the phone if it supports it.
members	Array		Array with the members of a queue. The \"extension_id\" attribute is the only required parameter for each member.
final_destination	Object		The destination to execute after reaching the queue timeout. The object must contain the destination category's id and the destination's id. You can get the values for this parameter from the destinations' endpoints.
after_hangup_destination	Object		The destination to execute after the agent hanged up; this is useful to run a survey to rate the customer service, for instance. The object must contain the destination category's id and the destination's id. You can get the values for this parameter from the destinations' endpoints.

","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","queues"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"9c49be5c-0be3-49ad-bbb0-e0c98c3d5dfc","name":"200 - Queue Created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"extension\": 510,\r\n \"queue_vip_list_id\": null,\r\n \"ivr_id\": null,\r\n \"queue_callback_id\": null,\r\n \"cron_profile_id\": null,\r\n \"description\": \"Partners\",\r\n \"prefix\": null,\r\n \"direction\": \"inbound\",\r\n \"dial_mode\": null,\r\n \"strategy\": \"rrordered\",\r\n \"music_group_id\": 1,\r\n \"weight\": 0,\r\n \"autofill\": true,\r\n \"maxlen\": 0,\r\n \"announcement_id\": null,\r\n \"periodic_announcement_id\": 1,\r\n \"join_announcement_id\": null,\r\n \"record\": false,\r\n \"servicelevel\": 30,\r\n \"wrapuptime\": 0,\r\n \"announce_frequency\": null,\r\n \"min_announce_frequency\": null,\r\n \"periodic_announce_frequency\": 15,\r\n \"announce_round_seconds\": 0,\r\n \"announce_to_first_user\": false,\r\n \"announce_position\": \"no\",\r\n \"announce_position_limit\": null,\r\n \"relative_periodic_announce\": false,\r\n \"announce_holdtime\": false,\r\n \"penaltymemberslimit\": null,\r\n \"autopause\": \"no\",\r\n \"ringinuse\": false,\r\n \"memberdelay\": null,\r\n \"timeoutrestart\": false,\r\n \"joinempty\": \"yes\",\r\n \"timeoutpriority\": \"app\",\r\n \"timeout\": 15,\r\n \"queue_timeout\": 0,\r\n \"leavewhenempty\": \"no\",\r\n \"retry\": 5,\r\n \"answered_elsewhere\": false,\r\n \"alertinfo\": null,\r\n \"answerchannel\": true,\r\n \"members\": [\r\n {\r\n \"extension_id\": 288,\r\n \"penalty\": 0,\r\n \"diversions\": true,\r\n \"type\": \"dynamic\"\r\n },\r\n {\r\n \"extension_id\": 6374,\r\n \"penalty\": 0,\r\n \"diversions\": true,\r\n \"type\": \"dynamic\"\r\n }\r\n ],\r\n \"final_destination\": {\r\n \"cetegory_id\": 24,\r\n \"destination_id\": 1\r\n },\r\n \"after_hangup_destination\": {\r\n \"cetegory_id\": null,\r\n \"destination_id\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{host}}/api/v2/queues"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Nov 2021 23:34:01 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"1285"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"queue_id\": 9,\n \"extension\": 510,\n \"queue_vip_list_id\": null,\n \"ivr_id\": null,\n \"queue_callback_id\": null,\n \"cron_profile_id\": null,\n \"description\": \"Partners\",\n \"prefix\": null,\n \"direction\": \"inbound\",\n \"dial_mode\": null,\n \"destination_id\": 423,\n \"hangup_destination_id\": null,\n \"strategy\": \"rrordered\",\n \"music_group_id\": 1,\n \"weight\": 0,\n \"autofill\": true,\n \"maxlen\": 0,\n \"announcement_id\": null,\n \"periodic_announcement_id\": 1,\n \"join_announcement_id\": null,\n \"record\": false,\n \"servicelevel\": 30,\n \"wrapuptime\": 0,\n \"announce_frequency\": null,\n \"min_announce_frequency\": null,\n \"periodic_announce_frequency\": \"15\",\n \"announce_round_seconds\": \"0\",\n \"announce_to_first_user\": false,\n \"announce_position\": \"no\",\n \"announce_position_limit\": null,\n \"relative_periodic_announce\": false,\n \"announce_holdtime\": false,\n \"penaltymemberslimit\": null,\n \"autopause\": \"no\",\n \"ringinuse\": false,\n \"memberdelay\": null,\n \"timeoutrestart\": false,\n \"joinempty\": \"yes\",\n \"timeoutpriority\": \"app\",\n \"timeout\": 15,\n \"queue_timeout\": 0,\n \"leavewhenempty\": \"no\",\n \"retry\": 5,\n \"tenant_id\": 1,\n \"name\": \"Q510\",\n \"answered_elsewhere\": false,\n \"agents_context\": \"queue-call-to-agents\",\n \"alertinfo\": null,\n \"answerchannel\": true,\n \"members\": [\n {\n \"member_id\": 41,\n \"extension_id\": 288,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\"\n },\n {\n \"member_id\": 42,\n \"extension_id\": 6374,\n \"penalty\": 0,\n \"diversions\": true,\n \"type\": \"dynamic\"\n }\n ]\n }\n}"},{"id":"e4acd9db-b784-4457-8ca3-dbae0378cb9e","name":"400 - Queue Validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"extension\": 510,\r\n \"queue_vip_list_id\": null,\r\n \"ivr_id\": null,\r\n \"queue_callback_id\": null,\r\n \"cron_profile_id\": null,\r\n \"description\": \"Partners\",\r\n \"prefix\": null,\r\n \"direction\": \"inbound\",\r\n \"dial_mode\": null,\r\n \"strategy\": \"rrordered\",\r\n \"music_group_id\": 1,\r\n \"weight\": 0,\r\n \"autofill\": true,\r\n \"maxlen\": 0,\r\n \"announcement_id\": null,\r\n \"periodic_announcement_id\": 1,\r\n \"join_announcement_id\": null,\r\n \"record\": false,\r\n \"servicelevel\": 30,\r\n \"wrapuptime\": 0,\r\n \"announce_frequency\": null,\r\n \"min_announce_frequency\": null,\r\n \"periodic_announce_frequency\": 15,\r\n \"announce_round_seconds\": 0,\r\n \"announce_to_first_user\": false,\r\n \"announce_position\": \"no\",\r\n \"announce_position_limit\": null,\r\n \"relative_periodic_announce\": false,\r\n \"announce_holdtime\": false,\r\n \"penaltymemberslimit\": null,\r\n \"autopause\": \"no\",\r\n \"ringinuse\": false,\r\n \"memberdelay\": null,\r\n \"timeoutrestart\": false,\r\n \"joinempty\": \"yes\",\r\n \"timeoutpriority\": \"app\",\r\n \"timeout\": 15,\r\n \"queue_timeout\": 0,\r\n \"leavewhenempty\": \"no\",\r\n \"retry\": 5,\r\n \"answered_elsewhere\": false,\r\n \"alertinfo\": null,\r\n \"answerchannel\": true,\r\n \"members\": [\r\n {\r\n \"extension_id\": 288,\r\n \"penalty\": 0,\r\n \"diversions\": true,\r\n \"type\": \"dynamic\"\r\n },\r\n {\r\n \"extension_id\": 6374,\r\n \"penalty\": 0,\r\n \"diversions\": true,\r\n \"type\": \"dynamic\"\r\n }\r\n ],\r\n \"final_destination\": {\r\n \"cetegory_id\": 24,\r\n \"destination_id\": 1\r\n },\r\n \"after_hangup_destination\": {\r\n \"cetegory_id\": null,\r\n \"destination_id\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{host}}/api/v2/queues"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 23 Nov 2021 23:41:40 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"89"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"validation\",\n \"message\": \"The provided description is already in use.\",\n \"data\": []\n}"}],"_postman_id":"c412f919-1829-493a-94be-84301d3abc1e"},{"name":"/queues/{id}","id":"998e908b-78cc-438d-a7f7-2447227a2de8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"queue_vip_list_id\": null,\r\n \"ivr_id\": null,\r\n \"queue_callback_id\": null,\r\n \"cron_profile_id\": null,\r\n \"description\": \"VitalPBX Partners\",\r\n \"prefix\": null,\r\n \"direction\": \"inbound\",\r\n \"dial_mode\": null,\r\n \"strategy\": \"rrordered\",\r\n \"music_group_id\": 1,\r\n \"weight\": 0,\r\n \"autofill\": true,\r\n \"maxlen\": 0,\r\n \"announcement_id\": null,\r\n \"periodic_announcement_id\": 1,\r\n \"join_announcement_id\": null,\r\n \"record\": false,\r\n \"servicelevel\": 30,\r\n \"wrapuptime\": 0,\r\n \"announce_frequency\": null,\r\n \"min_announce_frequency\": null,\r\n \"periodic_announce_frequency\": 15,\r\n \"announce_round_seconds\": 0,\r\n \"announce_to_first_user\": false,\r\n \"announce_position\": \"no\",\r\n \"announce_position_limit\": null,\r\n \"relative_periodic_announce\": false,\r\n \"announce_holdtime\": false,\r\n \"penaltymemberslimit\": null,\r\n \"autopause\": \"no\",\r\n \"ringinuse\": false,\r\n \"ring_unavailable\": false,\r\n \"memberdelay\": null,\r\n \"timeoutrestart\": false,\r\n \"joinempty\": \"yes\",\r\n \"timeoutpriority\": \"app\",\r\n \"timeout\": 15,\r\n \"queue_timeout\": 300,\r\n \"leavewhenempty\": \"no\",\r\n \"retry\": 5,\r\n \"answered_elsewhere\": false,\r\n \"alertinfo\": null,\r\n \"answerchannel\": true,\r\n \"members\": [\r\n {\r\n \"member_id\": 41,\r\n \"extension_id\": 288,\r\n \"penalty\": 0,\r\n \"diversions\": true,\r\n \"type\": \"dynamic\"\r\n },\r\n {\r\n \"member_id\": 42,\r\n \"extension_id\": 6374,\r\n \"penalty\": 0,\r\n \"diversions\": true,\r\n \"type\": \"dynamic\"\r\n }\r\n ],\r\n \"final_destination\": {\r\n \"cetegory_id\": 24,\r\n \"destination_id\": 1\r\n },\r\n \"after_hangup_destination\": {\r\n \"cetegory_id\": null,\r\n \"destination_id\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"http://{{host}}/api/v2/queues/{{queue-id}}","description":"

This endpoint allows you to update an existing queue. For more info about parameters and their possible values, check the table above.

It allows to remove an existing queue.

List of actions available to retrieve, create and edit queues.

After creating, updating, or deleting a queue, you have to execute the \"apply_changes\" endpoint from the tenants' collection; this is essential to generate the configuration files, dial-plan, and others for Asterisk.

The outbound queues are only available through the API, which means that they cannot be modified through the VitalPBX GUI. The outbound queues are for the Dialer add-on only.

\n","_postman_id":"b74e30ac-e3d4-4d97-bf99-f626a7992812","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Conferences","item":[{"name":"/conference/{id}","id":"a5b97e86-4e5e-4b1e-8d4a-e50c613ca2db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/conferences/1","description":"

Get info about specific conference room

Get all PBX conference rooms

Get an specific parking lot item

Get all the parking lots items

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","parking_lots"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"4f791300-0544-41e5-9a3c-1bd1b8487c3a","name":"/parking_lots","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/parking_lots"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Oct 2019 23:58:49 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"789"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"parking_lot_id\": 1,\n \"extension\": 955,\n \"description\": \"Default Parking\",\n \"destination_id\": 6,\n \"parkingtime\": 45,\n \"comebacktoorigin\": true,\n \"comebackdialtime\": 20,\n \"parkedplay\": \"callee\",\n \"parkpos\": 10,\n \"parkedcalltransfers\": \"no\",\n \"parkedcallreparking\": \"no\",\n \"parkedcallhangup\": \"no\",\n \"findslot\": \"first\",\n \"music_group_id\": 3,\n \"defpark\": true,\n \"announce_space_number\": true,\n \"tenant_id\": 1,\n \"parkname\": \"parking-1\"\n },\n {\n \"parking_lot_id\": 2,\n \"extension\": 800,\n \"description\": \"Demo\",\n \"destination_id\": 7,\n \"parkingtime\": 45,\n \"comebacktoorigin\": true,\n \"comebackdialtime\": 30,\n \"parkedplay\": \"caller\",\n \"parkpos\": 10,\n \"parkedcalltransfers\": \"callee\",\n \"parkedcallreparking\": \"no\",\n \"parkedcallhangup\": \"no\",\n \"findslot\": \"next\",\n \"music_group_id\": 6,\n \"defpark\": false,\n \"announce_space_number\": false,\n \"tenant_id\": 1,\n \"parkname\": \"parking-2\"\n }\n ]\n}"},{"id":"988ee992-80c5-4925-b122-439bb8dfbad3","name":"200 - Retrieve all parking lots","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/parking_lots"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Dec 2019 17:58:25 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"804"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"parking_lot_id\": 1,\n \"extension\": 955,\n \"description\": \"Default Parking\",\n \"destination_id\": 6,\n \"parkingtime\": 45,\n \"comebacktoorigin\": true,\n \"comebackdialtime\": 20,\n \"parkedplay\": \"callee\",\n \"parkpos\": 10,\n \"parkedcalltransfers\": \"no\",\n \"parkedcallreparking\": \"no\",\n \"parkedcallhangup\": \"no\",\n \"findslot\": \"first\",\n \"music_group_id\": 3,\n \"defpark\": true,\n \"announce_space_number\": true,\n \"tenant_id\": 1,\n \"parkname\": \"parking-1\"\n },\n {\n \"parking_lot_id\": 2,\n \"extension\": 800,\n \"description\": \"Demo\",\n \"destination_id\": 7,\n \"parkingtime\": 45,\n \"comebacktoorigin\": true,\n \"comebackdialtime\": 30,\n \"parkedplay\": \"caller\",\n \"parkpos\": 10,\n \"parkedcalltransfers\": \"callee\",\n \"parkedcallreparking\": \"no\",\n \"parkedcallhangup\": \"no\",\n \"findslot\": \"next\",\n \"music_group_id\": 6,\n \"defpark\": false,\n \"announce_space_number\": false,\n \"tenant_id\": 1,\n \"parkname\": \"parking-2\"\n }\n ]\n}"}],"_postman_id":"a9777425-6445-4195-b7c1-1c9bb24e2d26"}],"id":"e8da8bb7-2661-4b16-9a71-2a99e879b91a","_postman_id":"e8da8bb7-2661-4b16-9a71-2a99e879b91a","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Trunks","item":[{"name":"/trunk/{id}","id":"857a674e-89aa-4497-809c-8d955c8e3cfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks/1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","trunks","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"7d8b3a0a-948b-4c8b-b547-c56f54c42c33","name":"404 - Trunk not found","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks/100"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Dec 2019 20:52:30 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"79"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"not_found\",\n \"message\": \"The requested trunk doesn't exists\",\n \"data\": []\n}"},{"id":"92f5dfc9-7021-4061-993b-e8aad5ff71a1","name":"200 - Retrieve single trunk","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Dec 2019 20:44:08 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"681"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"trunk_id\": 1,\n \"description\": \"VitalPBX\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"profile_id\": 1,\n \"ringtimer\": 90,\n \"music_group_id\": 6,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"VitalPBX LLC\\\" <35925555${CS:0:3}>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"eBD-Ombutel\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": \"no\",\n \"dtmfmode\": \"auto\",\n \"simultaneous_calls\": 10,\n \"get_did_from\": null,\n \"get_cid_from\": \"contact\",\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": true,\n \"tenant_id\": 1,\n \"username\": \"eBD-Ombutel\",\n \"channels\": []\n }\n}"},{"id":"e5b73e27-51e3-4da0-8be5-851f48418e7d","name":"/trunk/{id}","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 28 Oct 2019 23:59:01 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"594"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"trunk_id\": 1,\n \"description\": \"VitalPBX\",\n \"technology\": \"sip\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"ringtimer\": 90,\n \"music_group_id\": 6,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"VitalPBX LLC\\\" <35925555${CS:0:3}>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"eBD-Ombutel\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": \"no\",\n \"simultaneous_calls\": 10,\n \"get_did_from\": null,\n \"get_cid_from\": \"contact\",\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": true,\n \"tenant_id\": 1\n }\n}"}],"_postman_id":"857a674e-89aa-4497-809c-8d955c8e3cfa"},{"name":"/trunks","id":"0dd9828c-7623-4680-8e01-b48ecc279d4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks","description":"

Get all trunks

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","trunks"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a34891ab-1735-4c8c-b98d-83a50aaaf10b","name":"200 - All trunks retrieved","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Dec 2019 20:45:13 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"trunk_id\": 1,\n \"description\": \"VitalPBX\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"profile_id\": 1,\n \"ringtimer\": 90,\n \"music_group_id\": 6,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"VitalPBX LLC\\\" <35925555${CS:0:3}>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"eBD-Ombutel\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": \"no\",\n \"dtmfmode\": \"auto\",\n \"simultaneous_calls\": 10,\n \"get_did_from\": null,\n \"get_cid_from\": \"contact\",\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": true,\n \"tenant_id\": 1,\n \"username\": \"eBD-Ombutel\",\n \"channels\": []\n },\n {\n \"trunk_id\": 2,\n \"description\": \"Dummy Trunk\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"profile_id\": null,\n \"ringtimer\": 5,\n \"music_group_id\": 1,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"\\\" <>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"SRV-A\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": \"force_rport,comedia\",\n \"dtmfmode\": \"rfc2833\",\n \"simultaneous_calls\": null,\n \"get_did_from\": null,\n \"get_cid_from\": null,\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": true,\n \"continue_on_busy\": true,\n \"tenant_id\": 1,\n \"username\": \"SRV-A\",\n \"channels\": []\n },\n {\n \"trunk_id\": 7,\n \"description\": \"OVPN CLOUD\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"profile_id\": null,\n \"ringtimer\": 90,\n \"music_group_id\": 1,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"\\\" <>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"MACHINE_A\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": null,\n \"dtmfmode\": \"rfc2833\",\n \"simultaneous_calls\": null,\n \"get_did_from\": null,\n \"get_cid_from\": null,\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": false,\n \"tenant_id\": 1,\n \"username\": \"MACHINE_A\",\n \"channels\": []\n },\n {\n \"trunk_id\": 8,\n \"description\": \"OVPN_IAX\",\n \"technology\": \"IAX2\",\n \"class_of_service_id\": 1,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"profile_id\": 2,\n \"ringtimer\": 90,\n \"music_group_id\": 1,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"\\\" <>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"OVPN_IAX\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": null,\n \"dtmfmode\": null,\n \"simultaneous_calls\": null,\n \"get_did_from\": null,\n \"get_cid_from\": null,\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": false,\n \"tenant_id\": 1,\n \"username\": \"OVPN_IAX\",\n \"channels\": []\n },\n {\n \"trunk_id\": 12,\n \"description\": \"PJSIP Trunk\",\n \"technology\": \"PJSIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"profile_id\": 14,\n \"ringtimer\": 90,\n \"music_group_id\": 1,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"Telesoft\\\" <1234567890>\",\n \"overwrite_cid\": true,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"telnyx_demo\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": null,\n \"dtmfmode\": \"rfc4733\",\n \"simultaneous_calls\": null,\n \"get_did_from\": null,\n \"get_cid_from\": null,\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": false,\n \"tenant_id\": 1,\n \"username\": \"telnyx_demo\",\n \"channels\": []\n },\n {\n \"trunk_id\": 24,\n \"description\": \"OpenVox\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 2,\n \"tenant_trunk_id\": null,\n \"profile_id\": null,\n \"ringtimer\": 90,\n \"music_group_id\": 1,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"88569536\\\" <88569536>\",\n \"overwrite_cid\": true,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"openvox\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": null,\n \"dtmfmode\": \"rfc2833\",\n \"simultaneous_calls\": null,\n \"get_did_from\": null,\n \"get_cid_from\": null,\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": false,\n \"tenant_id\": 1,\n \"username\": \"openvox\",\n \"channels\": []\n }\n ]\n}"},{"id":"deb655e6-03d4-42d8-902c-5a5d76b76835","name":"/trunks","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/trunks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 29 Oct 2019 00:00:00 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"trunk_id\": 1,\n \"description\": \"VitalPBX\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"ringtimer\": 90,\n \"music_group_id\": 6,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"VitalPBX LLC\\\" <35925555${CS:0:3}>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"eBD-Ombutel\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": \"no\",\n \"simultaneous_calls\": 10,\n \"get_did_from\": null,\n \"get_cid_from\": \"contact\",\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": false,\n \"continue_on_busy\": true,\n \"tenant_id\": 1,\n \"username\": \"eBD-Ombutel\",\n \"channels\": []\n },\n {\n \"trunk_id\": 2,\n \"description\": \"Dummy Trunk\",\n \"technology\": \"SIP\",\n \"class_of_service_id\": null,\n \"dial_profile_id\": 1,\n \"tenant_trunk_id\": null,\n \"ringtimer\": 5,\n \"music_group_id\": 1,\n \"register\": null,\n \"dialstring\": null,\n \"trunk_cid\": \"\\\"\\\" <>\",\n \"overwrite_cid\": false,\n \"group_id\": null,\n \"group_mode\": \"g\",\n \"outgoing_username\": \"SRV-A\",\n \"incoming_username\": null,\n \"dial_string\": null,\n \"codecs\": null,\n \"nat\": \"force_rport,comedia\",\n \"simultaneous_calls\": null,\n \"get_did_from\": null,\n \"get_cid_from\": null,\n \"mode\": \"visual\",\n \"register_flag\": false,\n \"disable\": true,\n \"continue_on_busy\": true,\n \"tenant_id\": 1,\n \"username\": \"SRV-A\",\n \"channels\": []\n }\n ]\n}"}],"_postman_id":"0dd9828c-7623-4680-8e01-b48ecc279d4b"}],"id":"cf959558-9008-48c9-8afc-b71719514247","_postman_id":"cf959558-9008-48c9-8afc-b71719514247","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Devices","item":[{"name":"/devices","id":"0b87eb69-a2e9-4d8b-bf8b-f86f043c8149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/devices","description":"

Get all devices filtered by Tenant

Get an specific device

Retrieve all the devices flagged with the option \"Vitxi Client\".

It returns CDR data, device info, and others from a specific device.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","devices","vitxi","{{device-id}}"],"host":["{{host}}"],"query":[{"key":"limit","value":"0,10"}],"variable":[]}},"response":[{"id":"6d26a797-621d-4f21-a118-0ef76edf9475","name":"Device not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://{{host}}/api/v2/devices/vitxi/500?limit=0,10","protocol":"http","host":["{{host}}"],"path":["api","v2","devices","vitxi","500"],"query":[{"key":"limit","value":"0,10"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Jan 2021 17:35:43 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"80"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"not_found\",\n \"message\": \"The requested device doesn't exists\",\n \"data\": []\n}"},{"id":"73532916-f518-4779-9b1e-e8bc4d8777e4","name":"Succesful Request","originalRequest":{"method":"GET","header":[],"url":{"raw":"http://{{host}}/api/v2/devices/vitxi/12?limit=0,10","protocol":"http","host":["{{host}}"],"path":["api","v2","devices","vitxi","12"],"query":[{"key":"limit","value":"0,10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Jan 2021 17:34:53 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"6889"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"device\": {\n \"device_id\": 12,\n \"extension_id\": 288,\n \"profile_id\": 1,\n \"user\": \"101\",\n \"secret\": \"ZGv5XGk67hyPU6\",\n \"description\": \"MicroSIP\",\n \"emergency_cid_name\": null,\n \"emergency_cid_number\": null,\n \"ring_device\": true,\n \"technology\": \"pjsip\",\n \"assigned_exten\": null,\n \"tenant_id\": 1,\n \"device_name\": \"101\",\n \"send_push\": false,\n \"vitxi_client\": false,\n \"send_welcome_email\": false,\n \"dispatchable_location_id\": null,\n \"protocol\": \"udp\",\n \"extension\": \"101\"\n },\n \"calls\": [\n {\n \"cdr_id\": \"960\",\n \"calldate\": \"2021-01-23 03:18:31\",\n \"clid\": \"\\\"Agents 2067\\\" <2067>\",\n \"did\": null,\n \"source\": \"2067\",\n \"src\": \"2067\",\n \"dst\": \"101\",\n \"destination\": \"101\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2067-00000004\",\n \"dstchannel\": \"\",\n \"lastapp\": \"VoiceMail\",\n \"lastdata\": \"101@vitalpbx-voicemail,b\",\n \"duration\": \"3\",\n \"billsec\": \"3\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1611371901.22\",\n \"linkedid\": \"1611371901.22\",\n \"sequence\": \"7\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"959\",\n \"calldate\": \"2021-01-23 03:18:21\",\n \"clid\": \"\\\"Agents 2067\\\" <2067>\",\n \"did\": null,\n \"source\": \"2067\",\n \"src\": \"2067\",\n \"dst\": \"101\",\n \"destination\": \"101\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2067-00000004\",\n \"dstchannel\": \"PJSIP/101-00000005\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"PJSIP/101/sip:101@192.168.0.5:56088;ob,10,kKtrU(sub-call-recording^713b0732d7b6\",\n \"duration\": \"10\",\n \"billsec\": \"0\",\n \"disposition\": \"NO ANSWER\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1611371901.22\",\n \"linkedid\": \"1611371901.22\",\n \"sequence\": \"5\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"958\",\n \"calldate\": \"2021-01-23 03:17:20\",\n \"clid\": \"\\\"Agents 2067\\\" <2067>\",\n \"did\": null,\n \"source\": \"2067\",\n \"src\": \"2067\",\n \"dst\": \"101\",\n \"destination\": \"101\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2067-00000002\",\n \"dstchannel\": \"\",\n \"lastapp\": \"VoiceMail\",\n \"lastdata\": \"101@vitalpbx-voicemail,b\",\n \"duration\": \"8\",\n \"billsec\": \"8\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1611371829.14\",\n \"linkedid\": \"1611371829.14\",\n \"sequence\": \"4\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"957\",\n \"calldate\": \"2021-01-23 03:17:09\",\n \"clid\": \"\\\"Agents 2067\\\" <2067>\",\n \"did\": null,\n \"source\": \"2067\",\n \"src\": \"2067\",\n \"dst\": \"101\",\n \"destination\": \"101\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2067-00000002\",\n \"dstchannel\": \"PJSIP/101-00000003\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"PJSIP/101/sip:101@192.168.0.5:56088;ob,10,kKtrU(sub-call-recording^713b0732d7b6\",\n \"duration\": \"10\",\n \"billsec\": \"0\",\n \"disposition\": \"NO ANSWER\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1611371829.14\",\n \"linkedid\": \"1611371829.14\",\n \"sequence\": \"2\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"961\",\n \"calldate\": \"2021-01-23 03:16:26\",\n \"clid\": \"\\\"Push Test\\\" <2502>\",\n \"did\": null,\n \"source\": \"2502\",\n \"src\": \"2502\",\n \"dst\": \"101\",\n \"destination\": \"101\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2502-00000000\",\n \"dstchannel\": \"PJSIP/101-00000001\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"PJSIP/101/sip:101@192.168.0.5:56088;ob,10,kKtrU(sub-call-recording^713b0732d7b6\",\n \"duration\": \"287\",\n \"billsec\": \"284\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1611371786.12\",\n \"linkedid\": \"1611371786.12\",\n \"sequence\": \"0\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2021/01/22/211629-LOCAL-NONE-2502-101-1611371786.13.wav\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"943\",\n \"calldate\": \"2021-01-22 04:13:30\",\n \"clid\": \"\\\"MicroSIP\\\" <101>\",\n \"did\": null,\n \"source\": \"101\",\n \"src\": \"101\",\n \"dst\": \"*71\",\n \"destination\": \"*71\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/101-00000001\",\n \"dstchannel\": \"\",\n \"lastapp\": \"Hangup\",\n \"lastdata\": \"\",\n \"duration\": \"8\",\n \"billsec\": \"8\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1611288810.6\",\n \"linkedid\": \"1611288810.6\",\n \"sequence\": \"1\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"929\",\n \"calldate\": \"2021-01-14 09:39:41\",\n \"clid\": \"\\\"MicroSIP\\\" <101>\",\n \"did\": null,\n \"source\": \"101\",\n \"src\": \"101\",\n \"dst\": \"2502\",\n \"destination\": \"2502\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/101-00000002\",\n \"dstchannel\": \"Local/2502@pjsip-push-00000001;1\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"Local/2502@pjsip-push,30,kKtrU(sub-call-recording^713b0732d7b683af^101^2502^no)\",\n \"duration\": \"46\",\n \"billsec\": \"39\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1610617181.12\",\n \"linkedid\": \"1610617181.12\",\n \"sequence\": \"4\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2021/01/14/033949-LOCAL-NONE-101-2502-1610617181.13.wav\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"927\",\n \"calldate\": \"2021-01-14 09:38:13\",\n \"clid\": \"\\\"MicroSIP\\\" <101>\",\n \"did\": null,\n \"source\": \"101\",\n \"src\": \"101\",\n \"dst\": \"2502\",\n \"destination\": \"2502\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/101-00000000\",\n \"dstchannel\": \"Local/2502@pjsip-push-00000000;1\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"Local/2502@pjsip-push,30,kKtrU(sub-call-recording^713b0732d7b683af^101^2502^no)\",\n \"duration\": \"60\",\n \"billsec\": \"52\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1610617093.3\",\n \"linkedid\": \"1610617093.3\",\n \"sequence\": \"0\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2021/01/14/033821-LOCAL-NONE-101-2502-1610617093.4.wav\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"925\",\n \"calldate\": \"2021-01-14 09:31:02\",\n \"clid\": \"\\\"MicroSIP\\\" <101>\",\n \"did\": null,\n \"source\": \"101\",\n \"src\": \"101\",\n \"dst\": \"2502\",\n \"destination\": \"2502\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/101-00000000\",\n \"dstchannel\": \"\",\n \"lastapp\": \"VoiceMail\",\n \"lastdata\": \"2502@vitalpbx-voicemail,u\",\n \"duration\": \"2\",\n \"billsec\": \"2\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1610616646.3\",\n \"linkedid\": \"1610616646.3\",\n \"sequence\": \"3\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n },\n {\n \"cdr_id\": \"924\",\n \"calldate\": \"2021-01-14 09:30:46\",\n \"clid\": \"\\\"MicroSIP\\\" <101>\",\n \"did\": null,\n \"source\": \"101\",\n \"src\": \"101\",\n \"dst\": \"2502\",\n \"destination\": \"2502\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/101-00000000\",\n \"dstchannel\": \"Local/2502@pjsip-push-00000000;1\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"Local/2502@pjsip-push,30,kKtrU(sub-call-recording^713b0732d7b683af^101^2502^no)\",\n \"duration\": \"15\",\n \"billsec\": \"0\",\n \"disposition\": \"NO ANSWER\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"uniqueid\": \"1610616646.3\",\n \"linkedid\": \"1610616646.3\",\n \"sequence\": \"0\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"trunk\": null\n }\n ],\n \"current_plan\": \"carrier-plus\"\n }\n}"}],"_postman_id":"706fdeba-f614-4131-aa19-57d1b5f1a4c4"},{"name":"/devices/{id}/queues","id":"e87033c4-d808-4d63-8dd6-cfe6826037fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"warning":"This is a duplicate header and will be overridden by the app-key header generated by Postman.","key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/devices/{{device-id}}/queues","description":"

Retrieve the queues associated to a specific device

It returns the status of an agent from its assigned queues.

It retrieves the queues from where the agent is configured as dynamic member

It retrieves the queues from where the agent is configured as static member

It logins a device to provided queues or to all the queues

Pause a device from all or a list of queues.

UnPause device from all/list of queues

Logout from all the queues assigned to a specific device

Actions to get or create devices

\n","_postman_id":"54d959df-8b60-4fea-8607-db1e281c3d20","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"CDR","item":[{"name":"/cdr","id":"aadce5cf-b2bc-4ea3-9a72-00e258411fc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","type":"text","value":"{{api-key}}"},{"key":"tenant","type":"text","value":"{{tenant}}"}],"url":"http://{{host}}/api/v2/cdr?extensions=2000,3806&calltype=1,2,3,4&start_date=1556668800&end_date=1559087999&limit=0,10&order_by=calldate&order_type=desc&search=answered&search_fields=disposition,source,destination&call_history=yes","description":"

Get all cdr info. The requests may contain some filters, like extenisons, numbers, type of call, etc.

Filter cdr by source and destination

\n","type":"text/plain"},"key":"extensions","value":"2000,3806"},{"description":{"content":"

Filter by call type. \n1-> Internal,\n2 -> Incoming,\n3 -> Outgoing,\n4 -> Transit

\n","type":"text/plain"},"key":"calltype","value":"1,2,3,4"},{"description":{"content":"

timestamp date. filter cdr by date range

\n","type":"text/plain"},"key":"start_date","value":"1556668800"},{"description":{"content":"

timestamp date. filter cdr by date range

\n","type":"text/plain"},"key":"end_date","value":"1559087999"},{"description":{"content":"

limit cdr results

\n","type":"text/plain"},"key":"limit","value":"0,10"},{"description":{"content":"

Field to sort results

\n","type":"text/plain"},"key":"order_by","value":"calldate"},{"description":{"content":"

method to order results (desc, asc)

\n","type":"text/plain"},"key":"order_type","value":"desc"},{"description":{"content":"

Filter cdr by a search value

\n","type":"text/plain"},"key":"search","value":"answered"},{"description":{"content":"

Fields to use for searching a value provided on search parameter

\n","type":"text/plain"},"key":"search_fields","value":"disposition,source,destination"},{"description":{"content":"

Flag for retrieving call history of two numbers (extensions)

\n","type":"text/plain"},"key":"call_history","value":"yes"}],"variable":[]}},"response":[{"id":"2efa2182-7bae-48ff-9971-b895965b8c4e","name":"200 - Retrive Call History","originalRequest":{"method":"GET","header":[{"key":"app-key","type":"text","value":"{{api-key}}"},{"key":"tenant","type":"text","value":"{{tenant}}"}],"url":{"raw":"http://{{host}}/api/v2/cdr?extensions=2001,0558270&calltype=1,2,3,4&limit=0,10&order_by=calldate&order_type=desc&search=answered&search_fields=disposition,source,destination&call_history=yes","protocol":"http","host":["{{host}}"],"path":["api","v2","cdr"],"query":[{"key":"extensions","value":"2001,0558270","description":"Filter cdr by source and destination"},{"key":"calltype","value":"1,2,3,4","description":"Filter by call type. \n1-> Internal,\n2 -> Incoming,\n3 -> Outgoing,\n4 -> Transit"},{"key":"start_date","value":"1556668800","description":"timestamp date. filter cdr by date range","disabled":true},{"key":"end_date","value":"1559087999","description":"timestamp date. filter cdr by date range","disabled":true},{"key":"limit","value":"0,10","description":"limit cdr results"},{"key":"order_by","value":"calldate","description":"Field to sort results"},{"key":"order_type","value":"desc","description":"method to order results (desc, asc)"},{"key":"search","value":"answered","description":"Filter cdr by a search value"},{"key":"search_fields","value":"disposition,source,destination","description":"Fields to use for searching a value provided on search parameter"},{"key":"call_history","value":"yes","description":"To retrieve call history between two extensions or numbers"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Dec 2019 18:18:16 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"result\": [\n {\n \"calldate_ts\": \"1575504333\",\n \"cdr_id\": \"1029\",\n \"calldate\": \"2019-12-05 00:05:33\",\n \"clid\": \"\\\"Person 01\\\" <2001>\",\n \"source\": \"2001\",\n \"src\": \"2001\",\n \"dst\": \"0558270\",\n \"destination\": \"0558270\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_2001-000001d0\",\n \"dstchannel\": \"SIP/eBD-Ombutel-000001d1\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/VPBX-UCM6104/8270,90,kKtTrU(sub-call-recording^43b4298b09648469^2001^8270^n\",\n \"duration\": \"4\",\n \"billsec\": \"0\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575504333.2597\",\n \"linkedid\": \"1575504333.2597\",\n \"sequence\": \"1057\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/180536-OUT-NONE-2001-0558270-1575504333.2598.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": \"1\",\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575502415\",\n \"cdr_id\": \"1025\",\n \"calldate\": \"2019-12-04 23:33:35\",\n \"clid\": \"\\\"VitalPBX: Click to Call\\\" <0558270>\",\n \"source\": \"0558270\",\n \"src\": \"0558270\",\n \"dst\": \"2001\",\n \"destination\": \"2001\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010f;2\",\n \"dstchannel\": \"SIP/dev_2001-000001c8\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/dev_2001,5,kKtTrU(sub-call-recording^43b4298b09648469^0558270^2001^no)\",\n \"duration\": \"10\",\n \"billsec\": \"6\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575502415.2567\",\n \"linkedid\": \"1575502415.2566\",\n \"sequence\": \"1048\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/173339-LOCAL-NONE-0558270-2001-1575502415.2568.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": null,\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575502415\",\n \"cdr_id\": \"1024\",\n \"calldate\": \"2019-12-04 23:33:35\",\n \"clid\": \"\\\"Person 01\\\" <2001>\",\n \"source\": \"2001\",\n \"src\": \"2001\",\n \"dst\": \"0558270\",\n \"destination\": \"0558270\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010f;1\",\n \"dstchannel\": \"SIP/eBD-Ombutel-000001c9\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/VPBX-UCM6104/8270,90,kKtTrU(sub-call-recording^43b4298b09648469^2001^8270^n\",\n \"duration\": \"10\",\n \"billsec\": \"6\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575502415.2566\",\n \"linkedid\": \"1575502415.2566\",\n \"sequence\": \"1047\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/173342-OUT-NONE-2001-0558270-1575502420.2569.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": \"1\",\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575502312\",\n \"cdr_id\": \"1023\",\n \"calldate\": \"2019-12-04 23:31:52\",\n \"clid\": \"\\\"Person 01\\\" <2001>\",\n \"source\": \"2001\",\n \"src\": \"2001\",\n \"dst\": \"0558270\",\n \"destination\": \"0558270\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010e;1\",\n \"dstchannel\": \"SIP/eBD-Ombutel-000001c7\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/VPBX-UCM6104/8270,90,kKtTrU(sub-call-recording^43b4298b09648469^2001^8270^n\",\n \"duration\": \"8\",\n \"billsec\": \"6\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575502312.2560\",\n \"linkedid\": \"1575502312.2560\",\n \"sequence\": \"1043\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/173158-OUT-NONE-2001-0558270-1575502316.2563.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": \"1\",\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575502312\",\n \"cdr_id\": \"1022\",\n \"calldate\": \"2019-12-04 23:31:52\",\n \"clid\": \"\\\"VitalPBX: Click to Call\\\" <0558270>\",\n \"source\": \"0558270\",\n \"src\": \"0558270\",\n \"dst\": \"2001\",\n \"destination\": \"2001\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010e;2\",\n \"dstchannel\": \"SIP/dev_2001-000001c6\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/dev_2001,5,kKtTrU(sub-call-recording^43b4298b09648469^0558270^2001^no)\",\n \"duration\": \"8\",\n \"billsec\": \"6\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575502312.2561\",\n \"linkedid\": \"1575502312.2560\",\n \"sequence\": \"1044\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/173155-LOCAL-NONE-0558270-2001-1575502312.2562.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": null,\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575502040\",\n \"cdr_id\": \"1021\",\n \"calldate\": \"2019-12-04 23:27:20\",\n \"clid\": \"\\\"Person 01\\\" <2001>\",\n \"source\": \"2001\",\n \"src\": \"2001\",\n \"dst\": \"0558270\",\n \"destination\": \"0558270\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010d;1\",\n \"dstchannel\": \"SIP/eBD-Ombutel-000001c5\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/VPBX-UCM6104/8270,90,kKtTrU(sub-call-recording^43b4298b09648469^2001^8270^n\",\n \"duration\": \"10\",\n \"billsec\": \"7\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575502040.2554\",\n \"linkedid\": \"1575502040.2554\",\n \"sequence\": \"1039\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/172726-OUT-NONE-2001-0558270-1575502043.2557.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": \"1\",\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575502040\",\n \"cdr_id\": \"1020\",\n \"calldate\": \"2019-12-04 23:27:20\",\n \"clid\": \"\\\"VitalPBX: Click to Call\\\" <0558270>\",\n \"source\": \"0558270\",\n \"src\": \"0558270\",\n \"dst\": \"2001\",\n \"destination\": \"2001\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010d;2\",\n \"dstchannel\": \"SIP/dev_2001-000001c4\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/dev_2001,5,kKtTrU(sub-call-recording^43b4298b09648469^0558270^2001^no)\",\n \"duration\": \"10\",\n \"billsec\": \"7\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575502040.2555\",\n \"linkedid\": \"1575502040.2554\",\n \"sequence\": \"1040\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/172723-LOCAL-NONE-0558270-2001-1575502040.2556.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": null,\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575490173\",\n \"cdr_id\": \"1017\",\n \"calldate\": \"2019-12-04 20:09:33\",\n \"clid\": \"\\\"Person 01\\\" <2001>\",\n \"source\": \"2001\",\n \"src\": \"2001\",\n \"dst\": \"0558270\",\n \"destination\": \"0558270\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010a;1\",\n \"dstchannel\": \"SIP/eBD-Ombutel-000001c3\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/VPBX-UCM6104/8270,90,kKtTrU(sub-call-recording^43b4298b09648469^2001^8270^n\",\n \"duration\": \"17\",\n \"billsec\": \"13\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575490173.2541\",\n \"linkedid\": \"1575490173.2541\",\n \"sequence\": \"1032\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/140942-OUT-NONE-2001-0558270-1575490176.2544.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": \"1\",\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575490173\",\n \"cdr_id\": \"1016\",\n \"calldate\": \"2019-12-04 20:09:33\",\n \"clid\": \"\\\"VitalPBX: Click to Call\\\" <0558270>\",\n \"source\": \"0558270\",\n \"src\": \"0558270\",\n \"dst\": \"2001\",\n \"destination\": \"2001\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"Local/2001@click-to-call-0000010a;2\",\n \"dstchannel\": \"SIP/dev_2001-000001c2\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/dev_2001,5,kKtTrU(sub-call-recording^43b4298b09648469^0558270^2001^no)\",\n \"duration\": \"17\",\n \"billsec\": \"13\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575490173.2542\",\n \"linkedid\": \"1575490173.2541\",\n \"sequence\": \"1033\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/12/04/140936-LOCAL-NONE-0558270-2001-1575490173.2543.wav\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": null,\n \"custom_id\": null\n },\n {\n \"calldate_ts\": \"1575479235\",\n \"cdr_id\": \"1007\",\n \"calldate\": \"2019-12-04 17:07:15\",\n \"clid\": \"\\\"Person 01\\\" <2001>\",\n \"source\": \"2001\",\n \"src\": \"2001\",\n \"dst\": \"0558270\",\n \"destination\": \"0558270\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_2001-000001bf\",\n \"dstchannel\": \"SIP/eBD-Ombutel-000001c0\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/VPBX-UCM6104/8270,90,kKtTrU(sub-call-recording^43b4298b09648469^2001^8270^n\",\n \"duration\": \"36\",\n \"billsec\": \"29\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1575479235.2510\",\n \"linkedid\": \"1575479235.2510\",\n \"sequence\": \"1019\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/disk4tb/call-recordings/0558270/2019-12-04-11-07-17-0558270.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\",\n \"trunk\": \"1\",\n \"custom_id\": null\n }\n ],\n \"rows\": \"15\"\n }\n}"},{"id":"bd289425-e3fb-49c2-814b-c47adf1d6f78","name":"200 - CDR Records","originalRequest":{"method":"GET","header":[{"key":"app-key","type":"text","value":"{{api-key}}"},{"key":"tenant","type":"text","value":"{{tenant}}"}],"url":{"raw":"http://{{host}}/api/v2/cdr?extensions=2000,3806&calltype=1,2,3,4&start_date=1556668800&end_date=1559087999&limit=0,10&order_by=calldate&order_type=desc&search=answered&search_fields=disposition,source,destination","protocol":"http","host":["{{host}}"],"path":["api","v2","cdr"],"query":[{"key":"extensions","value":"2000,3806","description":"Filter cdr by source and destination"},{"key":"calltype","value":"1,2,3,4","description":"Filter by call type. \n1-> Internal,\n2 -> Incoming,\n3 -> Outgoing,\n4 -> Transit"},{"key":"start_date","value":"1556668800","description":"timestamp date. filter cdr by date range"},{"key":"end_date","value":"1559087999","description":"timestamp date. filter cdr by date range"},{"key":"limit","value":"0,10","description":"limit cdr results"},{"key":"order_by","value":"calldate","description":"Field to sort results"},{"key":"order_type","value":"desc","description":"method to order results (desc, asc)"},{"key":"search","value":"answered","description":"Filter cdr by a search value"},{"key":"search_fields","value":"disposition,source,destination","description":"Fields to use for searching a value provided on search parameter"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 31 May 2019 16:58:12 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"7603"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"result\": [\n {\n \"calldate_ts\": \"1559083787\",\n \"cdr_id\": \"190\",\n \"calldate\": \"2019-05-28 22:49:47\",\n \"clid\": \"\\\"Extension 3806\\\" <3806>\",\n \"source\": \"3806\",\n \"src\": \"3806\",\n \"dst\": \"8910\",\n \"destination\": \"8910\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_3806-0000008f\",\n \"dstchannel\": \"SIP/eBD-Ombutel-00000090\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/eBD-Ombutel/8910,90,ktTrU(sub-call-recording^43b4298b09648469^3806^8910^no)\",\n \"duration\": \"35\",\n \"billsec\": \"32\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559083787.319\",\n \"linkedid\": \"1559083787.319\",\n \"sequence\": \"205\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559083787.320.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559071653\",\n \"cdr_id\": \"185\",\n \"calldate\": \"2019-05-28 19:27:33\",\n \"clid\": \"\\\"Jose Rivera\\\" <2000>\",\n \"source\": \"2000\",\n \"src\": \"2000\",\n \"dst\": \"501\",\n \"destination\": \"501\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2000-00000012\",\n \"dstchannel\": \"\",\n \"lastapp\": \"Queue\",\n \"lastdata\": \"Q501,,,,\",\n \"duration\": \"2\",\n \"billsec\": \"2\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"5960859439\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559071653.306\",\n \"linkedid\": \"1559071653.306\",\n \"sequence\": \"196\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559071483\",\n \"cdr_id\": \"184\",\n \"calldate\": \"2019-05-28 19:24:43\",\n \"clid\": \"\\\"Extension 3806\\\" <3806>\",\n \"source\": \"3806\",\n \"src\": \"3806\",\n \"dst\": \"8910\",\n \"destination\": \"8910\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_3806-0000008c\",\n \"dstchannel\": \"SIP/eBD-Ombutel-0000008d\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/eBD-Ombutel/8910,90,ktTrU(sub-call-recording^43b4298b09648469^3806^8910^no)\",\n \"duration\": \"15\",\n \"billsec\": \"10\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559071483.301\",\n \"linkedid\": \"1559071483.301\",\n \"sequence\": \"194\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559071483.302.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559070928\",\n \"cdr_id\": \"183\",\n \"calldate\": \"2019-05-28 19:15:28\",\n \"clid\": \"\\\"Jose Rivera\\\" <2000>\",\n \"source\": \"2000\",\n \"src\": \"2000\",\n \"dst\": \"501\",\n \"destination\": \"501\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2000-00000011\",\n \"dstchannel\": \"\",\n \"lastapp\": \"Queue\",\n \"lastdata\": \"Q501,,,,\",\n \"duration\": \"2\",\n \"billsec\": \"2\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"5960859439\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559070928.299\",\n \"linkedid\": \"1559070928.299\",\n \"sequence\": \"193\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559069364\",\n \"cdr_id\": \"181\",\n \"calldate\": \"2019-05-28 18:49:24\",\n \"clid\": \"\\\"X-Lite\\\" <7502>\",\n \"source\": \"7502\",\n \"src\": \"7502\",\n \"dst\": \"3806\",\n \"destination\": \"3806\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_7502-00000088\",\n \"dstchannel\": \"PJSIP/2000-00000010\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/dev_3806&SIP/3806,30,kKtTrU(sub-call-recording^43b4298b09648469^7502^3806^n\",\n \"duration\": \"5\",\n \"billsec\": \"5\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559069356.290\",\n \"linkedid\": \"1559069356.290\",\n \"sequence\": \"190\",\n \"peeraccount\": \"5960859439\",\n \"calltype\": \"1\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559069364.292.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559068732\",\n \"cdr_id\": \"177\",\n \"calldate\": \"2019-05-28 18:38:52\",\n \"clid\": \"\\\"Jose Rivera\\\" <2000>\",\n \"source\": \"2000\",\n \"src\": \"2000\",\n \"dst\": \"501\",\n \"destination\": \"501\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"PJSIP/2000-0000000e\",\n \"dstchannel\": \"\",\n \"lastapp\": \"Queue\",\n \"lastdata\": \"Q501,,,,\",\n \"duration\": \"6\",\n \"billsec\": \"6\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"5960859439\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559068732.286\",\n \"linkedid\": \"1559068732.286\",\n \"sequence\": \"185\",\n \"peeraccount\": \"\",\n \"calltype\": \"1\",\n \"recfile\": \"\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559066535\",\n \"cdr_id\": \"176\",\n \"calldate\": \"2019-05-28 18:02:15\",\n \"clid\": \"\\\"Extension 3806\\\" <3806>\",\n \"source\": \"3806\",\n \"src\": \"3806\",\n \"dst\": \"8910\",\n \"destination\": \"8910\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_3806-00000086\",\n \"dstchannel\": \"SIP/eBD-Ombutel-00000087\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/eBD-Ombutel/8910,90,ktTrU(sub-call-recording^43b4298b09648469^3806^8910^no)\",\n \"duration\": \"14\",\n \"billsec\": \"10\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559066535.281\",\n \"linkedid\": \"1559066535.281\",\n \"sequence\": \"183\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559066535.282.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559066442\",\n \"cdr_id\": \"175\",\n \"calldate\": \"2019-05-28 18:00:42\",\n \"clid\": \"\\\"Extension 3806\\\" <3806>\",\n \"source\": \"3806\",\n \"src\": \"3806\",\n \"dst\": \"8910\",\n \"destination\": \"8910\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_3806-00000083\",\n \"dstchannel\": \"SIP/eBD-Ombutel-00000084\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/eBD-Ombutel/8910,90,ktTrU(sub-call-recording^43b4298b09648469^3806^8910^no)\",\n \"duration\": \"46\",\n \"billsec\": \"39\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559066442.277\",\n \"linkedid\": \"1559066442.277\",\n \"sequence\": \"180\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559066442.278.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559066349\",\n \"cdr_id\": \"174\",\n \"calldate\": \"2019-05-28 17:59:09\",\n \"clid\": \"\\\"Extension 3806\\\" <3806>\",\n \"source\": \"3806\",\n \"src\": \"3806\",\n \"dst\": \"8910\",\n \"destination\": \"8910\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_3806-00000081\",\n \"dstchannel\": \"SIP/eBD-Ombutel-00000082\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/eBD-Ombutel/8910,90,ktTrU(sub-call-recording^43b4298b09648469^3806^8910^no)\",\n \"duration\": \"19\",\n \"billsec\": \"13\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559066349.274\",\n \"linkedid\": \"1559066349.274\",\n \"sequence\": \"178\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559066349.275.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n },\n {\n \"calldate_ts\": \"1559065791\",\n \"cdr_id\": \"173\",\n \"calldate\": \"2019-05-28 17:49:51\",\n \"clid\": \"\\\"Extension 3806\\\" <3806>\",\n \"source\": \"3806\",\n \"src\": \"3806\",\n \"dst\": \"8910\",\n \"destination\": \"8910\",\n \"dcontext\": \"cos-all\",\n \"channel\": \"SIP/dev_3806-0000007f\",\n \"dstchannel\": \"SIP/eBD-Ombutel-00000080\",\n \"lastapp\": \"Dial\",\n \"lastdata\": \"SIP/eBD-Ombutel/8910,90,ktTrU(sub-call-recording^43b4298b09648469^3806^8910^no)\",\n \"duration\": \"9\",\n \"billsec\": \"1\",\n \"disposition\": \"ANSWERED\",\n \"amaflags\": \"3\",\n \"accountcode\": \"\",\n \"auth_code\": null,\n \"customer_code\": null,\n \"pin_code\": null,\n \"userfield\": \"\",\n \"uniqueid\": \"1559065791.271\",\n \"linkedid\": \"1559065791.271\",\n \"sequence\": \"176\",\n \"peeraccount\": \"\",\n \"calltype\": \"3\",\n \"recfile\": \"/var/spool/asterisk/monitor/2019/05/28/1559065791.272.mp3\",\n \"tenant\": \"vitalpbx\",\n \"processed\": \"0\",\n \"billing_cap\": \"no\",\n \"sync_on_recording\": \"no\"\n }\n ],\n \"rows\": \"154\"\n }\n}"}],"_postman_id":"aadce5cf-b2bc-4ea3-9a72-00e258411fc1"}],"id":"490e4d8d-ba10-4765-a67b-42b8019e2f69","description":"

Actions to retrive info from Asterisk CDR

\n","_postman_id":"490e4d8d-ba10-4765-a67b-42b8019e2f69","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Phone Books","item":[{"name":"/phonebooks","id":"7b51399b-d2c0-4203-854f-e7890b826278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/phonebooks","description":"

Get all available phonebooks on the PBX

Get a specific phonebook

List the contactas related to an specific phonebook

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","phonebooks","3","contacts"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"cef8f531-36b9-4b10-925b-770006711057","name":"200 - Retrieve phonebook contacts","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/phonebooks/3/contacts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Sep 2019 15:49:43 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"7279"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"name\": \"James Butt\",\n \"telephone\": \"5048451427\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Josephine Darakjy\",\n \"telephone\": \"8103749840\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Art Venere\",\n \"telephone\": \"8562644130\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Lenna Paprocki\",\n \"telephone\": \"9079212010\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Donette Foller\",\n \"telephone\": \"5135494561\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Simona Morasca\",\n \"telephone\": \"4198006759\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Mitsue Tollner\",\n \"telephone\": \"7739248565\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Leota Dilliard\",\n \"telephone\": \"4088131105\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Sage Wieser\",\n \"telephone\": \"6057944895\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Kris Marrier\",\n \"telephone\": \"4108044694\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Minna Amigon\",\n \"telephone\": \"2154228694\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Abel Maclead\",\n \"telephone\": \"6316773675\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Kiley Caldarera\",\n \"telephone\": \"3102543084\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Graciela Ruta\",\n \"telephone\": \"4405797763\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Cammy Albares\",\n \"telephone\": \"9568417216\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Mattie Poquette\",\n \"telephone\": \"6029536360\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Meaghan Garufi\",\n \"telephone\": \"9312357959\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Gladys Rim\",\n \"telephone\": \"4143772880\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Yuki Whobrey\",\n \"telephone\": \"3133414470\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Fletcher Flosi\",\n \"telephone\": \"8154265657\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Bette Nicka\",\n \"telephone\": \"6104924643\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Veronika Inouye\",\n \"telephone\": \"4088134592\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Willard Kolmetz\",\n \"telephone\": \"9728964882\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Maryann Royster\",\n \"telephone\": \"5184488982\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Alisha Slusarski\",\n \"telephone\": \"7326353453\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Allene Iturbide\",\n \"telephone\": \"7155309863\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Chanel Caudy\",\n \"telephone\": \"9138991103\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Ezekiel Chui\",\n \"telephone\": \"4102358738\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Willow Kusko\",\n \"telephone\": \"2129345167\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Bernardo Figeroa\",\n \"telephone\": \"9365973614\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Ammie Corrio\",\n \"telephone\": \"6146483265\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Francine Vocelka\",\n \"telephone\": \"5053355293\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Ernie Stenseth\",\n \"telephone\": \"2013879093\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Albina Glick\",\n \"telephone\": \"7327826701\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Alishia Sergi\",\n \"telephone\": \"2127532740\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Solange Shinko\",\n \"telephone\": \"5042658174\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Jose Stockham\",\n \"telephone\": \"2125694233\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Rozella Ostrosky\",\n \"telephone\": \"8056091531\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Valentine Gillian\",\n \"telephone\": \"2103006244\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Kati Rulapaugh\",\n \"telephone\": \"7852197724\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Youlanda Schemmer\",\n \"telephone\": \"5419932611\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Dyan Oldroyd\",\n \"telephone\": \"9136458918\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Roxane Campain\",\n \"telephone\": \"9073356568\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Lavera Perin\",\n \"telephone\": \"3059952078\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Erick Ferencz\",\n \"telephone\": \"9072276777\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Fatima Saylors\",\n \"telephone\": \"9524792375\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Jina Briddick\",\n \"telephone\": \"6179975771\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Kanisha Waycott\",\n \"telephone\": \"3233157314\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Emerson Bowley\",\n \"telephone\": \"6086587940\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Blair Malet\",\n \"telephone\": \"2157944519\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Brock Bolognia\",\n \"telephone\": \"2126175063\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Lorrie Nestle\",\n \"telephone\": \"9313036041\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Sabra Uyetake\",\n \"telephone\": \"8036813678\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Marjory Mastella\",\n \"telephone\": \"6103797125\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Karl Klonowski\",\n \"telephone\": \"9084704661\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Tonette Wenner\",\n \"telephone\": \"5163334861\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Amber Monarrez\",\n \"telephone\": \"2153296386\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Shenika Seewald\",\n \"telephone\": \"8187498650\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Delmy Ahle\",\n \"telephone\": \"4015598961\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Deeanna Juhas\",\n \"telephone\": \"2154179563\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Blondell Pugh\",\n \"telephone\": \"4013008122\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Jamal Vanausdal\",\n \"telephone\": \"7329042931\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Cecily Hollack\",\n \"telephone\": \"5128613814\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Carmelina Lindall\",\n \"telephone\": \"3038745160\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Maurine Yglesias\",\n \"telephone\": \"4145737719\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Tawna Buvens\",\n \"telephone\": \"2124629157\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Penney Weight\",\n \"telephone\": \"9078732882\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Elly Morocco\",\n \"telephone\": \"8144203553\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Ilene Eroman\",\n \"telephone\": \"4109374543\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Vallie Mondella\",\n \"telephone\": \"2087378439\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Kallie Blackwood\",\n \"telephone\": \"4156047609\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Johnetta Abdallah\",\n \"telephone\": \"9197153791\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Bobbye Rhym\",\n \"telephone\": \"6508119032\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Micaela Rhymes\",\n \"telephone\": \"9255227798\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Tamar Hoogland\",\n \"telephone\": \"7405265410\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Moon Parlato\",\n \"telephone\": \"5854984278\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Laurel Reitler\",\n \"telephone\": \"4109576903\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Delisa Crupi\",\n \"telephone\": \"9738479611\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Viva Toelkes\",\n \"telephone\": \"7733523437\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Elza Lipke\",\n \"telephone\": \"9737963667\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Devorah Chickering\",\n \"telephone\": \"5059501763\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Timothy Mulqueen\",\n \"telephone\": \"7186547063\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Arlette Honeywell\",\n \"telephone\": \"9045149918\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Dominque Dickerson\",\n \"telephone\": \"5109017640\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Lettie Isenhower\",\n \"telephone\": \"2167338494\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Myra Munns\",\n \"telephone\": \"8174513518\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Stephaine Barfield\",\n \"telephone\": \"3109681219\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Lai Gato\",\n \"telephone\": \"8479574614\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Stephen Emigh\",\n \"telephone\": \"3307002312\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Tyra Shields\",\n \"telephone\": \"2152288264\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Tammara Wardrip\",\n \"telephone\": \"6502165075\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Cory Gibes\",\n \"telephone\": \"6266962777\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Danica Bruschke\",\n \"telephone\": \"2542051422\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Wilda Giguere\",\n \"telephone\": \"9079149482\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Elvera Benimadho\",\n \"telephone\": \"4084408447\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Carma Vanheusen\",\n \"telephone\": \"5104524835\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Malinda Hochard\",\n \"telephone\": \"3174722412\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Natalie Fern\",\n \"telephone\": \"3072793793\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Lisha Centini\",\n \"telephone\": \"7034757568\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Jose Rivera\",\n \"telephone\": \"+13055605776\",\n \"category\": \"General\"\n },\n {\n \"name\": \"Jose Montes\",\n \"telephone\": \"17056502345\",\n \"category\": \"General\"\n }\n ]\n}"},{"id":"d3a3a341-3596-4439-8986-920859c42698","name":"400 - Invalid Phone Book","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/phonebooks/6/contacts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 02 Dec 2019 19:58:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/5.4.16"},{"key":"X-Powered-By","value":"PHP/5.4.16"},{"key":"Content-Length","value":"86"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"validation\",\n \"message\": \"The provided phonebook ID doesn't exists\",\n \"data\": []\n}"}],"_postman_id":"f77ba0c4-0309-4e5a-a8f3-7e8610051ba2"}],"id":"078db0e9-8590-4fc0-847e-9bf52777f420","_postman_id":"078db0e9-8590-4fc0-847e-9bf52777f420","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Device Profiles","item":[{"name":"/device_profiles","id":"3d44ad92-dc10-4a88-9287-539131b4b90c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{host}}/api/v2/device_profiles","description":"

It returns an array with all the available profiles

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"http","path":["api","v2","device_profiles"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"ad8e5bf8-986e-4819-9ce4-a18d93fde128","name":"200 OK - All Profiles Retrieved","originalRequest":{"method":"GET","header":[],"url":"http://{{host}}/api/v2/device_profiles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 14 Jul 2020 09:01:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.31"},{"key":"X-Powered-By","value":"PHP/7.2.31"},{"key":"Content-Length","value":"7753"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"technology\": \"bri\",\n \"signaling\": \"bri_cpe\",\n \"switchtype\": \"euroisdn\",\n \"facility\": \"disabled\",\n \"inbanddisconnect\": true,\n \"facilityenable\": \"disabled\",\n \"overlapdial\": \"no\",\n \"resetinterval\": 0,\n \"pridialplan\": \"unknown\",\n \"prilocaldialplan\": \"national\",\n \"internationalprefix\": null,\n \"localprefix\": null,\n \"nationalprefix\": null,\n \"privateprefix\": null,\n \"unknownprefix\": null,\n \"usecallingpres\": true,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 5,\n \"name\": \"Default BRI TE Profile\",\n \"description\": \"Default BRI TE Profile\",\n \"default\": true\n },\n {\n \"technology\": \"bri\",\n \"signaling\": \"bri_net\",\n \"switchtype\": \"euroisdn\",\n \"facility\": \"disabled\",\n \"inbanddisconnect\": true,\n \"facilityenable\": \"disabled\",\n \"overlapdial\": \"no\",\n \"resetinterval\": 0,\n \"pridialplan\": \"unknown\",\n \"prilocaldialplan\": \"national\",\n \"internationalprefix\": null,\n \"localprefix\": null,\n \"nationalprefix\": null,\n \"privateprefix\": null,\n \"unknownprefix\": null,\n \"usecallingpres\": true,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 6,\n \"name\": \"Default BRI NT Profile\",\n \"description\": \"Default BRI NT Profile\",\n \"default\": true\n },\n {\n \"technology\": \"e1pri\",\n \"signaling\": \"pri_cpe\",\n \"switchtype\": \"euroisdn\",\n \"inbanddisconnect\": true,\n \"facilityenable\": \"enabled\",\n \"overlapdial\": \"no\",\n \"resetinterval\": 0,\n \"pridialplan\": \"unknown\",\n \"prilocaldialplan\": \"national\",\n \"internationalprefix\": null,\n \"localprefix\": null,\n \"nationalprefix\": null,\n \"privateprefix\": null,\n \"unknownprefix\": null,\n \"usecallingpres\": true,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 7,\n \"name\": \"Default E1 PRI Profile\",\n \"description\": \"Default E1 PRI Profile\",\n \"default\": true\n },\n {\n \"technology\": \"e1r2\",\n \"signaling\": \"mfcr2\",\n \"switchtype\": \"euroisdn\",\n \"variant\": \"mx\",\n \"maxani\": 10,\n \"maxdnis\": 4,\n \"ani_first\": false,\n \"category\": \"national_subscriber\",\n \"back_timeout\": 0,\n \"pulse_timeout\": 0,\n \"collect_calls\": false,\n \"double_answer\": false,\n \"immediate_accept\": false,\n \"skip_category\": false,\n \"forced_release\": false,\n \"charge_calls\": true,\n \"dtmf_dialing\": true,\n \"default_bits\": \"1101\",\n \"log_level\": \"nothing\",\n \"log_callfile_dir\": null,\n \"inbanddisconnect\": true,\n \"facilityenable\": \"enabled\",\n \"overlapdial\": \"no\",\n \"resetinterval\": 0,\n \"pridialplan\": \"unknown\",\n \"prilocaldialplan\": \"national\",\n \"internationalprefix\": null,\n \"localprefix\": null,\n \"nationalprefix\": null,\n \"privateprefix\": null,\n \"unknownprefix\": null,\n \"usecallingpres\": true,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 8,\n \"name\": \"Default E1 R2 Profile\",\n \"description\": \"Default E1 R2 Profile\",\n \"default\": true\n },\n {\n \"technology\": \"fxo\",\n \"signaling\": \"fxs_ks\",\n \"cidstart\": \"ring\",\n \"cidsignaling\": \"bell\",\n \"dtmfcidlevel\": 128,\n \"polarityonanswerdelay\": 600,\n \"busydetect\": false,\n \"busycount\": 8,\n \"busypattern\": null,\n \"answeronpolarityswitch\": false,\n \"hanguponpolarityswitch\": false,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 4,\n \"name\": \"Default FXO Profile\",\n \"description\": \"Default FXO Profile\",\n \"default\": true\n },\n {\n \"technology\": \"fxs\",\n \"signaling\": \"fxo_ks\",\n \"rxflash\": 650,\n \"threewaycalling\": true,\n \"transfer\": true,\n \"callwaiting\": true,\n \"mwisendtype\": \"hvac\",\n \"callwaitingcallerid\": true,\n \"sendcalleridafter\": 1,\n \"answeronpolarityswitch\": false,\n \"hanguponpolarityswitch\": false,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 3,\n \"name\": \"Default FXS Profile\",\n \"description\": \"Default FXS Profile\",\n \"default\": true\n },\n {\n \"technology\": \"iax\",\n \"host\": \"dynamic\",\n \"peertype\": \"friend\",\n \"requirecalltoken\": \"no\",\n \"qualify\": 2000,\n \"qualifyfreq\": 60,\n \"transfer\": \"yes\",\n \"profile_id\": 2,\n \"name\": \"Default IAX2 Profile\",\n \"description\": \"Default IAX2 Profile\",\n \"default\": true\n },\n {\n \"technology\": \"pjsip\",\n \"transport\": \"udp\",\n \"dtls_cert_id\": null,\n \"media_encryption\": \"no\",\n \"dtls_setup\": \"actpass\",\n \"force_rport\": true,\n \"ice_support\": false,\n \"rtp_symmetric\": true,\n \"rewrite_contact\": true,\n \"use_avpf\": false,\n \"direct_media\": true,\n \"disable_direct_media_on_nat\": false,\n \"dtls_verify\": \"no\",\n \"rtcp_mux\": false,\n \"media_use_received_transport\": false,\n \"media_encryption_optimistic\": false,\n \"asymmetric_rtp_codec\": false,\n \"dtls_fingerprint\": \"sha-256\",\n \"dtls_rekey\": 0,\n \"qualify_frequency\": 30,\n \"qualify_timeout\": 3,\n \"webrtc\": false,\n \"send_diversion\": true,\n \"send_pai\": false,\n \"send_rpid\": false,\n \"remove_existing\": true,\n \"max_video_streams\": 5,\n \"max_audio_streams\": 5,\n \"support_path\": false,\n \"outbound_proxy\": null,\n \"profile_id\": 1,\n \"name\": \"Default PJSIP Profile\",\n \"description\": \"Default PJSIP Profile\",\n \"default\": true,\n \"force_avp\": false\n },\n {\n \"technology\": \"pjsip\",\n \"transport\": \"wss\",\n \"dtls_cert_id\": null,\n \"media_encryption\": \"dtls\",\n \"dtls_setup\": \"actpass\",\n \"force_rport\": true,\n \"ice_support\": true,\n \"rtp_symmetric\": true,\n \"rewrite_contact\": false,\n \"use_avpf\": true,\n \"direct_media\": true,\n \"disable_direct_media_on_nat\": true,\n \"dtls_verify\": \"fingerprint\",\n \"rtcp_mux\": true,\n \"media_use_received_transport\": true,\n \"media_encryption_optimistic\": false,\n \"asymmetric_rtp_codec\": true,\n \"dtls_fingerprint\": \"sha-256\",\n \"dtls_rekey\": 0,\n \"qualify_frequency\": 30,\n \"qualify_timeout\": 3,\n \"webrtc\": true,\n \"send_diversion\": true,\n \"send_pai\": true,\n \"send_rpid\": true,\n \"remove_existing\": true,\n \"max_video_streams\": 5,\n \"max_audio_streams\": 5,\n \"support_path\": false,\n \"outbound_proxy\": null,\n \"profile_id\": 13,\n \"name\": \"Default WebRTC Profile\",\n \"description\": \"Default WebRTC Profile\",\n \"default\": true,\n \"force_avp\": false\n },\n {\n \"technology\": \"sip\",\n \"host\": \"dynamic\",\n \"peertype\": \"friend\",\n \"qualify\": 2000,\n \"qualifyfreq\": 60,\n \"transport\": \"udp\",\n \"icesupport\": false,\n \"encryption\": false,\n \"avpf\": false,\n \"directmedia\": \"nonat\",\n \"sendrpid\": \"yes\",\n \"trustrpid\": true,\n \"dtlsenable\": false,\n \"dtls_cert_id\": null,\n \"dtlsverify\": \"no\",\n \"dtlssetup\": \"actpass\",\n \"dtlsfingerprint\": \"sha-256\",\n \"dtlsrekey\": 0,\n \"force_avp\": false,\n \"rtcp_mux\": false,\n \"profile_id\": 11,\n \"name\": \"Default SIP Profile\",\n \"description\": \"Default SIP Profile\",\n \"default\": true\n },\n {\n \"technology\": \"t1cas\",\n \"signaling\": \"fxs_ks\",\n \"switchtype\": \"national\",\n \"inbanddisconnect\": true,\n \"facilityenable\": \"disabled\",\n \"overlapdial\": \"no\",\n \"resetinterval\": 0,\n \"pridialplan\": \"unknown\",\n \"prilocaldialplan\": \"national\",\n \"internationalprefix\": null,\n \"localprefix\": null,\n \"nationalprefix\": null,\n \"privateprefix\": null,\n \"unknownprefix\": null,\n \"usecallingpres\": true,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 10,\n \"name\": \"Default T1 CAS Profile\",\n \"description\": \"Default T1 CAS Profile\",\n \"default\": true\n },\n {\n \"technology\": \"t1pri\",\n \"signaling\": \"pri_cpe\",\n \"switchtype\": \"national\",\n \"inbanddisconnect\": true,\n \"facilityenable\": \"enabled\",\n \"overlapdial\": \"no\",\n \"resetinterval\": 0,\n \"pridialplan\": \"unknown\",\n \"prilocaldialplan\": \"national\",\n \"internationalprefix\": null,\n \"localprefix\": null,\n \"nationalprefix\": null,\n \"privateprefix\": null,\n \"unknownprefix\": null,\n \"usecallingpres\": true,\n \"rxgain\": \"0.000\",\n \"txgain\": \"0.000\",\n \"echocanceler\": \"oslec\",\n \"echocancel\": \"128\",\n \"echotraining\": 0,\n \"echocancelwhenbridged\": true,\n \"echoparams\": \"\",\n \"usecallerid\": true,\n \"hidecallerid\": false,\n \"relaxdtmf\": false,\n \"faxdetect\": \"no\",\n \"profile_id\": 9,\n \"name\": \"Default T1 PRI Profile\",\n \"description\": \"Default T1 PRI Profile\",\n \"default\": true\n }\n ]\n}"}],"_postman_id":"3d44ad92-dc10-4a88-9287-539131b4b90c"},{"name":"/devices_profiles/{id}","id":"83db6127-645d-41ee-a062-4676e1a4c468","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://{{host}}/api/v2/device_profiles/1","description":"

Retrieve a specific device profile

Retrieve all the devices associated to an specific profile

Retrieve all the PJSIP profile marked as webrtc

It containts all the available requests for the module \"Device Profiles\".

\n","event":[{"listen":"prerequest","script":{"id":"17a16931-8325-47ab-aa15-1a3b9b8892b8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b32892cb-f1d3-421e-8dac-0da475e07699","type":"text/javascript","exec":[""]}}],"_postman_id":"db7b72bd-74cb-4f4b-a239-d2451103d0a3","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"VitXi","item":[{"name":"/vitxi/license/{device}","id":"4774d4f0-39e4-4937-b8e5-d0116e7087f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"app-key","value":"{{vitxi-key}}","type":"text"}],"url":"http://{{host}}/api/v2/vitxi/license/10000","description":"

It retrieves information to validate if the premium features must be enable for the current account.

\n","urlObject":{"protocol":"http","path":["api","v2","vitxi","license","10000"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"06baadca-6261-4fc8-a67c-034b76e839ef","name":"404 - Device Not Found","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{vitxi-key}}","type":"text"}],"url":"http://{{host}}/api/v2/vitxi/license/1111"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jul 2020 03:57:25 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.32"},{"key":"X-Powered-By","value":"PHP/7.2.32"},{"key":"Content-Length","value":"75"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"not_found\",\n \"message\": \"The device 1111 doesn't exists\",\n \"data\": []\n}"},{"id":"a4030431-3f78-4d2a-abb5-b67fe555c94b","name":"200 - License Info Retrieved","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{vitxi-key}}","type":"text"}],"url":"http://{{host}}/api/v2/vitxi/license/10000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 24 Jul 2020 03:56:33 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.32"},{"key":"X-Powered-By","value":"PHP/7.2.32"},{"key":"Content-Length","value":"81"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"license\": \"URDv9NuZYJgm74XVKgs24A==\"\n }\n}"}],"_postman_id":"4774d4f0-39e4-4937-b8e5-d0116e7087f5"},{"name":"/vitxi/push/{device}","id":"2f707596-6d94-4c76-bf3d-c6eefc68f7ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"token\": 1234\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/api/v2/vitxi/push/{{device}}","description":"

It allows configuring push tokens for a specific device. Each device support a maximu of 5 push tokens.

Endpoints that can be implemented or called from VitXi mobile apps

\n","_postman_id":"be1b18ba-df2f-4f7d-8432-68500a67531a","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Virtual Faxes","item":[{"name":"/virtual_faxes","id":"c2c37390-7094-49ac-9df1-4c9911d4344d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/virtual_faxes","description":"

It retrieves all the faxes associated to the given tenant

It retrieves the configuration/information of a specific fax device.

Keep in mind that the variable {{fax-id}} represents the fax device ID.

Full URL where the PDF to be sent is located at.

\n","type":"text"},{"key":"recipients","value":"0100","description":"

List of numbers separated by comma to which the fax will be sent to.

\n","type":"text"},{"key":"resolution","value":"medium","description":"

It forces the fax resolution to use. Possible values are standard, medium, or high.

\n","type":"text"},{"key":"retries","value":"2","description":"

It allows defining the maximum number of allowed tries for sending fax after failing, not including the initial attempt.

\n","type":"text"},{"key":"retry_time","value":"300","description":"

How many seconds to wait before retry. The default is 300 (5 minutes).

\n","type":"text"}]},"url":"http://{{host}}/api/v2/virtual_faxes/{{fax-id}}/send","description":"

API endpoint for sending faxes. The file to be sent must be available online by URL.

Keep in mind that the variable {{fax-id}} represents the fax device ID.

It allows you to retrieve detailed information about a sent/received fax; This is the same information you can see on the VitalPBX's Fax Viewer module.

Set of methods to retrieve Virtual Faxes' informaion. Also, it is possible sending faxes.

\n","_postman_id":"c180927e-6394-4894-88b5-c9fa2dbd8b2f","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Route Selections","item":[{"name":"/route_selections","id":"02c50675-8bb6-4c43-84ba-c87dfc13debb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/route_selections","description":"

This endpoint returns all the route selection items filtered by tenant.

This endpoint returns a specific route selection item filtered by ID.

The route selections module allows you to group outbound routes to assign them to an existing class of service or share them with a tenant.

The route selections are also known as outbound profiles. In the calls routing tab on the tenants' module, you will see a field labeled \"Outbound Profiles;\" this field refers to the route selection items.

\n","_postman_id":"57ac85df-1389-4523-8a0c-94fd24e74f68","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Outbound Routes","item":[{"name":"/outbound_routes","id":"df62f9d5-b89b-4b1b-8596-69d88644dee3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/outbound_routes","description":"

This endpoint returns all the outbound routes items filtered by tenant.

This endpoint returns a single outbound routes item filtered by ID.

It retrieves the list of available roles filtered by tenant.

It retrieves information of a single role.

It retrieves the list of modules allowed for a specific role.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v2","roles","4","modules"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"98ae0204-64ae-4eba-849b-befe0447a4be","name":"200 - Role Modules","originalRequest":{"method":"GET","header":[],"url":"https://{{host}}/api/v2/roles/4/modules"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Aug 2021 18:01:15 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"6037"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"extensions\",\n \"display_name\": \"Extensions\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 2,\n \"name\": \"hot_desking\",\n \"display_name\": \"Hot Desking\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 4,\n \"name\": \"import_extensions\",\n \"display_name\": \"Import Extensions\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 103,\n \"name\": \"export_extensions\",\n \"display_name\": \"Export Extensions\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 5,\n \"name\": \"bulk_modification\",\n \"display_name\": \"Bulk Modification\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 152,\n \"name\": \"bulk_extensions\",\n \"display_name\": \"Bulk Extensions\",\n \"multi_tenant_capable\": false\n },\n {\n \"id\": 6,\n \"name\": \"extensions_status\",\n \"display_name\": \"Extensions Status\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 8,\n \"name\": \"conferences\",\n \"display_name\": \"Conferences\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 9,\n \"name\": \"custom_app\",\n \"display_name\": \"Custom Applications\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 10,\n \"name\": \"custom_dest\",\n \"display_name\": \"Custom Destinations\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 12,\n \"name\": \"paging\",\n \"display_name\": \"Paging & Intercom\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 93,\n \"name\": \"pickup_group\",\n \"display_name\": \"Pickup Groups\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 11,\n \"name\": \"parking\",\n \"display_name\": \"Parking\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 7,\n \"name\": \"speeddial\",\n \"display_name\": \"Speed Dialing\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 109,\n \"name\": \"import_speeddial\",\n \"display_name\": \"Import/Export Speed Dialing\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 14,\n \"name\": \"vmgroup\",\n \"display_name\": \"Voicemail Broadcast Groups\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 38,\n \"name\": \"call_back\",\n \"display_name\": \"Call Back\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 30,\n \"name\": \"disa\",\n \"display_name\": \"DISA\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 24,\n \"name\": \"pin\",\n \"display_name\": \"PIN Lists\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 15,\n \"name\": \"class_of_service\",\n \"display_name\": \"Class of Service\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 16,\n \"name\": \"feature_category\",\n \"display_name\": \"Feature Categories\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 17,\n \"name\": \"dialrules\",\n \"display_name\": \"Dialing Restriction Rules\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 18,\n \"name\": \"accountcode\",\n \"display_name\": \"Customer Codes\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 19,\n \"name\": \"authcode\",\n \"display_name\": \"Authorization Codes\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 28,\n \"name\": \"ars\",\n \"display_name\": \"Route Selections\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 20,\n \"name\": \"ring_group\",\n \"display_name\": \"Ring Groups\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 21,\n \"name\": \"queues\",\n \"display_name\": \"Queues\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 22,\n \"name\": \"queues_priority\",\n \"display_name\": \"Queue Priorities\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 23,\n \"name\": \"queues_vip\",\n \"display_name\": \"Queue VIPs\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 26,\n \"name\": \"trunks\",\n \"display_name\": \"Trunks\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 27,\n \"name\": \"trunk_group\",\n \"display_name\": \"Outbound Routes\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 29,\n \"name\": \"inbound_route\",\n \"display_name\": \"Inbound Routes\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 128,\n \"name\": \"dynamic_routing\",\n \"display_name\": \"Dynamic Routing\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 31,\n \"name\": \"ivr\",\n \"display_name\": \"IVR\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 32,\n \"name\": \"time_group\",\n \"display_name\": \"Time Groups\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 79,\n \"name\": \"time_conditions\",\n \"display_name\": \"Time Conditions\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 33,\n \"name\": \"preannoun\",\n \"display_name\": \"Announcements\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 34,\n \"name\": \"languages\",\n \"display_name\": \"Languages\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 35,\n \"name\": \"nightmode\",\n \"display_name\": \"Night Mode\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 104,\n \"name\": \"cid_management\",\n \"display_name\": \"CID Modifiers\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 116,\n \"name\": \"cid_lookup\",\n \"display_name\": \"CID Lookup\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 36,\n \"name\": \"blacklist\",\n \"display_name\": \"Blacklist\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 87,\n \"name\": \"dashboard\",\n \"display_name\": \"Dashboard\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 117,\n \"name\": \"cron_profiles\",\n \"display_name\": \"Cron Profiles\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 85,\n \"name\": \"weak_password\",\n \"display_name\": \"Weak Passwords\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 146,\n \"name\": \"phone_books\",\n \"display_name\": \"Phonebooks\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 119,\n \"name\": \"emergency_numbers\",\n \"display_name\": \"Emergency Numbers\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 138,\n \"name\": \"emergency_locations\",\n \"display_name\": \"Dispatchable Locations\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 161,\n \"name\": \"provisioning_templates\",\n \"display_name\": \"Templates\",\n \"multi_tenant_capable\": false\n },\n {\n \"id\": 162,\n \"name\": \"provisioning\",\n \"display_name\": \"Provisioning\",\n \"multi_tenant_capable\": false\n },\n {\n \"id\": 140,\n \"name\": \"fax_devices\",\n \"display_name\": \"Fax Devices\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 142,\n \"name\": \"fax_sending\",\n \"display_name\": \"Fax Sending\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 143,\n \"name\": \"fax_viewer\",\n \"display_name\": \"Fax Viewer\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 88,\n \"name\": \"cdr_filters\",\n \"display_name\": \"CDR Filters\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 41,\n \"name\": \"repcdr\",\n \"display_name\": \"CDR\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 137,\n \"name\": \"active_calls\",\n \"display_name\": \"Active Calls\",\n \"multi_tenant_capable\": false\n },\n {\n \"id\": 134,\n \"name\": \"pjsip_endpoints\",\n \"display_name\": \"PJSIP Endpoints\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 135,\n \"name\": \"sip_report\",\n \"display_name\": \"SIP Devices\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 136,\n \"name\": \"iax2_report\",\n \"display_name\": \"IAX2 Devices\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 105,\n \"name\": \"dial_profiles\",\n \"display_name\": \"Dial Profiles\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 47,\n \"name\": \"astmanager_users\",\n \"display_name\": \"Asterisk Manager Users\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 48,\n \"name\": \"music_on_hold\",\n \"display_name\": \"Music on Hold\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 49,\n \"name\": \"recmanagement\",\n \"display_name\": \"Recordings Management\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 57,\n \"name\": \"users\",\n \"display_name\": \"Users\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 58,\n \"name\": \"users_profiles\",\n \"display_name\": \"User Profiles\",\n \"multi_tenant_capable\": true\n },\n {\n \"id\": 127,\n \"name\": \"app_keys\",\n \"display_name\": \"Application Keys\",\n \"multi_tenant_capable\": false\n }\n ]\n}"}],"_postman_id":"4e5424b7-35bb-4dfd-8b49-58daf88a4980"}],"id":"24936b2b-4e20-42d9-b9bd-86a09f942939","description":"

List of endpoints to manage roles on VitalPBX.

\n","_postman_id":"24936b2b-4e20-42d9-b9bd-86a09f942939","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Users","item":[{"name":"/users","id":"8366af71-9a23-4b20-9c40-b18dad6c3cd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"https://{{host}}/api/v2/users","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v2","users"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b088ddb4-a27f-44b1-b000-bf354e69da06","name":"200 - Retrieve All Users","originalRequest":{"method":"GET","header":[],"url":"https://{{host}}/api/v2/users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Aug 2021 21:20:20 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"3372"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": [\n {\n \"id\": 1,\n \"username\": \"admin\",\n \"email\": null,\n \"displayname\": \"Administrator\",\n \"department\": \"Administration\",\n \"locale\": \"en_US\",\n \"timezone\": \"system\",\n \"startapp\": \"mini_http_server\",\n \"dark_mode\": true,\n \"portaluser\": false,\n \"multitab\": true,\n \"enabled\": true,\n \"default\": true\n },\n {\n \"id\": 2,\n \"username\": \"100\",\n \"email\": null,\n \"displayname\": \"Jose Rivera\",\n \"department\": \"Portal Users\",\n \"locale\": \"en_US\",\n \"timezone\": \"America/Managua\",\n \"startapp\": \"extension_settings\",\n \"dark_mode\": false,\n \"portaluser\": true,\n \"multitab\": true,\n \"enabled\": true,\n \"default\": false\n }\n ]\n}"}],"_postman_id":"8366af71-9a23-4b20-9c40-b18dad6c3cd8"},{"name":"/users/{id}","id":"171ec881-e080-4958-81ff-d87f0069af40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"https://{{host}}/api/v2/users/1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}},"urlObject":{"protocol":"https","path":["api","v2","users","1"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"a9a221ee-78b9-404a-a3b2-fce709fefb7f","name":"200 - Retrieve Single User","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"https://{{host}}/api/v2/users/1"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Aug 2021 22:53:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"292"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": null,\n \"data\": {\n \"id\": 1,\n \"username\": \"admin\",\n \"email\": null,\n \"displayname\": \"Administrator\",\n \"department\": \"Administration\",\n \"locale\": \"en_US\",\n \"timezone\": \"system\",\n \"startapp\": \"mini_http_server\",\n \"dark_mode\": true,\n \"portaluser\": false,\n \"multitab\": true,\n \"enabled\": true,\n \"default\": true\n }\n}"},{"id":"4783a359-a9ea-4a8a-aa89-2cb8226b0bb0","name":"404 - User Not Found","originalRequest":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"https://{{host}}/api/v2/users/99"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 13 Aug 2021 22:55:07 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.2.33"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubDomains"},{"key":"X-Powered-By","value":"PHP/7.2.33"},{"key":"Content-Length","value":"77"},{"key":"Connection","value":"close"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"not_found\",\n \"message\": \"The requested user doesn't exist\",\n \"data\": []\n}"}],"_postman_id":"171ec881-e080-4958-81ff-d87f0069af40"},{"name":"/users?email={email}","id":"30ebaa32-cf4c-48f3-b654-8dc52222aa72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"https://{{host}}/api/v2/users?email={{email}}","description":"

Endpoint for finding VitalPBX's user by e-mail address.

Endpoint for finding VitalPBX's user by username.

Endpoints to manage VitalPBX's users

\n","_postman_id":"97914362-2519-4089-858d-58162eb43a40","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"app-key"},{"key":"value","value":"{{api-key}}"}]},"isInherited":true,"source":{"_postman_id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","id":"b27fada8-1837-592e-2b4b-1b56f26ae4d8","name":"VitalPBX","type":"collection"}}},{"name":"Destinations","item":[{"name":"/destinations","id":"33386411-b55e-4934-b8d2-e73f0ef3a7b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"app-key","value":"{{api-key}}","type":"text"},{"key":"tenant","value":"{{tenant}}","type":"text"}],"url":"http://{{host}}/api/v2/destinations","description":"

It returns all the destinations categories available on the PBX.

It returns the available destinations for a specific destination category.