{ "opencollection": "1.0.0", "info": { "name": "Alianza Public API", "version": "2" }, "items": [ { "info": { "name": "Address", "type": "folder" }, "items": [ { "info": { "name": "Validates a address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/address/validate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "address", "value": "", "type": "query", "description": "Address to parse" }, { "name": "country", "value": "", "type": "query", "description": "Valid country (current values are USA and CAN" }, { "name": "postalCode", "value": "", "type": "query", "description": "Postal / Zip code of address" } ] }, "docs": "Use to validate a address" }, { "info": { "name": "Retrieves a list of addresses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/address/typeahead", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "address", "value": "", "type": "query", "description": "Address to parse" }, { "name": "country", "value": "", "type": "query", "description": "Valid country (current values are USA and CAN" }, { "name": "postalCode", "value": "", "type": "query", "description": "Postal / Zip code of address" } ] }, "docs": "Use to retrieve a single account" }, { "info": { "name": "Retrieves a Set of ZipcodeX objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/address/state/:state/city/:city/zipcode", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "city", "value": "", "type": "path" }, { "name": "state", "value": "", "type": "path" } ] }, "docs": "Use to retrieve a zipcodes" } ] }, { "info": { "name": "Authorize", "type": "folder" }, "items": [ { "info": { "name": "User Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/authorize/userinfo", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Return user information for a given token in the header" }, { "info": { "name": "Log out a user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/authorize/logout", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Log out user for the given token in the header" }, { "info": { "name": "Login with token", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/authorize/jwt" }, "docs": "Takes a jwt and returns login token if successfully validates. For validating a jwt, Alianza needs your public key, please contact your account manager." }, { "info": { "name": "Login with login credentials", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/authorize" }, "docs": "Takes login credentials and returns token if successfully validates " }, { "info": { "name": "Update password", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/authorize" }, "docs": "Used to update an existing password" } ] }, { "info": { "name": "SSO", "type": "folder" }, "items": [ { "info": { "name": "Get SSO data", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/authorize/sso" }, "docs": "Returns data needed for the UI to initiate Single Sign On" }, { "info": { "name": "Authorization Code Exchange", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/authorize/sso", "params": [ { "name": "code", "value": "", "type": "query" }, { "name": "redirect_uri", "value": "", "type": "query" } ] }, "docs": "Pass the SSO response authorization code here to exchange it for a api authorization token" } ] }, { "info": { "name": "Language Reference", "type": "folder" }, "items": [ { "info": { "name": "getLanguageFromHeader", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/language" } } ] }, { "info": { "name": "Supported Rate Centers by Alianza and specified carrier", "type": "folder" }, "items": [ { "info": { "name": "Get carrier-supported rate centers by proximity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/supported-rate-centers", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "latitude", "value": "", "type": "query" }, { "name": "longitude", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" }, { "name": "maxResults", "value": "", "type": "query" }, { "name": "distanceUnit", "value": "", "type": "query" }, { "name": "busOrgId", "value": "", "type": "query" } ] }, "docs": "Get carrier-supported rate centers by proximity" } ] }, { "info": { "name": "Asynchronous JOB Tracker", "type": "folder" }, "items": [ { "info": { "name": "Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/job/:jobId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Return the specified job" }, { "info": { "name": "Get input url", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/job/input", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Get a presigned url to upload data to. Also gets a key needed to create the job after the data is uploaded." }, { "info": { "name": "Job Input", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/job/:jobId/input", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Download the job input" }, { "info": { "name": "Job Output", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/job/:jobId/output", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Download the job results output" }, { "info": { "name": "Job Output url", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/job/:jobId/output-url", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Return the job download url" } ] }, { "info": { "name": "Device Inventory Management", "type": "folder" }, "items": [ { "info": { "name": "Upload bulk device inventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory/import", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to upload a bulk file containing the partition's device inventory" }, { "info": { "name": "Retrieve bulk device inventory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a bulk file containing the partition's device inventory" }, { "info": { "name": "Upload bulk device inventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to upload a bulk file containing the partition's device inventory" }, { "info": { "name": "Retrieve bulk device inventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory/export", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a bulk file containing the partition's device inventory" }, { "info": { "name": "Delete bulk device inventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory/delete", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to delete a bulk file containing the partition's device inventory" } ] }, { "info": { "name": "Cymbus User Product", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Cymbus group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cymbus/partition-group/:partitionId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve the Cymbus group associated to a partition" }, { "info": { "name": "Update Cymbus group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/cymbus/partition-group", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Use to update specific Cymbus group (only support email and name" }, { "info": { "name": "Update Cymbus account group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/cymbus/account-group", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Use to update Cymbus account group" }, { "info": { "name": "Retrieve Cymbus account group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cymbus/account-group/:accountid", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "accountid", "value": "", "type": "path" } ] }, "docs": "Use to retrieve the Cymbus group associated to an account" }, { "info": { "name": "Prevalidate Cymbus account name", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/cymbus/account-group/prevalidate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "groupName", "value": "", "type": "query" } ] }, "docs": "Use to verify that the chosen name is available" }, { "info": { "name": "Retrieve sip credentials for Cymbus user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/cymbus/:userid/sipcredentials", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "userid", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to retrieve sip creds for both lines associated to an account" }, { "info": { "name": "Change sip password for Cymbus user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/cymbus/:userid/sipcredentials/change", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "userid", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to change sip password for both Cymbus user lines" } ] }, { "info": { "name": "Device Provisioning", "type": "folder" }, "items": [ { "info": { "name": "Retrieve provisioning information for a specified device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceprovisioning/:macAddress", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "macAddress", "value": "", "type": "path" } ] }, "docs": "Provisioning Information" }, { "info": { "name": "Retrieve provisioning information for a specified deviceid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceprovisioning/account/:accountid/device/:deviceid", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountid", "value": "", "type": "path" }, { "name": "deviceid", "value": "", "type": "path" } ] }, "docs": "Provisioning Information" } ] }, { "info": { "name": "Inbound Rate Plan Product", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an inbound rate plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/inboundrateplanproduct/:ratePlanId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "ratePlanId", "value": "", "type": "path" } ] }, "docs": "Use to retrieve an inbound rate plan" }, { "info": { "name": "Retrieve inbound rate plan list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/inboundrateplanproduct", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Retrieve a list of inbound rate plans available to a partition" } ] }, { "info": { "name": "Management User", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a management user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "id", "value": "", "type": "path", "description": "Management user ID" } ] }, "docs": "Use to retrieve a management user" }, { "info": { "name": "Update a management user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "id", "value": "", "type": "path", "description": "Management user ID" } ] }, "docs": "Use to update a management user" }, { "info": { "name": "Update a management user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "id", "value": "", "type": "path", "description": "Management user ID" } ] }, "docs": "Use to update a management user" }, { "info": { "name": "Delete management user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "id", "value": "", "type": "path", "description": "Management user ID" } ] }, "docs": "Use to delete a management user" }, { "info": { "name": "retrieve_1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Create a management user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to create a management user" }, { "info": { "name": "Search for management users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/search", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "sortColumn", "value": "", "type": "query", "description": "Sort column" }, { "name": "searchString", "value": "", "type": "query", "description": "Search string" }, { "name": "descending", "value": "", "type": "query", "description": "Ordering" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result to return" }, { "name": "maxResult", "value": "", "type": "query", "description": "Maximum number of results" } ] }, "docs": "Use to search for management users" }, { "info": { "name": "Retrieve list of management user groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/usergroups", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a list of management user groups" }, { "info": { "name": "Create or Update management user groups", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/usergroups", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to create or update management user groups" }, { "info": { "name": "Pre-validate property on the ManagementUser object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/validateproperties", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "email", "value": "", "type": "query", "description": "Email to validate" } ] }, "docs": "Pre-validate property on the ManagementUser object" }, { "info": { "name": "Reset management user password", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/:id/resetpassword", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "id", "value": "", "type": "path", "description": "Management user ID" } ] }, "docs": "Use to reset the password of a management user" }, { "info": { "name": "Get a management user's sso status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/managementuser/:id/sso", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "id", "value": "", "type": "path", "description": "Management user ID" } ] }, "docs": "Use to retrieve a management user's sso status" } ] }, { "info": { "name": "Partition", "type": "folder" }, "items": [ { "info": { "name": "retrieve_2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Checks if dynamic inventory enabled for the specified partition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/is-di-supported", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Checks if dynamic inventory enabled for the specified partition" }, { "info": { "name": "Get all settings for this partition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/setting", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a map containing partition specific settings" }, { "info": { "name": "Telephone Carriers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/inboundcarriers", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "the inbound carrier list available to this partition" }, { "info": { "name": "Retrieve bulk device inventory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a bulk file containing the partition's device inventory" }, { "info": { "name": "Upload bulk device inventory", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/deviceinventory_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to upload a bulk file containing the partition's device inventory" }, { "info": { "name": "partitionDataHistorySearch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/data-history", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "tag", "value": "", "type": "query" }, { "name": "firstResultIndex", "value": "", "type": "query" }, { "name": "maxResult", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Local Calling Areas", "type": "folder" }, "items": [ { "info": { "name": "allTelephoneNumberCSVReport_1", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/localprefixes/export/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "importLocalAreas", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/localprefixes/import", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } } ] }, { "info": { "name": "Report", "type": "folder" }, "items": [ { "info": { "name": "Retrieve telephone number port out in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/portout/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted telephone number port out report" }, { "info": { "name": "Retrieve telephone number port out in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/portout/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted telephone number port out report" }, { "info": { "name": "Retrieve Business Lines report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/emergencynotificationcompliance/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted Business Lines report" }, { "info": { "name": "Retrieve user summary report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/user", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a list" }, { "info": { "name": "Retrieve user summary report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/device", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a list" }, { "info": { "name": "Retrieve device report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/device/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve device report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/device/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve device report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/device/csv_3", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve telephone number summary report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve the telephone number summary report" }, { "info": { "name": "Retrieve telephone number summary report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/tn/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted telephone number summary report" }, { "info": { "name": "Retrieve telephone number summary report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/tn/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted telephone number summary report" }, { "info": { "name": "Retrieve SIP summary report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/sip", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve the SIP summary report" }, { "info": { "name": "Retrieve account report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/account/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve account report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/account/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve account report in CSV format. Uses new Data API to retrieve data.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/account/csv_3", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "endUserAccountHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/accounthistory/enduserchanges", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" } ] } }, { "info": { "name": "endUserAccountHistory2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/accounthistory/enduserchanges_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" } ] } }, { "info": { "name": "Retrieve Virtual Fax summary report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/vfax", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve the Virtual Fax summary report" }, { "info": { "name": "mockLineSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/line", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Retrieve Business Lines report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/businesslines/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted Business Lines report" }, { "info": { "name": "Retrieve on demand Device Registration report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/deviceregistration/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted current devices registered" }, { "info": { "name": "Retrieve Users and the Product selected report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/user-products/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to retrieve a CSV formatted User Products report" }, { "info": { "name": "Retrieve Specialty Lines report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/specialtylines/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted Specialty Lines report" }, { "info": { "name": "Retrieve Contact Center Usage report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/contact_center_usage/csv_1", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted Contact Center Usage report" }, { "info": { "name": "Retrieve Contact Center Retail report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/contact_center_retail/csv_1", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted Contact Center Retail report" }, { "info": { "name": "Retrieve SIP summary report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/sip/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted SIP summary report" }, { "info": { "name": "Retrieve user summary report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/user/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve SIP summary report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/sip/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted SIP summary report" }, { "info": { "name": "Retrieve user summary report in CSV format. Uses new Data API to retrieve data.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/user/csv_3", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve user summary report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/user/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query", "description": "Year" }, { "name": "month", "value": "", "type": "query", "description": "Month" } ] }, "docs": "Use to retrieve a CSV formatted list" }, { "info": { "name": "Retrieve Virtual Fax report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/vfax/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted Virtual Fax report" }, { "info": { "name": "Retrieve Virtual Fax report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/vfax/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted Virtual Fax report" }, { "info": { "name": "Retrieve MS Teams report in CSV format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/report/msteams/csv_1", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "year", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a CSV formatted MS Teams report" } ] }, { "info": { "name": "Security Groups", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Security Role", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/security/:securityId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "securityId", "value": "", "type": "path" } ] }, "docs": "Use to get a specific security roles" }, { "info": { "name": "Update Security Role", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/security/:securityId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "securityId", "value": "", "type": "path" } ] }, "docs": "Use to update a specific security roles" }, { "info": { "name": "Update Security Role", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/security/:securityId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "securityId", "value": "", "type": "path" } ] }, "docs": "Use to update a specific security roles" }, { "info": { "name": "Delete Security Role", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/security/:securityId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "securityId", "value": "", "type": "path" } ] }, "docs": "Use to delete a security roles" }, { "info": { "name": "Retrieve Security Roles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/security", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to get a list of security roles" }, { "info": { "name": "Create Security Role", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/security", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to create a security roles" } ] }, { "info": { "name": "Telephone Number", "type": "folder" }, "items": [ { "info": { "name": "retrieve_5", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Create telephone number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to create a telephone number" }, { "info": { "name": "Retrieve telephone number", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to retrieve information about a telephone number" }, { "info": { "name": "Delete telephone number", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to delete a telephone number" }, { "info": { "name": "Telephone number search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/search", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "q", "value": "", "type": "query", "description": "Query Field: q=18015551212, q=84062, q=ALBANY, q=ALBANY.NY, LAT_LONG does not use this field" }, { "name": "functiontype", "value": "", "type": "query", "description": "Function Type, default ELS" }, { "name": "type", "value": "", "type": "query", "description": "Search Type, default POSTALCODE_OR_TN" }, { "name": "lat", "value": "", "type": "query", "description": "Latitude, requires type=LAT_LONG" }, { "name": "long", "value": "", "type": "query", "description": "Latitude, requires type=LAT_LONG" }, { "name": "maxResults", "value": "", "type": "query", "description": "Number of results to return" } ] }, "docs": "Use to search for a telephone number" }, { "info": { "name": "Retrieve telephone number availability", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn/availability", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to retrieve information about a telephone number availability" }, { "info": { "name": "Bulk telephone number import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/bulkimport", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to import telephone numbers in bulk" }, { "info": { "name": "Bulk telephone number import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/bulkimport_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to import telephone numbers in bulk" }, { "info": { "name": "Export as CSV telephone number status search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/exportstatussearch", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "dateType", "value": "", "type": "query", "description": "Type of data" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "statusType", "value": "", "type": "query", "description": "Status type" }, { "name": "eventType", "value": "", "type": "query", "description": "Service activation event type" }, { "name": "accountId", "value": "", "type": "query", "description": "Account ID" }, { "name": "telephoneNumber", "value": "", "type": "query", "description": "Telephone number" }, { "name": "includeSubTns", "value": "", "type": "query", "description": "Include Sub Tns" } ] }, "docs": "Use to export the searched status of a telephone number as a CSV file" }, { "info": { "name": "Export as CSV telephone number status search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/exportstatussearch_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "dateType", "value": "", "type": "query", "description": "Type of data" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "statusType", "value": "", "type": "query", "description": "Status type" }, { "name": "eventType", "value": "", "type": "query", "description": "Service activation event type" }, { "name": "accountId", "value": "", "type": "query", "description": "Account ID" }, { "name": "telephoneNumber", "value": "", "type": "query", "description": "Telephone number" }, { "name": "includeSubTns", "value": "", "type": "query", "description": "Include Sub Tns" } ] }, "docs": "Use to export the searched status of a telephone number as a CSV file" }, { "info": { "name": "Delete telephone number cooldown", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn/cooldown/recover", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to delete a cooldown for a telephone number" }, { "info": { "name": "Reserve a telephone number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn/reserve", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to reserve a telephone number so another use cannot get it" }, { "info": { "name": "Delete a reserve on telephone number", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn/reserve", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to delete a reservation on a telephone number making it available for use by another" }, { "info": { "name": "Telephone number status search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/statussearch", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "dateType", "value": "", "type": "query", "description": "Type of data" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "statusType", "value": "", "type": "query", "description": "Status type" }, { "name": "eventType", "value": "", "type": "query", "description": "Service activation event type" }, { "name": "accountId", "value": "", "type": "query", "description": "Account ID" }, { "name": "telephoneNumber", "value": "", "type": "query", "description": "Telephone number" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result index" }, { "name": "maxResult", "value": "", "type": "query", "description": "Max results" } ] }, "docs": "Use to search for the status of a telephone number" }, { "info": { "name": "isTnOffNet", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/:tn/fmfmcheck", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "tn", "value": "", "type": "path" } ] } }, { "info": { "name": "getInventoryPlan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/export", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Export telephone numbers as csv", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/telephonenumber/export_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Export telephone numbers as csv" }, { "info": { "name": "Retrieve a telephone number on an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to retrieve a specific telephone number on an account" }, { "info": { "name": "Update telephone number on an account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to update a telephone number on an account" }, { "info": { "name": "Update telephone number on an account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to update a telephone number on an account" }, { "info": { "name": "Delete telephone number on an account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Use to delete a telephone number on an account" }, { "info": { "name": "Retrieve all telephone numbers on an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "limitedData", "value": "", "type": "query" } ] }, "docs": "Use to retrieve all telephone numbers on an account. limitedData is provided to enable large result sets retreived without long retrieval times" }, { "info": { "name": "Create a telephone number or add telephone number to an account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new telephone number or add an existing number to an account. Unit field in the CSR Address should be no greater than 10 character, anything more than 10 characters is ignored. " }, { "info": { "name": "Retrieve all telephone number for end users", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/groupid/:groupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "groupId", "value": "", "type": "path", "description": "Group ID" } ] }, "docs": "Use to retrieve all telephone numbers on an account for user groups. If group is provided only the numbers for the users on this group will be returned" }, { "info": { "name": "Accept original E911 address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn/911-address/original/accept", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" }, { "name": "latitude", "value": "", "type": "query", "description": "E911 address latitude" }, { "name": "longitude", "value": "", "type": "query", "description": "E911 address latitude" } ] }, "docs": "Accept original E911 address" }, { "info": { "name": "Get all unfinished or archived activations with dynamic inventory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "getAll", "value": "", "type": "query" }, { "name": "archived", "value": "", "type": "query" } ] }, "docs": "Get all unfinished or archived activations with dynamic inventory" }, { "info": { "name": "Activate a tn that will be requested dynamically from carrier. TN is not known at the moment of initiating of activation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Activate a tn that will be requested dynamically from carrier. TN is not known at the moment of initiating of activation" }, { "info": { "name": "Get activation with dynamic inventory regardless of status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests/:orderId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "orderId", "value": "", "type": "path", "description": "Dynamic reservation order id" } ] }, "docs": "Get activation with dynamic inventory regardless of status" }, { "info": { "name": "Updates dynamic reservation object", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests/:orderId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "orderId", "value": "", "type": "path", "description": "Dynamic reservation order id" } ] }, "docs": "Updates dynamic reservation object" }, { "info": { "name": "Cancel and remove reservation object", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests/actions/cancel", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Cancel and remove reservation object" }, { "info": { "name": "Revise and resubmit dynamic reservation object", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests/actions/resubmit", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Revise and resubmit dynamic reservation object" }, { "info": { "name": "Refresh dynamic activation status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/tn-requests/:orderId/refresh", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "orderId", "value": "", "type": "path" } ] }, "docs": "Refresh dynamic activation status" }, { "info": { "name": "Retrieve a telephone number usages on an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn/911-address/usages", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number usages" } ] }, "docs": "Use to retrieve usages of a specific telephone number on an account" }, { "info": { "name": "Get adjusted E911 address", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn/911-address/correction", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Get adjusted E911 address" }, { "info": { "name": "Accept adjusted E911 address", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn/911-address/correction/accept", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path", "description": "Telephone number" } ] }, "docs": "Accept adjusted E911 address" }, { "info": { "name": "Create or updates already activated telephone number to an account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/external", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new telephone number or update an existing number to an account. Unit field in the CSR Address should be no greater than 10 character, anything more than 10 characters is ignored. " }, { "info": { "name": "destination", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/telephonenumber/:tn/destination", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "tn", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Account", "type": "folder" }, "items": [ { "info": { "name": "Multi Line Account Activation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/activation/multiple", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to activate account with multiple users/devices/telephone numbers" }, { "info": { "name": "Account activation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/activation", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "(DEPRECATED) Use to activate an account" }, { "info": { "name": "retrieve_6", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Create account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to create an account" }, { "info": { "name": "Account search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/search", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "q", "value": "", "type": "query", "description": "Search term for account search" } ] }, "docs": "Use to search for an account" }, { "info": { "name": "Account history record search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/accounthistorysearch", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountNumber", "value": "", "type": "query", "description": "Account Number, required" }, { "name": "accountHistoryType", "value": "", "type": "query", "description": "Account history type" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result to display, defaults to 0" }, { "name": "maxResult", "value": "", "type": "query", "description": "Maximum number to return, defaults to 20" } ] }, "docs": "Use to search for account history records" }, { "info": { "name": "Change account status in bulk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/bulkstatuschange", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to change multiple account statuses" }, { "info": { "name": "Change account status in bulk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/bulkstatuschange_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to change multiple account statuses" }, { "info": { "name": "Frequently accessed account search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/frequentlyaccessed", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to list all frequently accessed accounts" }, { "info": { "name": "Recently accessed account search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/recentlyaccessed", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to list all recently accessed accounts" }, { "info": { "name": "Pre-validate property on the Account object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/validateproperties", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountnumber", "value": "", "type": "query", "description": "Account Number" }, { "name": "username", "value": "", "type": "query", "description": "Username to validate" }, { "name": "macaddress", "value": "", "type": "query", "description": "Mac address" }, { "name": "sipusername", "value": "", "type": "query", "description": "Sip Username" } ] }, "docs": "Pre-validate property on the Account object" }, { "info": { "name": "Retrieve account by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "accountIdType", "value": "", "type": "query", "description": "Defines if the ID is the account id or the account number. Default is Id. Possible Values are Id, AccountNumber" } ] }, "docs": "Use to retrieve a single account" }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update an account" }, { "info": { "name": "Update account", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update an account" }, { "info": { "name": "Delete account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete an account" }, { "info": { "name": "Determine which lines are available on a device/mac", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/macaddress/:macAddress/inventory", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "macAddress", "value": "", "type": "path" } ] }, "docs": "Uses to determine which lines are available on a device/mac, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline?filterType=MAC_ADDRESS_INVENTORY&filter={mac} endpoint instead" }, { "info": { "name": "Account history record search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accounthistorysearch", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "accountHistoryType", "value": "", "type": "query", "description": "Account history type" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result to display, defaults to 0" }, { "name": "maxResult", "value": "", "type": "query", "description": "Maximum number to return, defaults to 20" } ] }, "docs": "Use to search for account history records" }, { "info": { "name": "Send welcome email to all users that was not sent it before", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/send-welcome-email", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Used to send an welcome email to all users in the account" }, { "info": { "name": "Change Calling Plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callingplanproduct/:callingPlanProductId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "callingPlanProductId", "value": "", "type": "path" } ] }, "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan. If a pending calling plan already exists it will remove it and set the new calling plan" }, { "info": { "name": "Change Calling Plan Immediately", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callingplanswap", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan" }, { "info": { "name": " Cancel Pending Callingplan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/cancelpendingcallingplan", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan" }, { "info": { "name": "getDeviceDataForAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/macaddress/:macAddress", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "macAddress", "value": "", "type": "path" } ] } }, { "info": { "name": "Account Available User Product Plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user-product-plans", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve product plans available to an account" }, { "info": { "name": "Account status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/status", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve the status of a account" }, { "info": { "name": "Devices on an Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/devices", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Used to list all devices on an account, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead" } ] }, { "info": { "name": "Account Prevalidate", "type": "folder" }, "items": [ { "info": { "name": "Prevalidate a phone number", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/prevalidate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to prevalidate a telephone number" }, { "info": { "name": "Prevalidate an address for 911", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/e911/prevalidate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to prevalidate an address for 911" }, { "info": { "name": "Prevalidate an account product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/product/prevalidate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to prevalidate an account product" } ] }, { "info": { "name": "Calling Plan", "type": "folder" }, "items": [ { "info": { "name": "Get Calling Plans for a given reference", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callingplan", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "referenceType", "value": "", "type": "query" }, { "name": "referenceId", "value": "", "type": "query" } ] }, "docs": "will get a callingplan" }, { "info": { "name": "Add Calling Plan for a given reference", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callingplan", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "will add a callingplan" }, { "info": { "name": "Remove Calling Plan for a given reference", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callingplan", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "will remove a callingplan" }, { "info": { "name": "Retrieve the default calling plan definition file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/default-callingplan-definition", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Use to retrieve the default calling plan definition file" } ] }, { "info": { "name": "Call Parking Spot", "type": "folder" }, "items": [ { "info": { "name": "Get call parking spot list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callpark", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of call parking spots." }, { "info": { "name": "Create call parking spot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callpark", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a call parking spot" }, { "info": { "name": "Retrieve call parking spot", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callpark/:spotId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "spotId", "value": "", "type": "path", "description": "ID of call parking spot" } ] }, "docs": "Use to retrieve a call parking spot" }, { "info": { "name": "Update call parking spot", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callpark/:spotId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "spotId", "value": "", "type": "path", "description": "ID of call parking spot" } ] }, "docs": "Use to update a call parking spot" }, { "info": { "name": "Update call parking spot", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callpark/:spotId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "spotId", "value": "", "type": "path", "description": "ID of call parking spot" } ] }, "docs": "Use to update a call parking spot" }, { "info": { "name": "Delete call parking spot", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/callpark/:spotId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "spotId", "value": "", "type": "path", "description": "ID of call parking spot" } ] }, "docs": "Use to delete a call parking spot" } ] }, { "info": { "name": "CDRs", "type": "folder" }, "items": [ { "info": { "name": "CDR record search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/cdrsearch/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result to display, defaults to 0" }, { "name": "maxResult", "value": "", "type": "query", "description": "Maximum number to return, defaults to 20" }, { "name": "sort", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "minCost", "value": "", "type": "query", "description": "Specifies the minimum cost of the CDR" }, { "name": "callType", "value": "", "type": "query", "description": "Filter based on call type [INBOUND|OUTBOUND]" }, { "name": "callFlagType", "value": "", "type": "query", "description": "Filter based on call flag type" }, { "name": "callCategory", "value": "", "type": "query", "description": "Filter based on call category" }, { "name": "origNumber", "value": "", "type": "query", "description": "Filter based on origination number" }, { "name": "dialedNumber", "value": "", "type": "query", "description": "Filter based on dialed number" }, { "name": "termNumber", "value": "", "type": "query", "description": "Filter based on termination number" }, { "name": "startTime", "value": "", "type": "query", "description": "Filter based on start time" }, { "name": "endTime", "value": "", "type": "query", "description": "Filter based on end time" } ] }, "docs": "Use to search for CDR records" }, { "info": { "name": "CDR record search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/cdrsearch/csv_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result to display, defaults to 0" }, { "name": "maxResult", "value": "", "type": "query", "description": "Maximum number to return, defaults to 20" }, { "name": "sort", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "minCost", "value": "", "type": "query", "description": "Specifies the minimum cost of the CDR" }, { "name": "callType", "value": "", "type": "query", "description": "Filter based on call type [INBOUND|OUTBOUND]" }, { "name": "callFlagType", "value": "", "type": "query", "description": "Filter based on call flag type" }, { "name": "callCategory", "value": "", "type": "query", "description": "Filter based on call category" }, { "name": "origNumber", "value": "", "type": "query", "description": "Filter based on origination number" }, { "name": "dialedNumber", "value": "", "type": "query", "description": "Filter based on dialed number" }, { "name": "termNumber", "value": "", "type": "query", "description": "Filter based on termination number" }, { "name": "startTime", "value": "", "type": "query", "description": "Filter based on start time" }, { "name": "endTime", "value": "", "type": "query", "description": "Filter based on end time" } ] }, "docs": "Use to search for CDR records" }, { "info": { "name": "CDR record search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/cdrsearch", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "startDate", "value": "", "type": "query", "description": "Start date" }, { "name": "endDate", "value": "", "type": "query", "description": "End date" }, { "name": "firstResultIndex", "value": "", "type": "query", "description": "First result to display, defaults to 0" }, { "name": "maxResult", "value": "", "type": "query", "description": "Maximum number to return, defaults to 20" }, { "name": "sort", "value": "", "type": "query", "description": "Sort field" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "minCost", "value": "", "type": "query", "description": "Specifies the minimum cost of the CDR" }, { "name": "callType", "value": "", "type": "query", "description": "Filter based on call type [INBOUND|OUTBOUND]" }, { "name": "callFlagType", "value": "", "type": "query", "description": "Filter based on call flag type" }, { "name": "callCategory", "value": "", "type": "query", "description": "Filter based on call category" }, { "name": "origNumber", "value": "", "type": "query", "description": "Filter based on origination number" }, { "name": "dialedNumber", "value": "", "type": "query", "description": "Filter based on dialed number" }, { "name": "termNumber", "value": "", "type": "query", "description": "Filter based on termination number" }, { "name": "startTime", "value": "", "type": "query", "description": "Filter based on start time" }, { "name": "endTime", "value": "", "type": "query", "description": "Filter based on end time" } ] }, "docs": "Use to search for CDR records" } ] }, { "info": { "name": "Account Device Line", "type": "folder" }, "items": [ { "info": { "name": "Retrieve device provisioning status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId/provisioningstatus", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" } ] }, "docs": "Use to retrieve a device's provisioning status" }, { "info": { "name": "Provisioning info for this device line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId/provisioning", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" } ] }, "docs": "It is preferable if you use the device/{macAddress}/provisioning to get this information" }, { "info": { "name": "Retrieve device registration status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId/registrationstatus", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" } ] }, "docs": "Use to retrieve a device's registration status" }, { "info": { "name": "Pre-validate Device Line MacAddress.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId/swap/prevalidate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path" }, { "name": "macaddress", "value": "", "type": "query", "description": "Mac address" } ] }, "docs": "Pre-validate Device Line MacAddress." }, { "info": { "name": "Retrieve device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "deviceId" } ] }, "docs": "Use to retrieve a device" }, { "info": { "name": "Update device", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" } ] }, "docs": "Use to update a device" }, { "info": { "name": "Update device", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" } ] }, "docs": "Use to update a device" }, { "info": { "name": "Delete device", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" } ] }, "docs": "Use to delete a device" }, { "info": { "name": "Retrieve device list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "filter", "value": "", "type": "query", "description": "Filter used in conjunction with filtertype to only return specific devices on the account" }, { "name": "filterType", "value": "", "type": "query", "description": "Used in conjunction with filter to return only specific devices on the account" } ] }, "docs": "Use to retrieve a list of devices associated to an account. NOTE: if the user making the request in an EndUser and they only have myUser access then you MUST pass filter=userid and filterType=OWNING_USERID or filterType=REFERENCED_USERID or else you will get a NotPermitted error." }, { "info": { "name": "Create a new device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new device on a user" }, { "info": { "name": "Swap device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/deviceline/:deviceId/swap", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "deviceId", "value": "", "type": "path" } ] }, "docs": "Use to replace an existing device with a new device" } ] }, { "info": { "name": "Account Device", "type": "folder" }, "items": [ { "info": { "name": "List DeviceLines by MacAddress", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "List DeviceLines by macAddress" }, { "info": { "name": "Bulk Import Device Lines", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to bulk import lines for a given device. Note: To use this you must already have a device line defined for this MacAddress" }, { "info": { "name": "Delete all devicelines (by mac)", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete a device and all its lines using the macaddress" }, { "info": { "name": "CSV export of device lines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/csv", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "CSV Export of device lines" }, { "info": { "name": "Device (by mac) Metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/metadata", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve device (mac) metadata" }, { "info": { "name": "Device (by mac) Metadata", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/metadata", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update device (mac) metadata" }, { "info": { "name": "Device (by mac) Metadata", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/metadata", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update device (mac) metadata" }, { "info": { "name": "Provisioning info for this device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/provisioning", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Provisioning info for this device" }, { "info": { "name": "Device (by mac) Metadata", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/metadata/generateadminpassword", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update device (mac) metadata" }, { "info": { "name": "Device (by mac) Metadata", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/metadata/resetencryptionkey", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to reset the current encryption key as though the device has been factory reset and needs to start over" }, { "info": { "name": "Pre-validate property on the Device object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/device/:macAddress/validateproperties", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "macAddress", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "lineno", "value": "", "type": "query", "description": "Line Number" } ] }, "docs": "Pre-validate property on the Device object" } ] }, { "info": { "name": "Dynamic Inventory", "type": "folder" }, "items": [ { "info": { "name": "Retrieve telephone number list matching query parameters from carrier's dynamic inventory ", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/dynamic-inventory/tn-search", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "npa", "value": "", "type": "query", "description": "The three-digit number that identifies the telephone service region" }, { "name": "npa-nxx", "value": "", "type": "query", "description": "A six-digit code that is used to identify telephone numbers" }, { "name": "qty", "value": "", "type": "query", "description": "Desired quantity of telephone numbers" }, { "name": "sequential", "value": "", "type": "query", "description": "When true to returns sequential numbers" } ] }, "docs": "Retrieve telephone number list matching query parameters from carrier's dynamic inventory " }, { "info": { "name": "Creates Dynamic inventory orders, those orders eventually will activate telephone numbers received on a request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/dynamic-inventory/orders", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Creates Dynamic inventory orders, those orders eventually will activate telephone numbers received on a request" } ] }, { "info": { "name": "IVR", "type": "folder" }, "items": [ { "info": { "name": "Retrieve IVR", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/ivr/:ivrId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "ivrId", "value": "", "type": "path", "description": "ID of IVR" } ] }, "docs": "Use to retrieve an IVR" }, { "info": { "name": "Update IVR", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/ivr/:ivrId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "ivrId", "value": "", "type": "path", "description": "ID of IVR" } ] }, "docs": "Use to update an IVR" }, { "info": { "name": "Delete IVR", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/ivr/:ivrId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "ivrId", "value": "", "type": "path", "description": "ID of IVR" } ] }, "docs": "Use to delete an IVR" }, { "info": { "name": "Retrieve all IVRs for account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/ivr", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of all IVRs for a account" }, { "info": { "name": "Create IVR", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/ivr", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create an IVR" } ] }, { "info": { "name": "Media", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Media. Will return a 302 redirect to the actual file location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "ID of prompt" }, { "name": "mediaType", "value": "", "type": "query", "description": "Type of Media" } ] }, "docs": "Use to retrieve Media of a given type" }, { "info": { "name": "update_2", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteHoldMusic", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "ID of Hold Music Media" } ] } }, { "info": { "name": "Upload IVR Prompt or Account Hold Music", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "jobUploadKey", "value": "", "type": "query", "description": "Provide an upload key (Use for Hold Music)" } ] }, "docs": "Use to add an IVR Prompt (use file upload to submit a wav file).\nUse to add Hold Music (use the job service, then submit the jobUploadKey for the wav, mp3, ogg already uploaded)" }, { "info": { "name": "Retrieve Hold Music Media ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2/type/holdmusic", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "custom", "value": "", "type": "query" } ] }, "docs": "Use to retrieve Hold Music Media ID" }, { "info": { "name": "Remove the hold music media selection for this account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2/type/holdmusic", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Used to remove an existing media storage id that is used to play hold music for this account." }, { "info": { "name": "Set the hold music on this account to this media storage id.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media_2/type/holdmusic/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "Hold Music storage id" } ] }, "docs": "Used to set the hold music to a different storage id" }, { "info": { "name": "Retrieve Media of type", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media/:mediaId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "mediaId", "value": "", "type": "path", "description": "ID of prompt" }, { "name": "fileName", "value": "", "type": "query", "description": "Name of media" }, { "name": "mediaType", "value": "", "type": "query", "description": "Type of Media" } ] }, "docs": "Use to retrieve Media of a given type" }, { "info": { "name": "Add IVR prompt", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to add an IVR prompt" } ] }, { "info": { "name": "Port", "type": "folder" }, "items": [ { "info": { "name": "findLoa", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId/loa", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } }, { "info": { "name": "uploadLOA", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId/loa", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } }, { "info": { "name": "getLoaMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId/loa/metadata", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } }, { "info": { "name": "Updates a service activation event on an account and triggers the port with the carrier", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId/triggerport", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update a specific service activation event on an account as a port request for the purpose of triggering a port with the carrier" }, { "info": { "name": "retrievePort", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } }, { "info": { "name": "updatePort", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } }, { "info": { "name": "patchPort", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } }, { "info": { "name": "cancelPort", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/port/:portId/cancelport", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "portId", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] } } ] }, { "info": { "name": "Service Activation", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a service activation event on an account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/reference/:referenceId/type/:serviceType", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "referenceId", "value": "", "type": "path" }, { "name": "serviceType", "value": "", "type": "path" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a specific service activation event on an account" } ] }, { "info": { "name": "SIP Trunk", "type": "folder" }, "items": [ { "info": { "name": "Retrieve SIP trunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Use to retrieve a SIP trunk" }, { "info": { "name": "Update SIP trunk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Use to update a SIP trunk" }, { "info": { "name": "Update SIP trunk", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Use to update a SIP trunk" }, { "info": { "name": "Delete SIP trunk", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Use to delete a SIP trunk" }, { "info": { "name": "Validate IP and port", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/validate", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "trunkId", "value": "", "type": "query", "description": "When the SIP Trunk is already created we need the ID to make sure we skip the trunk itself to validate IP is unique" }, { "name": "ip", "value": "", "type": "query", "description": "The IP address to be verified" }, { "name": "port", "value": "", "type": "query", "description": "The port number to be verified" } ] }, "docs": "Use to verify that combination of IP and port is unique" }, { "info": { "name": "Retrieve list of SIP trunks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of all SIP trunks on an account" }, { "info": { "name": "Create a SIP trunk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a SIP trunk" }, { "info": { "name": "Get Forward behavior for a SipTrunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId/forward", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Get Forward behavior for a SipTrunk" }, { "info": { "name": "Update Forward behavior for a SipTrunk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId/forward", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Update Forward behavior for a SipTrunk" }, { "info": { "name": "Unlock SIP trunk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId/unlock", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Use to unlock a SIP trunk" }, { "info": { "name": "Retrieve list of shareable calling plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/shared-plan-lookup", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve calling plans that can be shared between sip trunks" }, { "info": { "name": "Retrieve SIP trunk registration status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/siptrunk_2/:sipTrunkId/registrationstatus", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "sipTrunkId", "value": "", "type": "path", "description": "SIP trunk ID" } ] }, "docs": "Use to retrieve SIP trunk registration status" } ] }, { "info": { "name": "Business Line", "type": "folder" }, "items": [ { "info": { "name": "Retrieve business line list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of business lines associated to an account" }, { "info": { "name": "Create a new business line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new business line on an account. This includes the physical device specifications, call handling rules, and SIP credentials." }, { "info": { "name": "Retrieve business line list with lines in expanded view format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/views/expanded", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of business lines in expanded view format which is associated to an account" }, { "info": { "name": "Retrieve business line call handling", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/call-handling", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to get the call handling specifications for a business line" }, { "info": { "name": "Update business line call handling", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/call-handling", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update the call handling specifications for a business line" }, { "info": { "name": "Retrieve business line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line" }, { "info": { "name": "Update business line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update a business line" }, { "info": { "name": "Delete business line", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete a business line" }, { "info": { "name": "Retrieve business line in expanded view format", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/views/expanded", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line in expanded view format" }, { "info": { "name": "Retrieve registration status for business line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/registration", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve registration status of business line" }, { "info": { "name": "Swap business line port assignment(s)", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/port-assignment/rpc/swap", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to swap out the port assignments related to an existing port assignment mac address or id" }, { "info": { "name": "Retrieve business line port assignment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/port-assignment", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to get the physical port assignment specifications for a business line" }, { "info": { "name": "Create business line port assignment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/port-assignment", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create the physical port assignment specifications for a business line" }, { "info": { "name": "Update business line port assignment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/port-assignment", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update the physical port assignment specifications for a business line" }, { "info": { "name": "Delete business line port assignment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/port-assignment", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete the physical port assignment specifications for a business line" }, { "info": { "name": "Retrieve provisioning logs from third party notifications", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/port-assignment/push-provisioning-logs", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Used for port assignments utilizing a mac address. Pull logs from push provisioning" }, { "info": { "name": "Retrieve SIP credentials", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/sip-credentials", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve SIP credentials for a business line" }, { "info": { "name": "Update SIP credentials", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/sip-credentials", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update SIP credentials for a business line" }, { "info": { "name": "SIP Username Availability Check", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/:businessLineId/sip-credentials/username-availability-check/:username", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "businessLineId", "value": "", "type": "path", "description": "ID of Business Line" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "username", "value": "", "type": "path" } ] }, "docs": "Use to determine if a SIP username is available to use" }, { "info": { "name": "Retrieve all business line voicemail boxes on this account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line voicemail boxes on the specified account" }, { "info": { "name": "Create business line voicemail box on account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a business line voicemail box on the specified account" }, { "info": { "name": "Retrieve all business line voicemail boxes on this account including references", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/views/expanded", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line voicemail boxes on the specified account including references" }, { "info": { "name": "Retrieve business line voicemail box", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line voicemail box" }, { "info": { "name": "Update business line voicemail box", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update a business line voicemail box" }, { "info": { "name": "Delete business line voicemail box", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete a business line voicemail box" }, { "info": { "name": "Retrieve business line voicemail box including references", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/views/expanded", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line voicemail box including references" }, { "info": { "name": "Check business line voicemail box PIN status", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/rpc/check-pin-status", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to check a business line voicemail box PIN status" }, { "info": { "name": "Reset the PIN for a business line voicemail box", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/rpc/reset-pin", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to reset a PIN for a business line voicemail box" }, { "info": { "name": "Retrieve a business line voicemail message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message/:messageId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Use to retrieve a message in a business line voicemail box" }, { "info": { "name": "Delete a business line voicemail message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message/:messageId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Use to delete a message in a business line voicemail box" }, { "info": { "name": "Retrieve business line voicemail messages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve all messages in a business line voicemail box" }, { "info": { "name": "Delete business line voicemail messages", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete all messages in a business line voicemail box" }, { "info": { "name": "Bulk update of voicemail messages", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message/bulk-update", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to mark multiple voicemail messages at the same time to a READ, UNREAD, or DELETE status" }, { "info": { "name": "Retrieve a business line voicemail message media", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message/:messageId/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Use to retrieve the audio message for a business line voicemail message" }, { "info": { "name": "Update business line voicemail message read flag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/message/:messageId/set-read-status", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Use to update if a voicemail message should be marked as read" } ] }, { "info": { "name": "Voicemail Box", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Greeting media file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/greetings/:greetingType/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "greetingType", "value": "", "type": "path" } ] }, "docs": "Use to retrieve media file for a business-line voicemail box" }, { "info": { "name": "Upload Business-Line Greeting media file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/greetings/:greetingType/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "greetingType", "value": "", "type": "path" } ] }, "docs": "Use to upload media file for a business-line voicemail box (wav, mp3, ogg)" }, { "info": { "name": "Delete Greeting media file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line/voicemail-box/:voicemailBoxId/greetings/:greetingType/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "greetingType", "value": "", "type": "path" } ] }, "docs": "Use to delete media file for a business-line voicemail box" }, { "info": { "name": "Retrieve voicemail box list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "parentId", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a list of voicemail boxes for an account" }, { "info": { "name": "Create voicemail box", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new voicemail box" }, { "info": { "name": "Set a PIN for a reference using a voicemail box", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/pin", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Set a PIN for a reference using a voicemail box" }, { "info": { "name": "Retrieve User Greeting media file", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/greetings/:greetingType/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "greetingType", "value": "", "type": "path" } ] }, "docs": "Use to retrieve media file for a users voicemail box" }, { "info": { "name": "Upload User Greeting media file", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/greetings/:greetingType/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "greetingType", "value": "", "type": "path" } ] }, "docs": "Use to upload media file for a users voicemail box (wav, mp3, ogg)" }, { "info": { "name": "Delete User Greeting media file", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/greetings/:greetingType/media", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "greetingType", "value": "", "type": "path" } ] }, "docs": "Use to delete media file for a users voicemail box" }, { "info": { "name": "Get voicemail box", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Use to retrieve a voicemail box" }, { "info": { "name": "Update voicemail box", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Use to update a voicemail box" }, { "info": { "name": "Update voicemail box", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Use to update a voicemail box" }, { "info": { "name": "Delete voicemail box", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Use to delete a voicemail box." }, { "info": { "name": "Unlock a sub voicemailbox", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/unlock", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "resetPin", "value": "", "type": "query", "description": "New voicemail Pin" } ] }, "docs": "Use to unlock the pin on a subvoicemail box" } ] }, { "info": { "name": "Business Line Hunt Group", "type": "folder" }, "items": [ { "info": { "name": "Retrieve business line hunt group list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of business lines hunt groups associated to an account" }, { "info": { "name": "Create a new business line hunt group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new business line hunt group on an account." }, { "info": { "name": "Retrieve business line hunt group failover action for the specified reason", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/failover-action/:reason", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "reason", "value": "", "type": "path" } ] }, "docs": "Use to retrieve a failover action for a business lines hunt group" }, { "info": { "name": "Update business line hunt group failover action for the specified reason", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/failover-action/:reason", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "reason", "value": "", "type": "path" } ] }, "docs": "Use to update the failvover action for a business line hunt group" }, { "info": { "name": "Retrieve a list of available star codes to forward the hunt group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/forward-configuration/:id/constraints/star-code", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Use to retrieve a list of available star codes to assign to business line hunt group including the current star code assigned to this hunt group's forwarding configuration. Use '*' to search without a forward configuration id" }, { "info": { "name": "Retrieve business line hunt group forwarding configuration list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/forward-configuration", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of forwarding configurations on a business lines hunt group" }, { "info": { "name": "Create a new business line hunt group forwarding configuration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/forward-configuration", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a new forwarding configuration on a business line hunt group." }, { "info": { "name": "Retrieve business line hunt group forwarding configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/forward-configuration/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Use to get the forwarding configuration for a business line hunt group" }, { "info": { "name": "Update business line hunt group forwarding configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/forward-configuration/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Use to update the forwarding configuration for a business line hunt group" }, { "info": { "name": "Delete business line hunt group forwarding configuration", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId/forward-configuration/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Use to delete the forwarding configuration for a business line hunt group" }, { "info": { "name": "Retrieve business line hunt group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a business line hunt group" }, { "info": { "name": "Update business line hunt group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to update a business line hunt group" }, { "info": { "name": "Delete business line hunt group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/business-line-hunt-group/:huntGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "huntGroupId", "value": "", "type": "path", "description": "ID of Business Line Hunt Group" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to delete a business line hunt group" } ] }, { "info": { "name": "Call Group", "type": "folder" }, "items": [ { "info": { "name": "Get call group list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/group", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "memberType", "value": "", "type": "query", "description": "Filter by member type" }, { "name": "memberId", "value": "", "type": "query", "description": "Filter for member ID, requires member type" } ] }, "docs": "Use to retrieve a list of call groups." }, { "info": { "name": "Create call group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/group", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a call group" }, { "info": { "name": "Retrieve a call group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/group/:callGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "callGroupId", "value": "", "type": "path", "description": "ID of call group" } ] }, "docs": "Use to retrieve a call group" }, { "info": { "name": "Update call group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/group/:callGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "callGroupId", "value": "", "type": "path", "description": "ID of Call group" } ] }, "docs": "Use to update a call group" }, { "info": { "name": "Update call group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/group/:callGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "callGroupId", "value": "", "type": "path", "description": "ID of call group" } ] }, "docs": "Use to update a call group" }, { "info": { "name": "Delete call group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/group/:callGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "callGroupId", "value": "", "type": "path", "description": "ID of call group" } ] }, "docs": "Use to delete a call group" } ] }, { "info": { "name": "Paging Group", "type": "folder" }, "items": [ { "info": { "name": "Get paging group list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppaging", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of paging groups." }, { "info": { "name": "Create paging group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppaging", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a paging group" }, { "info": { "name": "Retrieve paging group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppaging/:pagingGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pagingGroupId", "value": "", "type": "path", "description": "ID of paging group" } ] }, "docs": "Use to retrieve a paging group" }, { "info": { "name": "Update paging group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppaging/:pagingGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pagingGroupId", "value": "", "type": "path", "description": "ID of paging group" } ] }, "docs": "Use to update a paging group" }, { "info": { "name": "Update paging group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppaging/:pagingGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pagingGroupId", "value": "", "type": "path", "description": "ID of paging group" } ] }, "docs": "Use to update a paging group" }, { "info": { "name": "Delete paging group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppaging/:pagingGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pagingGroupId", "value": "", "type": "path", "description": "ID of paging group" } ] }, "docs": "Use to delete a paging group" } ] }, { "info": { "name": "Pickup Group", "type": "folder" }, "items": [ { "info": { "name": "Retrieve pickup group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppickup/:pickupGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pickupGroupId", "value": "", "type": "path", "description": "ID of pickup group" } ] }, "docs": "Use to retrieve a pickup group" }, { "info": { "name": "Update pickup group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppickup/:pickupGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pickupGroupId", "value": "", "type": "path", "description": "ID of pickup group" } ] }, "docs": "Use to update a pickup group" }, { "info": { "name": "Update pickup group", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppickup/:pickupGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pickupGroupId", "value": "", "type": "path", "description": "ID of pickup group" } ] }, "docs": "Use to update a pickup group" }, { "info": { "name": "Delete pickup group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppickup/:pickupGroupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "pickupGroupId", "value": "", "type": "path", "description": "ID of pickup group" } ] }, "docs": "Use to delete a pickup group" }, { "info": { "name": "Get pickup group list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppickup", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of pickup groups." }, { "info": { "name": "Create pickup group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/grouppickup", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a pickup group" } ] }, { "info": { "name": "Emergency Notification", "type": "folder" }, "items": [ { "info": { "name": "Retrieve notification event list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/emergency-notifications/events", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve all NotificationEvents for an account" }, { "info": { "name": "Retrieve notification group list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/emergency-notifications/groups", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of notification group associated to an account" }, { "info": { "name": "Retrieve notification group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/emergency-notifications/groups/:type/:groupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "type", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "Use to retrieve a specific NotificationGroup (include Compliance & configurations) for id/type" }, { "info": { "name": "Update notification group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/emergency-notifications/groups/:type/:groupId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "type", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "Use to update specific NotificationGroup (only Compliance & configurations) for id/type" }, { "info": { "name": "Execute test", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/emergency-notifications/groups/:type/:groupId/execute-test", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "type", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "Execute a test of all NotificationConfigurations associated with the specified NotificationGroup" } ] }, { "info": { "name": "Account User", "type": "folder" }, "items": [ { "info": { "name": "Get user list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "limitedData", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a list of users. limitedData is provided to enable large result sets retreived without long retrieval times" }, { "info": { "name": "Create user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a user" }, { "info": { "name": "Retrieve user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" }, { "name": "idType", "value": "", "type": "query", "description": "Defines if the Id is the userid for the username" } ] }, "docs": "Use to retrieve a user" }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to update a user" }, { "info": { "name": "Update user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to update a user" }, { "info": { "name": "Delete user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to delete a user" }, { "info": { "name": "Reset user password", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/accountuser/:userId/resetpassword", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to reset the password of a user" } ] }, { "info": { "name": "End User", "type": "folder" }, "items": [ { "info": { "name": "Get end user list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "limitedData", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a list of end users. limitedData is provided to enable large result sets retreived without long retrieval times" }, { "info": { "name": "Create end user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a end user" }, { "info": { "name": "Prevalidate the end user's email address before saving the end user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/prevalidate/email/:email", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "email", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "query" } ] }, "docs": "Use to prevalidate the email address. If the user hasn't been created yet, use as is. If the User already exists, provide qualified query param `userId`" }, { "info": { "name": "End User activation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/activation", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "(DEPRECATED) Use to create a new end user/device/csr to an existing account" }, { "info": { "name": "Retrieve end user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" }, { "name": "idType", "value": "", "type": "query", "description": "Defines if the Id is the userid for the username" } ] }, "docs": "Use to retrieve a end user" }, { "info": { "name": "Update end user", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to update a end user" }, { "info": { "name": "Update end user", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to update a end user" }, { "info": { "name": "Delete end user", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to delete a end user" }, { "info": { "name": "Send welcome email to user", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/send-welcome-email", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to send a welcome email to the user" }, { "info": { "name": "Change Calling Plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/callingplanproduct/:callingPlanProductId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" }, { "name": "callingPlanProductId", "value": "", "type": "path" } ] }, "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will add a pending calling plan. If a pending calling plan already exists it will remove it and set the new calling plan" }, { "info": { "name": "Change Calling Plan Immediately", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/callingplanswap", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will swap the active calling plan immediately for the specified calling plan" }, { "info": { "name": " Cancel Pending Callingplan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/cancelpendingcallingplan", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "DEPRECATED USE account/{accountId}/callingplan INSTEAD -- Will cancel any pending calling plan" }, { "info": { "name": "Retrieve end user voicemail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/voicemail", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to retrieve a end user's voicemail" }, { "info": { "name": "Unlock end user voicemail", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/unlockvm", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" }, { "name": "resetPin", "value": "", "type": "query", "description": "New voicemail Pin" } ] }, "docs": "Use to unlock a end user's voicemail" }, { "info": { "name": "Reset end user password", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/resetpassword", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to reset the password of a end user" }, { "info": { "name": "Repurpose an existing user to be a different user (end user swap)", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/repurpose", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to reuse a user for a new user" } ] }, { "info": { "name": "Device (Deprecated)", "type": "folder" }, "items": [ { "info": { "name": "Retrieve device list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to retrieve a list of devices associated to an account and a user, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead" }, { "info": { "name": "Create a new device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to create a new device on a user, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline endpoint instead" }, { "info": { "name": "Pre-validate property on the Device object", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/validateproperties", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" }, { "name": "macaddress", "value": "", "type": "query", "description": "Mac Address" }, { "name": "lineno", "value": "", "type": "query", "description": "Line Number" } ] }, "docs": "DEPRECATED use /v2/partition/{id}/account/{id}/device/{macaddress}/validateproperties endpoint instead" }, { "info": { "name": "Retrieve device provisioning status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId/provisioningstatus", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to retrieve a device's provisioning status, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id}/provisioningstatus endpoint instead" }, { "info": { "name": "Retrieve device registration status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId/registrationstatus", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to retrieve a device's registration status, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id}/registrationstatus endpoint instead" }, { "info": { "name": "Retrieve device", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to retrieve a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead" }, { "info": { "name": "Update device", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to update a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead" }, { "info": { "name": "Update device", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to update a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead" }, { "info": { "name": "Delete device", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to delete a device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id} endpoint instead" }, { "info": { "name": "Swap device", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/user/:userId/device/:deviceId/swap", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "deviceId", "value": "", "type": "path", "description": "DeviceId" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "userId", "value": "", "type": "path", "description": "ID of end-user" } ] }, "docs": "Use to replace an existing device with a new device, DEPRECATED use /v2/partition/{id}/account/{id}/deviceline/{id}/swap endpoint instead" } ] }, { "info": { "name": "Virtual Fax Line", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Virtual Fax Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "VirtualFaxLineID" } ] }, "docs": "Use to retrieve a Virtual Fax Line" }, { "info": { "name": "Update Virtual Fax Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "VirtualFaxLineID" } ] }, "docs": "Use to update a Virtual Fax Line" }, { "info": { "name": "Update Virtual Fax Line", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "VirtualFaxLineID" } ] }, "docs": "Use to update a Virtual Fax Line" }, { "info": { "name": "Delete Virtual Fax Line", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "id", "value": "", "type": "path", "description": "VirtualFaxLineID" } ] }, "docs": "Use to delete a Virtual Fax Line" }, { "info": { "name": "Retrieve list of Virtual Fax Lines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve a list of all Virtual Fax Lines on an account" }, { "info": { "name": "Create a Virtual Fax Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to create a VirtualFaxLine" } ] }, { "info": { "name": "Virtual Fax", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Outbound Virtual Fax Configuration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax/outbound", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to retrieve the outbound vfax configuration on an account" }, { "info": { "name": "Update Outbound Virtual Fax Configuration", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/vfax/outbound", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" } ] }, "docs": "Use to configure outbound vfax for an account" } ] }, { "info": { "name": "Voicemail Message", "type": "folder" }, "items": [ { "info": { "name": "Get voicemail message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage/:messageId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "messageId", "value": "", "type": "path", "description": "MessageId" } ] }, "docs": "Use to retrieve a voicemail message" }, { "info": { "name": "Update voicemail message", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage/:messageId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "messageId", "value": "", "type": "path", "description": "MessageId" } ] }, "docs": "Use to update a voicemail message; can only update read status" }, { "info": { "name": "Delete voicemail message", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage/:messageId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "messageId", "value": "", "type": "path", "description": "MessageId" } ] }, "docs": "Use to delete a voicemail message" }, { "info": { "name": "Retrieve voicemail message list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Use to retrieve a list of voicemail messages in a voicemail box" }, { "info": { "name": "Delete multiple voicemails", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" } ] }, "docs": "Use to delete multiple voicemails in a single call" }, { "info": { "name": "Get contents of voicemail message. Will return a 302 redirect to the actual image location. Pass query param mediatype=mp3 or wav", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage/:messageId/content_2", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "messageId", "value": "", "type": "path", "description": "ID of voicemail message" }, { "name": "mediatype", "value": "", "type": "query" } ] }, "docs": "Use to retrieve Media of a given type" }, { "info": { "name": "get contents of a voicemail message", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/account/:accountId/voicemailbox/:voicemailBoxId/voicemailmessage/:messageId/content", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "accountId", "value": "", "type": "path", "description": "ID of account" }, { "name": "voicemailBoxId", "value": "", "type": "path", "description": "ID of Voicemail Box" }, { "name": "messageId", "value": "", "type": "path", "description": "ID of voicemail message" }, { "name": "fileName", "value": "", "type": "query", "description": "Name of prompt" } ] }, "docs": "Use to get contents of a voicemail message" } ] }, { "info": { "name": "Calling Plan Product", "type": "folder" }, "items": [ { "info": { "name": "Retrieve calling plan product", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/:cppId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "cppId", "value": "", "type": "path" } ] }, "docs": "Use to retrieve a calling plan product" }, { "info": { "name": "Update calling plan product", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/:cppId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "cppId", "value": "", "type": "path", "description": "ID of calling plan product" } ] }, "docs": "Use to update calling plan product" }, { "info": { "name": "Update calling plan product", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/:cppId", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "cppId", "value": "", "type": "path", "description": "ID of calling plan product" } ] }, "docs": "Use to update calling plan product" }, { "info": { "name": "Retrieve calling plan product list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "includeArchived", "value": "", "type": "query" } ] }, "docs": "Use to retrieve a list of calling plan products" }, { "info": { "name": "Add calling plan product", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to add a calling plan product" }, { "info": { "name": "add_1", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/import", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] } }, { "info": { "name": "Archive calling plan product", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/:cppId/archive-callingplan", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" }, { "name": "cppId", "value": "", "type": "path" } ] }, "docs": "Use to archive calling plan product to make them unusable for future assignment" }, { "info": { "name": "Retrieve the calling plan definition", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/:cppId/callingplanproductdefinition", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "cppId", "value": "", "type": "path", "description": "ID of calling plan product" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to download the current calling plan definition" }, { "info": { "name": "Add calling plan rates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/partition/:partitionId/callingplanproduct/:cppId/callingplanproductdefinition", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "cppId", "value": "", "type": "path", "description": "ID of calling plan product" }, { "name": "partitionId", "value": "", "type": "path", "description": "ID of partition" } ] }, "docs": "Use to add calling plan rates" } ] }, { "info": { "name": "Reference Resources", "type": "folder" }, "items": [ { "info": { "name": "DeviceType", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/devicetype/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a specific DeviceType" }, { "info": { "name": "DeviceTypes List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/devicetype", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "partitionid", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of device types available to the given partition" }, { "info": { "name": "DialPlanActionTypes List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/dialplan/actiontypes", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "includeRestricted", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of available dial plan action types" }, { "info": { "name": "Language List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/language", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Retrieve a list of supported Languages" }, { "info": { "name": "PermissionType and Access List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/permissions", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "usertype", "value": "", "type": "query" } ] }, "docs": "Retrieve a list of available Permission Types and their max Access level for a given UserType" }, { "info": { "name": "RoutePlan default template", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/routeplan-definition-template", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Get the default rates csv for a RoutePlan" }, { "info": { "name": "Address - SecondaryLocationType List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/secondary-location-types", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Get a list of available SecondaryLocationTypes" }, { "info": { "name": "Device - SideCarType", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/sidecartype/:id", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a given SideCarType" }, { "info": { "name": "Device - SideCarType List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/sidecartype", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Get a list of available SideCarTypes" }, { "info": { "name": "getList", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/system-default-media/:type", "params": [ { "name": "type", "value": "", "type": "path" } ] } }, { "info": { "name": "TimeZone List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/ref/timezones", "headers": [ { "name": "X-AUTH-TOKEN", "value": "" } ] }, "docs": "Get a list of supported TimeZones" } ] } ], "bundled": true }