{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Call Routing API", "version": "1.0.0" }, "items": [ { "info": { "name": "Call Routing", "type": "folder" }, "items": [ { "info": { "name": "Test Call Routing", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/actions/testCallRouting/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization in which we are validating a call routing." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates that an incoming call can be routed.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nTest call routing requires a full administrator auth token with a scope of `spark-admin:te" }, { "info": { "name": "Get Local Gateway Dial Plan Usage for a Trunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usageDialPlan", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk belongs." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the trunks according to the designated fields. Available sort fields are `name`, and `locationName`. Sort order is ascending by default" }, { "name": "name", "value": "LG1,LG2", "type": "query", "description": "Return the list of trunks matching the local gateway names" } ] }, "docs": "Get Local Gateway Dial Plan Usage for a Trunk.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Locations Using the Local Gateway as PSTN Connection Routing", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usagePstnConnection", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk belongs." } ] }, "docs": "Get Locations Using the Local Gateway as PSTN Connection Routing.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Route Groups Using the Local Gateway", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usageRouteGroup", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk belongs." } ] }, "docs": "Get Route Groups Using the Local Gateway.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get Local Gateway Usage Count", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usage", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk belongs." } ] }, "docs": "Get Local Gateway Usage Count\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Dial Patterns", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId/dialPatterns", "params": [ { "name": "dialPlanId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the dial plan being modified." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which dial plan belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify dial patterns for the Dial Plan.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nModifying a dial pattern requires a full administrator auth token with a scope of `spark-admin:te" }, { "info": { "name": "Validate a Dial Pattern", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/premisePstn/actions/validateDialPatterns/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which dial plan belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate a Dial Pattern.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nValidating a dial pattern requires a full administrator auth token with a scope of `spark-admin:telephony_config" }, { "info": { "name": "Read the List of Dial Plans", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List dial plans for this organization." }, { "name": "dialPlanName", "value": "dialPlanName", "type": "query", "description": "Return the list of dial plans matching the dial plan name." }, { "name": "routeGroupName", "value": "routeGroupName", "type": "query", "description": "Return the list of dial plans matching the Route group name.." }, { "name": "trunkName", "value": "trunkName", "type": "query", "description": "Return the list of dial plans matching the Trunk name.." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "dpName-asc|rnTest-desc|TRUNK-desc", "type": "query", "description": "Order the dial plans according to the designated fields. Available sort fields: `name`, `routeName`, `routeType`. Sort order is ascending by default" } ] }, "docs": "List all Dial Plans for the organization.\n\nDial plans route calls to on-premises destinations by use of the trunks or route groups with which the dial plan is associated. Multiple dial patterns can be defined as part of your dial plan. Dial plans are configured globally for an enterprise and apply to all users, regardless of location.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create a Dial Plan", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which dial plan belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nCreating a dial plan requires a full administrator auth token with a scope of `spark-admin:telep" }, { "info": { "name": "Get a Dial Plan", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId", "params": [ { "name": "dialPlanId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the dial plan." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which dial plan belongs." } ] }, "docs": "Get a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nRetrieving a dial plan requires a full or read-only administrator auth token with a scope of `spark" }, { "info": { "name": "Modify a Dial Plan", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId", "params": [ { "name": "dialPlanId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the dial plan being modified." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which dial plan belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nModifying a dial plan requires a full administrator auth token with a scope of `spark-admin:tele" }, { "info": { "name": "Delete a Dial Plan", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId", "params": [ { "name": "dialPlanId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the dial plan." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which dial plan belongs." } ] }, "docs": "Delete a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nDeleting a dial plan requires a full administrator auth token with a scope of `spark-admin:telep" }, { "info": { "name": "Validate Local Gateway FQDN and Domain for a Trunk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/actions/fqdnValidation/invoke", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which trunk types belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validate Local Gateway FQDN and Domain for the organization trunks.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nValidating Local Gateway FQDN and Domain requires a full administrator auth token with a scope of `spark-admin:telephony_config_wr" }, { "info": { "name": "Read the List of Trunks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List trunks for this organization." }, { "name": "name", "value": "LG1,LG2", "type": "query", "description": "Return the list of trunks matching the local gateway names." }, { "name": "locationName", "value": "Boston,SJ-1", "type": "query", "description": "Return the list of trunks matching the location names." }, { "name": "trunkType", "value": "REGISTERING", "type": "query", "description": "Return the list of trunks matching the trunk type." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the trunks according to the designated fields. Available sort fields: name, locationName. Sort order is ascending by default" } ] }, "docs": "List all Trunks for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create a Trunk", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nCreating a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Trunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which trunk belongs." } ] }, "docs": "Get a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving a trunk requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Trunk", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk being modified." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which trunk belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nModifying a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Trunk", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which trunk belongs." } ] }, "docs": "Delete a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nDeleting a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read the List of Trunk Types", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/trunkTypes", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk types belong." } ] }, "docs": "List all Trunk Types with Device Types for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Trunk Types are Registering or Certificate Based and are configured in Call Manager.\n\nRetrieving trunk types requires a full or rea" }, { "info": { "name": "Read the List of Routing Groups", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List route groups for this organization." }, { "name": "name", "value": "routeGroupName", "type": "query", "description": "Return the list of route groups matching the Route group name.." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|ROUTE_GROUP-desc", "type": "query", "description": "Order the route groups according to designated fields. Available sort orders are `asc` and `desc`." } ] }, "docs": "List all Route Groups for an organization. A Route Group is a group of trunks that allows further scale and redundancy with the connection to the premises.\n\nRetrieving this route group list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Route Group for a Organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route Group belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Route Group for the organization.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nCreating a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read a Route Group for a Organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg", "type": "path", "description": "Route Group for which details are being requested." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization of the Route Group." } ] }, "docs": "Reads a Route Group for the organization based on id.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nReading a Route Group requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Route Group for a Organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg", "type": "path", "description": "Route Group for which details are being requested." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization of the Route Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies an existing Route Group for an organization based on id.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nModifying a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Remove a Route Group from an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg", "type": "path", "description": "Route Group for which details are being requested." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization of the Route Group." } ] }, "docs": "Remove a Route Group from an Organization based on id.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nRemoving a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read the Usage of a Routing Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usage", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "ID of the requested Route group." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization associated with the specific route group." } ] }, "docs": "List the number of \"Call to\" on-premises Extensions, Dial Plans, PSTN Connections, and Route Lists used by a specific Route Group.\nUsers within Call to Extension locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing Trunk or Route Group.\nPSTN Connections may be a Cisco PSTN, a cloud-connected PSTN, or a premises-based PSTN (local gateway).\nDial Plans allow you to route calls to on-premises extensions via " }, { "info": { "name": "Read the Call to Extension Locations of a Routing Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usageCallToExtension", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "ID of the requested Route group." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization associated with specific route group." }, { "name": "locationName", "value": "locationName", "type": "query", "description": "Return the list of locations matching the location name." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`." } ] }, "docs": "List \"Call to\" on-premises Extension Locations for a specific route group. Users within these locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing trunk or route group.\n\nRetrieving this location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Read the Dial Plan Locations of a Routing Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usageDialPlan", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "ID of the requested Route group." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization associated with specific route group." }, { "name": "locationName", "value": "locationName", "type": "query", "description": "Return the list of locations matching the location name." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`." } ] }, "docs": "List Dial Plan Locations for a specific route group.\n\nDial Plans allow you to route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.\nA Dial Plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns. Specific dial patterns can be defined as part of your dial plan.\n\nRetrieving this location list requires a full or read-only administrato" }, { "info": { "name": "Read the PSTN Connection Locations of a Routing Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usagePstnConnection", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "ID of the requested Route group." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization associated with specific route group." }, { "name": "locationName", "value": "locationName", "type": "query", "description": "Return the list of locations matching the location name." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`." } ] }, "docs": "List PSTN Connection Locations for a specific route group. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN.\n\nRetrieving this Location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Read the Route Lists of a Routing Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usageRouteList", "params": [ { "name": "routeGroupId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg", "type": "path", "description": "ID of the requested Route group." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization associated with specific route group." }, { "name": "name", "value": "locationName", "type": "query", "description": "Return the list of locations matching the location name." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`." } ] }, "docs": "List Route Lists for a specific route group. Route Lists are a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving this list of Route Lists requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Read the List of Route Lists", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List all Route List for this organization." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the Route List according to the designated fields. Available sort fields are `name`, and `locationId`. Sort order is ascending by default" }, { "name": "name", "value": "LG1,LG2", "type": "query", "description": "Return the list of Route List matching the route list name." }, { "name": "locationId", "value": "36e1e3f5-ba81-44b4-9dd5-b22ee4f5022d", "type": "query", "description": "Return the list of Route Lists matching the location id." } ] }, "docs": "List all Route Lists for the organization.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving the Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create a Route List", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route List belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Route List for the organization.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nCreating a Route List requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Route List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId", "params": [ { "name": "routeListId", "value": "Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy", "type": "path", "description": "ID of the Route List." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route List belongs." } ] }, "docs": "Get a rout list details.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Route List", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId", "params": [ { "name": "routeListId", "value": "Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy", "type": "path", "description": "ID of the Route List." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route List belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify the details for a Route List.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Route List", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId", "params": [ { "name": "routeListId", "value": "cbd93770-e6a3-448b-9bdf-86dbad3918c2", "type": "path", "description": "ID of the Route List." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route List belongs." } ] }, "docs": "Delete a route list for a customer.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nDeleting a Route List requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Numbers assigned to a Route List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId/numbers", "params": [ { "name": "routeListId", "value": "cbd93770-e6a3-448b-9bdf-86dbad3918c2", "type": "path", "description": "ID of the Route List." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route List belongs." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "number", "value": "+2147891122", "type": "query", "description": "Number assigned to the route list." }, { "name": "order", "value": "number-asc|number-desc", "type": "query", "description": "Order the Route Lists according to number, ascending or descending." } ] }, "docs": "Get numbers assigned to a Route List\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Modify Numbers for Route List", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId/numbers", "params": [ { "name": "routeListId", "value": "cbd93770-e6a3-448b-9bdf-86dbad3918c2", "type": "path", "description": "ID of the Route List." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the Route List belongs." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify numbers for a specific Route List of a Customer.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Local Gateway Call to On-Premises Extension Usage for a Trunk", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usageCallToExtension", "params": [ { "name": "trunkId", "value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI", "type": "path", "description": "ID of the trunk." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization to which the trunk belongs." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "order", "value": "name-asc|locationName-desc", "type": "query", "description": "Order the trunks according to the designated fields. Available sort fields are `name`, and `locationName`. Sort order is ascending by default" }, { "name": "name", "value": "LG1,LG2", "type": "query", "description": "Return the list of trunks matching the local gateway names" } ] }, "docs": "Get local gateway call to on-premises extension usage for a trunk.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Retrieve the list of Translation Patterns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization containing the translation patterns." }, { "name": "limitToLocationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx", "type": "query", "description": "When a location ID is passed, then return only the corresponding location level translation patterns." }, { "name": "limitToOrgLevelEnabled", "value": "true", "type": "query", "description": "When set to be `true`, then return only the organization-level translation patterns." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of objects returned to this maximum count." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching objects." }, { "name": "order", "value": "name-asc|name-desc", "type": "query", "description": "Sort the list of translation patterns according to translation pattern name, ascending or descending." }, { "name": "name", "value": "Pattern1", "type": "query", "description": "Only return translation patterns with the matching `name`." }, { "name": "matchingPattern", "value": "+2323", "type": "query", "description": "Only return translation patterns with the matching `matchingPattern`." } ] }, "docs": "Retrieve a list of translation patterns for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create a Translation Pattern for an Organization", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization containing the translation pattern." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Retrieve a specific Translation Pattern for an Organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns/:translationId", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization containing the translation pattern." }, { "name": "translationId", "value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg", "type": "path", "description": "Retrieve the translation pattern with the matching ID." } ] }, "docs": "Retrieve the details of a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a specific Translation Pattern for an Organization", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns/:translationId", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization containing the translation pattern." }, { "name": "translationId", "value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg", "type": "path", "description": "Modify translation pattern with the matching ID." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Delete a specific Translation Pattern", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns/:translationId", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization containing the translation pattern." }, { "name": "translationId", "value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg", "type": "path", "description": "Delete a translation pattern with the matching ID." } ] }, "docs": "Delete a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Create a Translation Pattern for a Location", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Retrieve a specific Translation Pattern for a Location", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns/:translationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API." }, { "name": "translationId", "value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg", "type": "path", "description": "Unique identifier for the translation pattern." } ] }, "docs": "Retrieve a specific translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a specific Translation Pattern for a Location", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns/:translationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API." }, { "name": "translationId", "value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg", "type": "path", "description": "Unique identifier for the translation pattern." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a specific translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Delete a specific Translation Pattern for a Location", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns/:translationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API." }, { "name": "translationId", "value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg", "type": "path", "description": "Unique identifier for the translation pattern." } ] }, "docs": "Delete a specific translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope." } ] } ], "bundled": true }