{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "dashboard.url.net.au" } ], "info": { "name": "API | URL Networks", "_postman_id": "cf35aacd-05ab-4660-a244-99e7cff702cf", "description": "URL Networks API", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Billing", "description": "", "item": [ { "name": "Outgoing Call Charges.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/billing\/calls\/outgoing\/:start_date\/:end_date", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/billing\/calls\/outgoing\/:start_date\/:end_date", "variable": [ { "id": "start_date", "key": "start_date", "value": "2017-01-01+00%3A00%3A00", "description": "Start date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." }, { "id": "end_date", "key": "end_date", "value": "2017-06-01+00%3A00%3A00", "description": "End date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all outgoing call charges for the service the API is using." }, "response": [ { "name": "Outgoing Call Charges. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/billing\/calls\/outgoing\/:start_date\/:end_date", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/billing\/calls\/outgoing\/:start_date\/:end_date", "variable": [ { "id": "start_date", "key": "start_date", "value": "2017-01-01+00%3A00%3A00", "description": "Start date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." }, { "id": "end_date", "key": "end_date", "value": "2017-06-01+00%3A00%3A00", "description": "End date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all outgoing call charges for the service the API is using." }, "header": null, "cookie": [], "body": "[\n {\n \"unique_id\": 1001,\n \"service_id\": 100,\n \"external_did\": null,\n \"from\": \"61312345678\",\n \"to\": \"61398765432\",\n \"charge\": 0.25,\n \"start_time\": \"2017-01-01 09:00:00\",\n \"end_time\": \"2017-01-01 09:05:00\",\n \"seconds\": 300,\n \"auth_code\": null,\n \"hangup_cause\": \"NORMAL_CLEARING\",\n \"on_net\": 0,\n \"call_rate_prefix\": \"61\",\n \"call_rate_name\": \"Australia Mobile\",\n \"transferred_call\": false,\n \"uuid\": \"c1f2e3d4-0000-0000-0000-000000000000\",\n \"parent_uuid\": null\n }\n]" } ] }, { "name": "Collection Charges.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/billing\/calls\/collection\/:start_date\/:end_date", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/billing\/calls\/collection\/:start_date\/:end_date", "variable": [ { "id": "start_date", "key": "start_date", "value": "2017-01-01+00%3A00%3A00", "description": "Start date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." }, { "id": "end_date", "key": "end_date", "value": "2017-06-01+00%3A00%3A00", "description": "End date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all collection call charges for a service id." }, "response": [ { "name": "Collection Charges. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/billing\/calls\/collection\/:start_date\/:end_date", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/billing\/calls\/collection\/:start_date\/:end_date", "variable": [ { "id": "start_date", "key": "start_date", "value": "2017-01-01+00%3A00%3A00", "description": "Start date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." }, { "id": "end_date", "key": "end_date", "value": "2017-06-01+00%3A00%3A00", "description": "End date for the records YYYY-MM-DD HH:MM:SS (urlencoded)." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all collection call charges for a service id." }, "header": null, "cookie": [], "body": "[\n {\n \"unique_id\": 1001,\n \"service_id\": 100,\n \"external_did\": null,\n \"from\": \"61312345678\",\n \"to\": \"61398765432\",\n \"charge\": 0.15,\n \"start_time\": \"2017-01-01 09:00:00\",\n \"end_time\": \"2017-01-01 09:05:00\",\n \"seconds\": 300,\n \"auth_code\": null,\n \"hangup_cause\": \"NORMAL_CLEARING\",\n \"on_net\": 0,\n \"call_rate_prefix\": \"613\",\n \"call_rate_name\": \"Australia Local\"\n }\n]" } ] } ] }, { "name": "Order Numbers", "description": "", "item": [ { "name": "List localities.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/locality\/:country_iso", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/locality\/:country_iso", "variable": [ { "id": "country_iso", "key": "country_iso", "value": "AU", "description": "Two letter Country ISO code." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all available localities." }, "response": [ { "name": "List localities. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/locality\/:country_iso", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/locality\/:country_iso", "variable": [ { "id": "country_iso", "key": "country_iso", "value": "AU", "description": "Two letter Country ISO code." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all available localities." }, "header": null, "cookie": [], "body": "{\n \"locality\": \"Melbourne (03)\",\n \"prefix\": 3\n}" } ] }, { "name": "List Numbers.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/numbers\/:country_iso\/:locality_id", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/numbers\/:country_iso\/:locality_id", "variable": [ { "id": "country_iso", "key": "country_iso", "value": "AU", "description": "Two letter Country ISO code." }, { "id": "locality_id", "key": "locality_id", "value": "Melbourne+%2803%29", "description": "The locality in which you want to list numbers." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all available numbers." }, "response": [ { "name": "List Numbers. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/numbers\/:country_iso\/:locality_id", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/numbers\/:country_iso\/:locality_id", "variable": [ { "id": "country_iso", "key": "country_iso", "value": "AU", "description": "Two letter Country ISO code." }, { "id": "locality_id", "key": "locality_id", "value": "Melbourne+%2803%29", "description": "The locality in which you want to list numbers." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "List all available numbers." }, "header": null, "cookie": [], "body": "[\n {\n \"locality\": \"Melbourne\",\n \"country\": \"Australia\",\n \"country_iso\": \"AU\",\n \"country_prefix\": 61,\n \"locality_prefix\": 3,\n \"number\": 61311112002,\n \"pool\": \"local\"\n },\n {\n \"locality\": \"Melbourne\",\n \"country\": \"Australia\",\n \"country_iso\": \"AU\",\n \"country_prefix\": 61,\n \"locality_prefix\": 3,\n \"number\": 61311112005,\n \"pool\": \"local\"\n }\n]" } ] }, { "name": "Assign Number.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/assign", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/assign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"number_id\": \"sapiente\",\n \"supply_uuid\": \"vel\",\n \"number\": 6131231234\n}" }, "description": "Assign a number to the service." }, "response": [ { "name": "Assign Number. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/assign", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/assign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"number_id\": \"sapiente\",\n \"supply_uuid\": \"vel\",\n \"number\": 6131231234\n}" }, "description": "Assign a number to the service." }, "header": null, "cookie": [], "body": "{\n \"error\": \"0\",\n \"message\": \"6131231234 has been assigned\"\n}" }, { "name": "Assign Number. Response #2", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/assign", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/assign" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"number_id\": \"sapiente\",\n \"supply_uuid\": \"vel\",\n \"number\": 6131231234\n}" }, "description": "Assign a number to the service." }, "header": null, "cookie": [], "body": "{\n \"error\": \"1\",\n \"message\": \"Unable to assign the requested number\"\n}" } ] }, { "name": "Cancel Number.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/cancel\/:number", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/cancel\/:number", "variable": [ { "id": "number", "key": "number", "value": "6131231234", "description": "The requested number to cancel." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Cancels the specified number. Once the number is removed there is no guarantee we can recover the number if you change your mind." }, "response": [ { "name": "Cancel Number. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/order-numbers\/cancel\/:number", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/order-numbers\/cancel\/:number", "variable": [ { "id": "number", "key": "number", "value": "6131231234", "description": "The requested number to cancel." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Cancels the specified number. Once the number is removed there is no guarantee we can recover the number if you change your mind." }, "header": null, "cookie": [], "body": "{\n \"error\": \"0\",\n \"message\": \"6131231234 has been canceled\"\n}" } ] } ] }, { "name": "Originate", "description": "", "item": [ { "name": "Call to External Number.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/originate\/call-connect", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/originate\/call-connect" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone_number\": 61412341234,\n \"caller_id\": 61312341234,\n \"dialplan_number\": 9999\n}" }, "description": "" }, "response": [ { "name": "Call to External Number. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/originate\/call-connect", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/originate\/call-connect" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"phone_number\": 61412341234,\n \"caller_id\": 61312341234,\n \"dialplan_number\": 9999\n}" }, "description": "" }, "header": null, "cookie": [], "body": "{\n \"status\": \"ok\",\n \"message\": \"Call Connected\"\n}" } ] } ] }, { "name": "PBX Action Toggles", "description": "", "item": [ { "name": "List Action Toggles.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "List Action Toggles. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "[\n {\n \"id\": 219,\n \"name\": \"Test\",\n \"status\": true\n }\n]" } ] }, { "name": "Create a new action-toggle.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"quam\",\n \"status\": true\n}" }, "description": "Create a new action-toggle for your service." }, "response": [ { "name": "Create a new action-toggle. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"quam\",\n \"status\": true\n}" }, "description": "Create a new action-toggle for your service." }, "header": null, "cookie": [], "body": "{\n \"id\": 219\n}" } ] }, { "name": "Show Action Toggle.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles\/:action_toggle", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles\/:action_toggle", "variable": [ { "id": "action_toggle", "key": "action_toggle", "value": "219", "description": "The unique action-toggle id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single action-toggle by id." }, "response": [ { "name": "Show Action Toggle. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles\/:action_toggle", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles\/:action_toggle", "variable": [ { "id": "action_toggle", "key": "action_toggle", "value": "219", "description": "The unique action-toggle id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single action-toggle by id." }, "header": null, "cookie": [], "body": "{\n \"id\": 219,\n \"name\": \"Test\",\n \"status\": true\n}" } ] }, { "name": "Update a Action Toggle.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles\/:action_toggle", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles\/:action_toggle", "variable": [ { "id": "action_toggle", "key": "action_toggle", "value": "219", "description": "The unique action-toggle id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cum\",\n \"status\": true\n}" }, "description": "Update a single action-toggle by the ID." }, "response": [ { "name": "Update a Action Toggle. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles\/:action_toggle", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles\/:action_toggle", "variable": [ { "id": "action_toggle", "key": "action_toggle", "value": "219", "description": "The unique action-toggle id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"cum\",\n \"status\": true\n}" }, "description": "Update a single action-toggle by the ID." }, "header": null, "cookie": [], "body": "{\n \"id\": 219,\n \"name\": \"Test\",\n \"status\": true\n}" } ] }, { "name": "Delete Action Toggle.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles\/:action_toggle", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles\/:action_toggle", "variable": [ { "id": "action_toggle", "key": "action_toggle", "value": "219", "description": "The unique action-toggle id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected action toggle." }, "response": [ { "name": "Delete Action Toggle. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/action-toggles\/:action_toggle", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/action-toggles\/:action_toggle", "variable": [ { "id": "action_toggle", "key": "action_toggle", "value": "219", "description": "The unique action-toggle id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected action toggle." }, "header": null, "cookie": [], "body": "{\n \"status\": \"success\"\n}" } ] } ] }, { "name": "PBX Call Recordings", "description": "", "item": [ { "name": "List Call Recordings.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/call-recordings", "query": [ { "key": "time_period", "value": "qui", "description": "You can use today, yesterday, this_month or last_month to poll the records instead of using start_time and end_time.", "disabled": false }, { "key": "start_time", "value": "1496956949", "description": "In EPOCH the start time of the query.", "disabled": false }, { "key": "end_time", "value": "1496956949", "description": "In EPOCH the end time of the query - please note the end time should not be greater than one month from the start time.", "disabled": false } ], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/call-recordings?time_period=qui&start_time=1496956949&end_time=1496956949" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the call recordings present in your service." }, "response": [ { "name": "List Call Recordings. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/call-recordings", "query": [ { "key": "time_period", "value": "qui", "description": "You can use today, yesterday, this_month or last_month to poll the records instead of using start_time and end_time.", "disabled": false }, { "key": "start_time", "value": "1496956949", "description": "In EPOCH the start time of the query.", "disabled": false }, { "key": "end_time", "value": "1496956949", "description": "In EPOCH the end time of the query - please note the end time should not be greater than one month from the start time.", "disabled": false } ], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/call-recordings?time_period=qui&start_time=1496956949&end_time=1496956949" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the call recordings present in your service." }, "header": null, "cookie": [], "body": "[\n {\n \"time\": 1642122054,\n \"uuid\": \"6001b223-5713-4c0a-90ea-11090fec9e11\",\n \"caller_id\": \"61812341234\",\n \"destination\": \"61312341234\",\n \"duration\": 112,\n \"wav_size\": 3585422,\n \"mp3_size\": 1793805,\n \"notes\": null,\n \"call_outcome\": null,\n \"stream_url\": \"https:\\\/\\\/dashboard.url.net.au\\\/streams\\\/recording\\\/6b076246-2945-4ed5-99f5-8cfef707a9b8\\\/1234\"\n }\n]" } ] } ] }, { "name": "PBX Call Transcripts", "description": "", "item": [ { "name": "Download VTT File.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/call-transcripts\/download-vtt\/:transcript_id", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/call-transcripts\/download-vtt\/:transcript_id", "variable": [ { "id": "transcript_id", "key": "transcript_id", "value": "45", "description": "The unique ID of the transcript record." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Downloads the VTT transcript file for a call from S3. Returns the raw VTT file content (text\/vtt) as a download." }, "response": [] }, { "name": "List Call Transcripts.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/call-transcripts", "query": [ { "key": "time_period", "value": "this_month", "description": "You can use today, yesterday, this_month or last_month to poll the records instead of using start_time and end_time.", "disabled": false }, { "key": "timezone", "value": "Australia%2FSydney", "description": "The timezone used when evaluating time_period.", "disabled": false }, { "key": "start_time", "value": "1496956949", "description": "In EPOCH the start time of the query.", "disabled": false }, { "key": "end_time", "value": "2", "description": "In EPOCH the end time of the query - please note the end time should not be greater than one month from the start time.", "disabled": false } ], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/call-transcripts?time_period=this_month&timezone=Australia%2FSydney&start_time=1496956949&end_time=2" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the call transcripts present in your service." }, "response": [ { "name": "List Call Transcripts. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/call-transcripts", "query": [ { "key": "time_period", "value": "this_month", "description": "You can use today, yesterday, this_month or last_month to poll the records instead of using start_time and end_time.", "disabled": false }, { "key": "timezone", "value": "Australia%2FSydney", "description": "The timezone used when evaluating time_period.", "disabled": false }, { "key": "start_time", "value": "1496956949", "description": "In EPOCH the start time of the query.", "disabled": false }, { "key": "end_time", "value": "2", "description": "In EPOCH the end time of the query - please note the end time should not be greater than one month from the start time.", "disabled": false } ], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/call-transcripts?time_period=this_month&timezone=Australia%2FSydney&start_time=1496956949&end_time=2" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the call transcripts present in your service." }, "header": null, "cookie": [], "body": "[\n {\n \"transcript_id\": 1,\n \"call_recording_id\": 5001,\n \"service_id\": 100,\n \"keywords\": \"billing, refund\",\n \"summary\": \"Customer called about a billing discrepancy and was issued a refund.\",\n \"caller_id\": \"61812341234\",\n \"destination\": \"61312341234\",\n \"duration\": 112,\n \"names_involved\": \"Jane Smith\",\n \"sentiment\": \"positive\",\n \"call_outcome\": \"resolved\",\n \"vtt_url\": \"https:\\\/\\\/dashboard.url.net.au\\\/api\\\/v1\\\/pbx\\\/call-transcripts\\\/download-vtt\\\/1\",\n \"recording_url\": \"https:\\\/\\\/dashboard.url.net.au\\\/streams\\\/recording\\\/6b076246-2945-4ed5-99f5-8cfef707a9b8\\\/1234\"\n }\n]" } ] } ] }, { "name": "PBX Extensions", "description": "", "item": [ { "name": "List Extensions.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "List Extensions. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "[\n {\n \"id\": 219,\n \"user_id\": \"1001\",\n \"name\": \"Jane Smith\",\n \"customer_location_id\": 38,\n \"emergency_dial_number\": \"000\",\n \"caller_id\": null,\n \"area_code\": \"613\",\n \"storage_hold_music_id\": 1,\n \"timezone\": \"Australia\\\/Melbourne\",\n \"voicemail\": 0,\n \"vm_password\": \"1212\",\n \"vm_no_pin\": 0,\n \"vm_delay\": 15,\n \"vm_set_read\": 0,\n \"outbound_recording\": null,\n \"whisper_announcement_id\": null,\n \"ndlb\": null,\n \"network\": null,\n \"netmask\": null,\n \"agent_mode\": 0,\n \"agent_status\": null,\n \"agent_wrap_time\": null,\n \"agent_call_timeout\": null,\n \"agent_busy_delay_time\": null,\n \"internal_alert_info\": null,\n \"group_name\": \"Default\",\n \"agent_uuid\": null,\n \"tolls\": [],\n \"voicemail_emails\": []\n }\n]" } ] }, { "name": "Create a new extension.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ab\",\n \"area_code\": 15,\n \"timezone\": \"Australia\\\/Melbourne\",\n \"voicemail\": true,\n \"vm_password\": 4,\n \"vm_delay\": 6,\n \"customer_location_id\": 14,\n \"emergency_dial_number\": 5,\n \"caller_id\": 12,\n \"password\": \"nostrum\",\n \"user_id\": 1001,\n \"storage_hold_music_id\": 4,\n \"voicemail_emails\": [\n \"dicta\",\n \"blanditiis\"\n ],\n \"vm_no_pin\": true,\n \"vm_set_read\": false,\n \"outbound_recording\": true,\n \"whisper_announcement_id\": 3,\n \"ndlb\": false,\n \"network\": \"explicabo\",\n \"netmask\": \"255.255.255.255\",\n \"agent_mode\": false,\n \"agent_status\": \"molestiae\",\n \"agent_wrap_time\": 11,\n \"agent_call_timeout\": 16,\n \"agent_busy_delay_time\": 19,\n \"internal_alert_info\": \"ad\",\n \"group_name\": \"ipsa\",\n \"tolls\": [\n \"vitae\",\n \"error\"\n ]\n}" }, "description": "Create a new extension for your service." }, "response": [ { "name": "Create a new extension. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"ab\",\n \"area_code\": 15,\n \"timezone\": \"Australia\\\/Melbourne\",\n \"voicemail\": true,\n \"vm_password\": 4,\n \"vm_delay\": 6,\n \"customer_location_id\": 14,\n \"emergency_dial_number\": 5,\n \"caller_id\": 12,\n \"password\": \"nostrum\",\n \"user_id\": 1001,\n \"storage_hold_music_id\": 4,\n \"voicemail_emails\": [\n \"dicta\",\n \"blanditiis\"\n ],\n \"vm_no_pin\": true,\n \"vm_set_read\": false,\n \"outbound_recording\": true,\n \"whisper_announcement_id\": 3,\n \"ndlb\": false,\n \"network\": \"explicabo\",\n \"netmask\": \"255.255.255.255\",\n \"agent_mode\": false,\n \"agent_status\": \"molestiae\",\n \"agent_wrap_time\": 11,\n \"agent_call_timeout\": 16,\n \"agent_busy_delay_time\": 19,\n \"internal_alert_info\": \"ad\",\n \"group_name\": \"ipsa\",\n \"tolls\": [\n \"vitae\",\n \"error\"\n ]\n}" }, "description": "Create a new extension for your service." }, "header": null, "cookie": [], "body": "{\n \"extension_id\": 219\n}" } ] }, { "name": "Show Extension.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions\/:extension", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions\/:extension", "variable": [ { "id": "extension", "key": "extension", "value": "219", "description": "The unique extension id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single extension by id." }, "response": [ { "name": "Show Extension. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions\/:extension", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions\/:extension", "variable": [ { "id": "extension", "key": "extension", "value": "219", "description": "The unique extension id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single extension by id." }, "header": null, "cookie": [], "body": "{\n \"id\": 219,\n \"user_id\": \"1999\",\n \"name\": \"Test\",\n \"customer_location_id\": 38,\n \"emergency_dial_number\": \"000\",\n \"caller_id\": null,\n \"area_code\": \"613\",\n \"storage_hold_music_id\": null,\n \"timezone\": \"Australia\\\/Melbourne\",\n \"voicemail\": 0,\n \"vm_password\": \"1212\",\n \"vm_no_pin\": 0,\n \"vm_delay\": 15,\n \"vm_set_read\": 0,\n \"outbound_recording\": null,\n \"whisper_announcement_id\": null,\n \"ndlb\": null,\n \"network\": null,\n \"netmask\": null,\n \"agent_mode\": 0,\n \"agent_status\": null,\n \"agent_wrap_time\": null,\n \"agent_call_timeout\": null,\n \"agent_busy_delay_time\": null,\n \"internal_alert_info\": null,\n \"group_name\": \"Default\",\n \"tolls\": [],\n \"voicemail_emails\": []\n}" } ] }, { "name": "Update an Extension.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions\/:extension", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions\/:extension", "variable": [ { "id": "extension", "key": "extension", "value": "219", "description": "The unique extension id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": 1001,\n \"name\": \"excepturi\",\n \"customer_location_id\": 15,\n \"emergency_dial_number\": 2,\n \"caller_id\": 12,\n \"area_code\": 16,\n \"storage_hold_music_id\": 13,\n \"timezone\": \"Australia\\\/Melbourne\",\n \"voicemail\": false,\n \"voicemail_emails\": [\n \"voluptatem\",\n \"repellat\"\n ],\n \"vm_password\": 12,\n \"vm_no_pin\": false,\n \"vm_delay\": 5,\n \"vm_set_read\": true,\n \"outbound_recording\": false,\n \"whisper_announcement_id\": 2,\n \"ndlb\": true,\n \"network\": \"assumenda\",\n \"netmask\": \"255.255.255.255\",\n \"agent_mode\": true,\n \"agent_status\": \"eum\",\n \"agent_wrap_time\": 5,\n \"agent_call_timeout\": 15,\n \"agent_busy_delay_time\": 13,\n \"internal_alert_info\": \"commodi\",\n \"group_name\": \"eius\",\n \"tolls\": [\n \"dolores\",\n \"amet\"\n ]\n}" }, "description": "Update a single extension by the ID." }, "response": [ { "name": "Update an Extension. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions\/:extension", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions\/:extension", "variable": [ { "id": "extension", "key": "extension", "value": "219", "description": "The unique extension id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"user_id\": 1001,\n \"name\": \"excepturi\",\n \"customer_location_id\": 15,\n \"emergency_dial_number\": 2,\n \"caller_id\": 12,\n \"area_code\": 16,\n \"storage_hold_music_id\": 13,\n \"timezone\": \"Australia\\\/Melbourne\",\n \"voicemail\": false,\n \"voicemail_emails\": [\n \"voluptatem\",\n \"repellat\"\n ],\n \"vm_password\": 12,\n \"vm_no_pin\": false,\n \"vm_delay\": 5,\n \"vm_set_read\": true,\n \"outbound_recording\": false,\n \"whisper_announcement_id\": 2,\n \"ndlb\": true,\n \"network\": \"assumenda\",\n \"netmask\": \"255.255.255.255\",\n \"agent_mode\": true,\n \"agent_status\": \"eum\",\n \"agent_wrap_time\": 5,\n \"agent_call_timeout\": 15,\n \"agent_busy_delay_time\": 13,\n \"internal_alert_info\": \"commodi\",\n \"group_name\": \"eius\",\n \"tolls\": [\n \"dolores\",\n \"amet\"\n ]\n}" }, "description": "Update a single extension by the ID." }, "header": null, "cookie": [], "body": "{\n \"extension_id\": 219\n}" } ] }, { "name": "Delete Extension.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions\/:extension", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions\/:extension", "variable": [ { "id": "extension", "key": "extension", "value": "219", "description": "The unique extension id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected extension." }, "response": [ { "name": "Delete Extension. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/extensions\/:extension", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/extensions\/:extension", "variable": [ { "id": "extension", "key": "extension", "value": "219", "description": "The unique extension id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected extension." }, "header": null, "cookie": [], "body": "{\n \"status\": \"success\"\n}" } ] } ] }, { "name": "PBX Phonebook", "description": "", "item": [ { "name": "List Phonebooks.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "List Phonebooks. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "[\n {\n \"id\": 219,\n \"name\": \"Melbourne\"\n }\n]" } ] }, { "name": "Create a new phonebook.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"eum\"\n}" }, "description": "Create a new phonebook for your service." }, "response": [ { "name": "Create a new phonebook. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"eum\"\n}" }, "description": "Create a new phonebook for your service." }, "header": null, "cookie": [], "body": "{\n \"id\": 219\n}" } ] }, { "name": "Show Phonebook.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook", "variable": [ { "id": "phonebook", "key": "phonebook", "value": "219", "description": "The unique phonebook id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single phonebook by id." }, "response": [ { "name": "Show Phonebook. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook", "variable": [ { "id": "phonebook", "key": "phonebook", "value": "219", "description": "The unique phonebook id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single phonebook by id." }, "header": null, "cookie": [], "body": "{\n \"id\": 219,\n \"name\": \"Test\"\n}" } ] }, { "name": "Update a Phonebook.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook", "variable": [ { "id": "phonebook", "key": "phonebook", "value": "219", "description": "The unique phonebook id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"a\"\n}" }, "description": "Update a single phonebook by the ID." }, "response": [ { "name": "Update a Phonebook. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook", "variable": [ { "id": "phonebook", "key": "phonebook", "value": "219", "description": "The unique phonebook id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"a\"\n}" }, "description": "Update a single phonebook by the ID." }, "header": null, "cookie": [], "body": "\"The Phonebook named was changed to Test\"" } ] }, { "name": "Delete Phonebook.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook", "variable": [ { "id": "phonebook", "key": "phonebook", "value": "219", "description": "The unique phonebook id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected phonebook." }, "response": [ { "name": "Delete Phonebook. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook", "variable": [ { "id": "phonebook", "key": "phonebook", "value": "219", "description": "The unique phonebook id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected phonebook." }, "header": null, "cookie": [], "body": "{\n \"status\": \"success\"\n}" } ] } ] }, { "name": "PBX Phonebook Items", "description": "", "item": [ { "name": "List Phonebook Items.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "response": [ { "name": "List Phonebook Items. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "" }, "header": null, "cookie": [], "body": "[\n {\n \"id\": 219,\n \"name\": \"Jane Smith\",\n \"office\": \"1234567890\",\n \"office2\": null,\n \"mobile\": null,\n \"home\": null,\n \"other\": null\n }\n]" } ] }, { "name": "Create a new phonebook item.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"voluptatem\",\n \"office\": \"saepe\",\n \"office2\": \"quia\",\n \"mobile\": \"asperiores\",\n \"home\": \"eaque\",\n \"other\": \"cumque\"\n}" }, "description": "Create a new phonebook item for your phonebook." }, "response": [ { "name": "Create a new phonebook item. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"voluptatem\",\n \"office\": \"saepe\",\n \"office2\": \"quia\",\n \"mobile\": \"asperiores\",\n \"home\": \"eaque\",\n \"other\": \"cumque\"\n}" }, "description": "Create a new phonebook item for your phonebook." }, "header": null, "cookie": [], "body": "{\n \"id\": 219\n}" } ] }, { "name": "Show Phonebook Item.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." }, { "id": "item", "key": "item", "value": "219", "description": "The unique phonebook item id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single phonebook item entry by id." }, "response": [ { "name": "Show Phonebook Item. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." }, { "id": "item", "key": "item", "value": "219", "description": "The unique phonebook item id." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Get single phonebook item entry by id." }, "header": null, "cookie": [], "body": "{\n \"id\": 219,\n \"name\": \"Test\",\n \"office\": \"1234567890\",\n \"office2\": null,\n \"mobile\": null,\n \"home\": null,\n \"other\": null\n}" } ] }, { "name": "Update a Phonebook Item.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." }, { "id": "item", "key": "item", "value": "219", "description": "The unique phonebook item id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"quo\",\n \"office\": \"et\",\n \"office2\": \"pariatur\",\n \"mobile\": \"iure\",\n \"home\": \"consequatur\",\n \"other\": \"repudiandae\"\n}" }, "description": "Update a single phonebook item by the ID." }, "response": [ { "name": "Update a Phonebook Item. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." }, { "id": "item", "key": "item", "value": "219", "description": "The unique phonebook item id." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"quo\",\n \"office\": \"et\",\n \"office2\": \"pariatur\",\n \"mobile\": \"iure\",\n \"home\": \"consequatur\",\n \"other\": \"repudiandae\"\n}" }, "description": "Update a single phonebook item by the ID." }, "header": null, "cookie": [], "body": "{\n \"status\": \"success\",\n \"id\": \"219\"\n}" } ] }, { "name": "Delete Phonebook Item.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." }, { "id": "item", "key": "item", "value": "219", "description": "The unique phonebook item id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected phonebook item." }, "response": [ { "name": "Delete Phonebook Item. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/phonebook\/:phonebook_id\/items\/:item", "variable": [ { "id": "phonebook_id", "key": "phonebook_id", "value": "219", "description": "The id of the phonebook, see PBX Phonebook for more information." }, { "id": "item", "key": "item", "value": "219", "description": "The unique phonebook item id." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Deletes the selected phonebook item." }, "header": null, "cookie": [], "body": "{\n \"status\": \"success\"\n}" } ] } ] }, { "name": "PBX Registrations", "description": "", "item": [ { "name": "List Registrations.", "request": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/registrations", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/registrations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the current registrations." }, "response": [ { "name": "List Registrations. Response #1", "originalRequest": { "url": { "protocol": "https", "host": "{{baseUrl}}", "path": "api\/v1\/pbx\/registrations", "query": [], "raw": "https:\/\/{{baseUrl}}\/api\/v1\/pbx\/registrations" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Lists the current registrations." }, "header": null, "cookie": [], "body": "{\n \"1000\": [\n {\n \"user_id\": \"1000\",\n \"expiry\": \"158\",\n \"protocol\": \"UDP\",\n \"external_ipaddress\": \"192.168.88.12\",\n \"external_port\": \"5060\",\n \"internal_ipaddress\": \"192.168.88.12\",\n \"contact_short\": \"1000