{ "opencollection": "1.0.0", "info": { "name": "PureCloud Platform Agent Assistants Telephony Providers Edge API", "version": "v2" }, "items": [ { "info": { "name": "Telephony Providers Edge", "type": "folder" }, "items": [ { "info": { "name": "Validates a street address", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/addressvalidation" }, "docs": "Validates a street address" }, { "info": { "name": "Get the list of certificate authorities.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/certificateauthorities" }, "docs": "Get the list of certificate authorities." }, { "info": { "name": "Create a certificate authority.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/certificateauthorities" }, "docs": "Create a certificate authority." }, { "info": { "name": "Get a certificate authority.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/certificateauthorities/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate ID" } ] }, "docs": "Get a certificate authority." }, { "info": { "name": "Update a certificate authority.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/certificateauthorities/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate ID" } ] }, "docs": "Update a certificate authority." }, { "info": { "name": "Delete a certificate authority.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/certificateauthorities/:certificateId", "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "Certificate ID" } ] }, "docs": "Delete a certificate authority." }, { "info": { "name": "Get networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/ping", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Get networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Ping Request command to collect networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/ping", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Ping Request command to collect networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Get networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/tracepath", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Get networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Tracepath request command to collect networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/tracepath", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Tracepath request command to collect networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Get networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/nslookup", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Get networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Nslookup request command to collect networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/nslookup", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Nslookup request command to collect networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Get networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/route", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Get networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Route request command to collect networking-related information from an Edge for a target IP or host.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/diagnostic/route", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Route request command to collect networking-related information from an Edge for a target IP or host." }, { "info": { "name": "Reboot an Edge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/reboot", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Reboot an Edge" }, { "info": { "name": "Get edge.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated" } ] }, "docs": "Get edge." }, { "info": { "name": "Update a edge.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Update a edge." }, { "info": { "name": "Delete a edge.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Delete a edge." }, { "info": { "name": "Take an Edge in or out of service", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/statuscode", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Take an Edge in or out of service" }, { "info": { "name": "Gets software update status information about any edge.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/softwareupdate", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Gets software update status information about any edge." }, { "info": { "name": "Starts a software update for this edge.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/softwareupdate", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Starts a software update for this edge." }, { "info": { "name": "Cancels any in-progress update for this edge.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/softwareupdate", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Cancels any in-progress update for this edge." }, { "info": { "name": "Gets all the available software versions for this edge.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/softwareversions", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Gets all the available software versions for this edge." }, { "info": { "name": "Get a list of Edge-compatible time zones", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/timezones", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a list of Edge-compatible time zones" }, { "info": { "name": "Unpair an Edge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/unpair", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Unpair an Edge" }, { "info": { "name": "Get the edge version report.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgeversionreport" }, "docs": "The report will not have consistent data about the edge version(s) until all edges have been reset." }, { "info": { "name": "Get edge logical interfaces.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/logicalinterfaces", "params": [ { "name": "edgeIds", "value": "", "type": "query", "description": "Comma separated list of Edge Id's" }, { "name": "expand", "value": "", "type": "query", "description": "Field to expand in the response" } ] }, "docs": "Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time." }, { "info": { "name": "Get physical interfaces for edges.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/physicalinterfaces", "params": [ { "name": "edgeIds", "value": "", "type": "query", "description": "Comma separated list of Edge Id's" } ] }, "docs": "Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time." }, { "info": { "name": "Get the list of edges.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "site.id", "value": "", "type": "query", "description": "Filter by site.id" }, { "name": "edgeGroup.id", "value": "", "type": "query", "description": "Filter by edgeGroup.id" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "managed", "value": "", "type": "query", "description": "Filter by managed" }, { "name": "showCloudMedia", "value": "", "type": "query", "description": "True to show the cloud media devices in the result." } ] }, "docs": "Get the list of edges." }, { "info": { "name": "Create an edge.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges" }, "docs": "Create an edge." }, { "info": { "name": "Get an edge logical interface", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logicalinterfaces/:interfaceId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" }, { "name": "expand", "value": "", "type": "query", "description": "Field to expand in the response" } ] }, "docs": "Get an edge logical interface" }, { "info": { "name": "Update an edge logical interface.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logicalinterfaces/:interfaceId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" } ] }, "docs": "Update an edge logical interface." }, { "info": { "name": "Delete an edge logical interface", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logicalinterfaces/:interfaceId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" } ] }, "docs": "Delete an edge logical interface" }, { "info": { "name": "Get edge logical interfaces.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logicalinterfaces", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "expand", "value": "", "type": "query", "description": "Field to expand in the response" } ] }, "docs": "Retrieve a list of all configured logical interfaces from a specific edge." }, { "info": { "name": "Create an edge logical interface.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logicalinterfaces", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Create" }, { "info": { "name": "Get edge physical interface.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/physicalinterfaces/:interfaceId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "interfaceId", "value": "", "type": "path", "description": "Interface ID" } ] }, "docs": "Retrieve a physical interface from a specific edge." }, { "info": { "name": "Retrieve a list of all configured physical interfaces from a specific edge.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/physicalinterfaces", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Retrieve a list of all configured physical interfaces from a specific edge." }, { "info": { "name": "Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/alertablepresences", "params": [ { "name": "type", "value": "", "type": "query" } ] }, "docs": "Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list." }, { "info": { "name": "Creates or updates alertable presences overrides.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/alertablepresences" }, "docs": "Creates or updates alertable presences overrides." }, { "info": { "name": "Deletes alertable presences overrides.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/alertablepresences" }, "docs": "Deletes alertable presences overrides." }, { "info": { "name": "Get a DID Pool by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/didpools/:didPoolId", "params": [ { "name": "didPoolId", "value": "", "type": "path", "description": "DID pool ID" } ] }, "docs": "Get a DID Pool by ID." }, { "info": { "name": "Update a DID Pool by ID.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/didpools/:didPoolId", "params": [ { "name": "didPoolId", "value": "", "type": "path", "description": "DID pool ID" } ] }, "docs": "Update a DID Pool by ID." }, { "info": { "name": "Delete a DID Pool by ID.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/didpools/:didPoolId", "params": [ { "name": "didPoolId", "value": "", "type": "path", "description": "DID pool ID" } ] }, "docs": "Delete a DID Pool by ID." }, { "info": { "name": "Get a listing of unassigned and/or assigned numbers in a set of DID Pools.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/didpools/dids", "params": [ { "name": "type", "value": "", "type": "query", "description": "The type of numbers to return." }, { "name": "id", "value": "", "type": "query", "description": "Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned." }, { "name": "numberMatch", "value": "", "type": "query", "description": "A number to filter the results by." }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" } ] }, "docs": "Get a listing of unassigned and/or assigned numbers in a set of DID Pools." }, { "info": { "name": "Get a listing of DID Pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/didpools", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "id", "value": "", "type": "query", "description": "Filter by a specific list of ID's" } ] }, "docs": "Get a listing of DID Pools" }, { "info": { "name": "Create a new DID pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/didpools" }, "docs": "Create a new DID pool" }, { "info": { "name": "Get a DID by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/dids/:didId", "params": [ { "name": "didId", "value": "", "type": "path", "description": "DID ID" } ] }, "docs": "Get a DID by ID." }, { "info": { "name": "Get a listing of DIDs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/dids", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Filter by phoneNumber" }, { "name": "owner.id", "value": "", "type": "query", "description": "Filter by the owner of a phone number" }, { "name": "didPool.id", "value": "", "type": "query", "description": "Filter by the DID Pool assignment" }, { "name": "id", "value": "", "type": "query", "description": "Filter by a specific list of ID's" } ] }, "docs": "Get a listing of DIDs" }, { "info": { "name": "Get edge group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups/:edgeGroupId", "params": [ { "name": "edgeGroupId", "value": "", "type": "path", "description": "Edge group ID" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response" } ] }, "docs": "Get edge group." }, { "info": { "name": "Update an edge group.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups/:edgeGroupId", "params": [ { "name": "edgeGroupId", "value": "", "type": "path", "description": "Edge group ID" } ] }, "docs": "Update an edge group." }, { "info": { "name": "Delete an edge group.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups/:edgeGroupId", "params": [ { "name": "edgeGroupId", "value": "", "type": "path", "description": "Edge group ID" } ] }, "docs": "Delete an edge group." }, { "info": { "name": "Gets the edge trunk base associated with the edge group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups/:edgegroupId/edgetrunkbases/:edgetrunkbaseId", "params": [ { "name": "edgegroupId", "value": "", "type": "path", "description": "Edge Group ID" }, { "name": "edgetrunkbaseId", "value": "", "type": "path", "description": "Edge Trunk Base ID" } ] }, "docs": "Gets the edge trunk base associated with the edge group" }, { "info": { "name": "Update the edge trunk base associated with the edge group", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups/:edgegroupId/edgetrunkbases/:edgetrunkbaseId", "params": [ { "name": "edgegroupId", "value": "", "type": "path", "description": "Edge Group ID" }, { "name": "edgetrunkbaseId", "value": "", "type": "path", "description": "Edge Trunk Base ID" } ] }, "docs": "Update the edge trunk base associated with the edge group" }, { "info": { "name": "Get the list of edge groups.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "managed", "value": "", "type": "query", "description": "Filter by managed" } ] }, "docs": "Get the list of edge groups." }, { "info": { "name": "Create an edge group.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/edgegroups" }, "docs": "Create an edge group." }, { "info": { "name": "Get an extension pool by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensionpools/:extensionPoolId", "params": [ { "name": "extensionPoolId", "value": "", "type": "path", "description": "Extension pool ID" } ] }, "docs": "Get an extension pool by ID" }, { "info": { "name": "Update an extension pool by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensionpools/:extensionPoolId", "params": [ { "name": "extensionPoolId", "value": "", "type": "path", "description": "Extension pool ID" } ] }, "docs": "Update an extension pool by ID" }, { "info": { "name": "Delete an extension pool by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensionpools/:extensionPoolId", "params": [ { "name": "extensionPoolId", "value": "", "type": "path", "description": "Extension pool ID" } ] }, "docs": "Delete an extension pool by ID" }, { "info": { "name": "Get a pageable list of basic extension pool objects filterable by query parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensionpools/divisionviews", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "id", "value": "", "type": "query", "description": "ID of the Extension Pools to filter by." }, { "name": "name", "value": "", "type": "query", "description": "Name of the Extension Pools to filter by." }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch extension pools that match the given ID(s) and not use any additional supplied query parameters in the search." }, { "info": { "name": "Get a listing of extension pools", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensionpools", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "number", "value": "", "type": "query", "description": "Deprecated, filtering by number not supported" }, { "name": "divisionId", "value": "", "type": "query", "description": "List of divisionIds on which to filter." } ] }, "docs": "Get a listing of extension pools" }, { "info": { "name": "Create a new extension pool", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensionpools" }, "docs": "Create a new extension pool" }, { "info": { "name": "Get an extension by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensions/:extensionId", "params": [ { "name": "extensionId", "value": "", "type": "path", "description": "Extension ID" } ] }, "docs": "Get an extension by ID." }, { "info": { "name": "Get a listing of extensions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/extensions", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "number", "value": "", "type": "query", "description": "Filter by number" } ] }, "docs": "Get a listing of extensions" }, { "info": { "name": "Get a line base settings object by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/linebasesettings/:lineBaseId", "params": [ { "name": "lineBaseId", "value": "", "type": "path", "description": "Line base ID" } ] }, "docs": "Get a line base settings object by ID" }, { "info": { "name": "Get a listing of line base settings objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/linebasesettings", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Value by which to sort" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated" } ] }, "docs": "Get a listing of line base settings objects" }, { "info": { "name": "Get a Line by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/lines/:lineId", "params": [ { "name": "lineId", "value": "", "type": "path", "description": "Line ID" } ] }, "docs": "Get a Line by ID" }, { "info": { "name": "Get a list of Lines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/lines", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "sortBy", "value": "", "type": "query", "description": "Value by which to sort" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated. The edgeGroup value is deprecated." } ] }, "docs": "Get a list of Lines" }, { "info": { "name": "Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/lines/template", "params": [ { "name": "lineBaseSettingsId", "value": "", "type": "query", "description": "The id of a Line Base Settings object upon which to base this Line" } ] }, "docs": "Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance" }, { "info": { "name": "Get an Edge logs job.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logs/jobs/:jobId", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "jobId", "value": "", "type": "path", "description": "Job ID" } ] }, "docs": "Get an Edge logs job." }, { "info": { "name": "Request that the specified fileIds be uploaded from the Edge.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logs/jobs/:jobId/upload", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "jobId", "value": "", "type": "path", "description": "Job ID" } ] }, "docs": "Request that the specified fileIds be uploaded from the Edge." }, { "info": { "name": "Create a job to upload a list of Edge logs.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/logs/jobs", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Create a job to upload a list of Edge logs." }, { "info": { "name": "Get the edge metrics.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/metrics", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge Id" } ] }, "docs": "Get the edge metrics." }, { "info": { "name": "Get the metrics for a list of edges.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/metrics", "params": [ { "name": "edgeIds", "value": "", "type": "query", "description": "Comma separated list of Edge Id's. Maximum of 100 edge ids allowed." } ] }, "docs": "Get the metrics for a list of edges." }, { "info": { "name": "Get a list of Classifications for this Site", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/numberplans/classifications", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" }, { "name": "classification", "value": "", "type": "query", "description": "Classification" } ] }, "docs": "Get a list of Classifications for this Site" }, { "info": { "name": "Get a Number Plan by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/numberplans/:numberPlanId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" }, { "name": "numberPlanId", "value": "", "type": "path", "description": "Number Plan ID" } ] }, "docs": "Get a Number Plan by ID." }, { "info": { "name": "Get the list of Number Plans for this Site. Only fetches the first 200 records.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/numberplans", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Get the list of Number Plans for this Site. Only fetches the first 200 records." }, { "info": { "name": "Update the list of Number Plans. A user can update maximum 200 number plans at a time.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/numberplans", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Update the list of Number Plans. A user can update maximum 200 number plans at a time." }, { "info": { "name": "Get outbound routes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/outboundroutes", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "site.id", "value": "", "type": "query", "description": "Filter by site.id" }, { "name": "externalTrunkBases.ids", "value": "", "type": "query", "description": "Filter by externalTrunkBases.ids" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" } ] }, "docs": "Get outbound routes" }, { "info": { "name": "Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings/template", "params": [ { "name": "phoneMetabaseId", "value": "", "type": "query", "description": "The id of a metabase object upon which to base this Phone Base Settings" } ] }, "docs": "Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance" }, { "info": { "name": "Get a Phone Base Settings object by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings/:phoneBaseId", "params": [ { "name": "phoneBaseId", "value": "", "type": "path", "description": "Phone base ID" } ] }, "docs": "Get a Phone Base Settings object by ID" }, { "info": { "name": "Update a Phone Base Settings by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings/:phoneBaseId", "params": [ { "name": "phoneBaseId", "value": "", "type": "path", "description": "Phone base ID" } ] }, "docs": "Update a Phone Base Settings by ID" }, { "info": { "name": "Delete a Phone Base Settings by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings/:phoneBaseId", "params": [ { "name": "phoneBaseId", "value": "", "type": "path", "description": "Phone base ID" } ] }, "docs": "Delete a Phone Base Settings by ID" }, { "info": { "name": "Get a list of Phone Base Settings objects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Value by which to sort" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated" }, { "name": "name", "value": "", "type": "query", "description": "Name" } ] }, "docs": "Get a list of Phone Base Settings objects" }, { "info": { "name": "Create a new Phone Base Settings object", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings" }, "docs": "Create a new Phone Base Settings object" }, { "info": { "name": "Get a list of available makes and models to create a new Phone Base Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phonebasesettings/availablemetabases", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" } ] }, "docs": "Get a list of available makes and models to create a new Phone Base Settings" }, { "info": { "name": "Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones/template", "params": [ { "name": "phoneBaseSettingsId", "value": "", "type": "query", "description": "The id of a Phone Base Settings object upon which to base this Phone" } ] }, "docs": "Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance" }, { "info": { "name": "Get a Phone by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones/:phoneId", "params": [ { "name": "phoneId", "value": "", "type": "path", "description": "Phone ID" } ] }, "docs": "Get a Phone by ID" }, { "info": { "name": "Update a Phone by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones/:phoneId", "params": [ { "name": "phoneId", "value": "", "type": "path", "description": "Phone ID" } ] }, "docs": "Update a Phone by ID" }, { "info": { "name": "Delete a Phone by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones/:phoneId", "params": [ { "name": "phoneId", "value": "", "type": "path", "description": "Phone ID" } ] }, "docs": "Delete a Phone by ID" }, { "info": { "name": "Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "site.id", "value": "", "type": "query", "description": "Filter by site.id" }, { "name": "webRtcUser.id", "value": "", "type": "query", "description": "Filter by webRtcUser.id" }, { "name": "phoneBaseSettings.id", "value": "", "type": "query", "description": "Filter by phoneBaseSettings.id" }, { "name": "lines.loggedInUser.id", "value": "", "type": "query", "description": "Filter by lines.loggedInUser.id" }, { "name": "lines.defaultForUser.id", "value": "", "type": "query", "description": "Filter by lines.defaultForUser.id" }, { "name": "phone_hardwareId", "value": "", "type": "query", "description": "Filter by phone_hardwareId" }, { "name": "lines.id", "value": "", "type": "query", "description": "Filter by lines.id" }, { "name": "lines.name", "value": "", "type": "query", "description": "Filter by lines.name" }, { "name": "name", "value": "", "type": "query", "description": "Name of the Phone to filter by, comma-separated" }, { "name": "status.operationalStatus", "value": "", "type": "query", "description": "The primary status to filter by" }, { "name": "secondaryStatus.operationalStatus", "value": "", "type": "query", "description": "The secondary status to filter by" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated" }, { "name": "fields", "value": "", "type": "query", "description": "Fields and properties to get, comma-separated" } ] }, "docs": "Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values." }, { "info": { "name": "Create a new Phone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones" }, "docs": "Create a new Phone" }, { "info": { "name": "Reboot a Phone", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones/:phoneId/reboot", "params": [ { "name": "phoneId", "value": "", "type": "path", "description": "Phone Id" } ] }, "docs": "Reboot a Phone" }, { "info": { "name": "Reboot Multiple Phones", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/phones/reboot" }, "docs": "Reboot Multiple Phones" }, { "info": { "name": "List of edges more than 4 edge versions behind the latest software.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/expired" }, "docs": "List of edges more than 4 edge versions behind the latest software." }, { "info": { "name": "Get site connections for a site.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/siteconnections", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Get site connections for a site." }, { "info": { "name": "Update site connections for a site.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/siteconnections", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Update site connections for a site." }, { "info": { "name": "Disable site connections for a site.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/siteconnections", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Disable site connections for a site." }, { "info": { "name": "Get a Site by ID.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Get a Site by ID." }, { "info": { "name": "Update a Site by ID.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Update a Site by ID." }, { "info": { "name": "Delete a Site by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Delete a Site by ID" }, { "info": { "name": "Get the list of Sites.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "location.id", "value": "", "type": "query", "description": "Location Id" }, { "name": "managed", "value": "", "type": "query", "description": "Filter by managed" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated" } ] }, "docs": "Get the list of Sites." }, { "info": { "name": "Create a Site.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites" }, "docs": "Create a Site." }, { "info": { "name": "Search sites using the q64 value returned from a previous search", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/search", "params": [ { "name": "q64", "value": "", "type": "query", "description": "q64" }, { "name": "expand", "value": "", "type": "query", "description": "expand" } ] }, "docs": "Search sites using the q64 value returned from a previous search" }, { "info": { "name": "Search sites", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/search" }, "docs": "Search sites" }, { "info": { "name": "Get an outbound route", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/outboundroutes/:outboundRouteId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" }, { "name": "outboundRouteId", "value": "", "type": "path", "description": "Outbound route ID" } ] }, "docs": "Get an outbound route" }, { "info": { "name": "Update outbound route", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/outboundroutes/:outboundRouteId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" }, { "name": "outboundRouteId", "value": "", "type": "path", "description": "Outbound route ID" } ] }, "docs": "Update outbound route" }, { "info": { "name": "Delete Outbound Route", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/outboundroutes/:outboundRouteId", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" }, { "name": "outboundRouteId", "value": "", "type": "path", "description": "Outbound route ID" } ] }, "docs": "Delete Outbound Route" }, { "info": { "name": "Get outbound routes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/outboundroutes", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "name", "value": "", "type": "query", "description": "Name" }, { "name": "externalTrunkBases.ids", "value": "", "type": "query", "description": "externalTrunkBases.ids" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort by" } ] }, "docs": "Get outbound routes" }, { "info": { "name": "Create outbound route", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/sites/:siteId/outboundroutes", "params": [ { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ] }, "docs": "Create outbound route" }, { "info": { "name": "Get the trunk metrics.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunks/:trunkId/metrics", "params": [ { "name": "trunkId", "value": "", "type": "path", "description": "Trunk Id" } ] }, "docs": "Get the trunk metrics." }, { "info": { "name": "Get the metrics for a list of trunks.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunks/metrics", "params": [ { "name": "trunkIds", "value": "", "type": "query", "description": "Comma separated list of Trunk Id's" } ] }, "docs": "Get the metrics for a list of trunks." }, { "info": { "name": "Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings/template", "params": [ { "name": "trunkMetabaseId", "value": "", "type": "query", "description": "The id of a metabase object upon which to base this Trunk Base Settings" } ] }, "docs": "Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance" }, { "info": { "name": "Get a Trunk Base Settings object by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings/:trunkBaseSettingsId", "params": [ { "name": "trunkBaseSettingsId", "value": "", "type": "path", "description": "Trunk Base ID" }, { "name": "ignoreHidden", "value": "", "type": "query", "description": "Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only." } ] }, "docs": "Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission." }, { "info": { "name": "Update a Trunk Base Settings object by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings/:trunkBaseSettingsId", "params": [ { "name": "trunkBaseSettingsId", "value": "", "type": "path", "description": "Trunk Base ID" } ] }, "docs": "Update a Trunk Base Settings object by ID" }, { "info": { "name": "Delete a Trunk Base Settings object by ID", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings/:trunkBaseSettingsId", "params": [ { "name": "trunkBaseSettingsId", "value": "", "type": "path", "description": "Trunk Base ID" } ] }, "docs": "Delete a Trunk Base Settings object by ID" }, { "info": { "name": "Get Trunk Base Settings listing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Value by which to sort" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "recordingEnabled", "value": "", "type": "query", "description": "Filter trunks by recording enabled" }, { "name": "ignoreHidden", "value": "", "type": "query", "description": "Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only." }, { "name": "managed", "value": "", "type": "query", "description": "Filter by managed" }, { "name": "expand", "value": "", "type": "query", "description": "Fields to expand in the response, comma-separated" }, { "name": "name", "value": "", "type": "query", "description": "Name of the TrunkBase to filter by" } ] }, "docs": "Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission." }, { "info": { "name": "Create a Trunk Base Settings object", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings" }, "docs": "Create a Trunk Base Settings object" }, { "info": { "name": "Get a list of available makes and models to create a new Trunk Base Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "pageSize", "value": "", "type": "query" }, { "name": "pageNumber", "value": "", "type": "query" } ] }, "docs": "Get a list of available makes and models to create a new Trunk Base Settings" }, { "info": { "name": "Get Counts of trunks that have recording disabled or enabled", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunkswithrecording", "params": [ { "name": "trunkType", "value": "", "type": "query", "description": "The type of this trunk base." } ] }, "docs": "Get Counts of trunks that have recording disabled or enabled" }, { "info": { "name": "Get the list of available trunks for the given Edge.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/trunks", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" }, { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Value by which to sort" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "trunkBase.id", "value": "", "type": "query", "description": "Filter by Trunk Base Ids" }, { "name": "trunkType", "value": "", "type": "query", "description": "Filter by a Trunk type" } ] }, "docs": "Trunks are created by assigning trunk base settings to an Edge or Edge Group." }, { "info": { "name": "Get a Trunk by ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunks/:trunkId", "params": [ { "name": "trunkId", "value": "", "type": "path", "description": "Trunk ID" } ] }, "docs": "Get a Trunk by ID" }, { "info": { "name": "Get the list of available trunks.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/trunks", "params": [ { "name": "pageNumber", "value": "", "type": "query", "description": "Page number" }, { "name": "pageSize", "value": "", "type": "query", "description": "Page size" }, { "name": "sortBy", "value": "", "type": "query", "description": "Value by which to sort" }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sort order" }, { "name": "edge.id", "value": "", "type": "query", "description": "Filter by Edge Ids" }, { "name": "trunkBase.id", "value": "", "type": "query", "description": "Filter by Trunk Base Ids" }, { "name": "trunkType", "value": "", "type": "query", "description": "Filter by a Trunk type" } ] }, "docs": "Trunks are created by assigning trunk base settings to an Edge or Edge Group." }, { "info": { "name": "Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v2/telephony/providers/edges/:edgeId/setuppackage", "params": [ { "name": "edgeId", "value": "", "type": "path", "description": "Edge ID" } ] }, "docs": "Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge." } ] } ], "bundled": true }