{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book DECT Devices Settings API", "version": "1.0.0" }, "items": [ { "info": { "name": "DECT Devices Settings", "type": "folder" }, "items": [ { "info": { "name": "Create a DECT Network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd", "type": "path", "description": "Create a DECT network in this location." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create a DECT network in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a multi-cell DECT network for a given location.\n\nCreating a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get the List of DECT Networks for an organization", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/dectNetworks", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List of DECT networks in this organization." }, { "name": "name", "value": "Training-DectNetwork", "type": "query", "description": "List of DECT networks with this name." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "query", "description": "List of DECT networks at this location." } ] }, "docs": "Retrieves the list of DECT networks for an organization.\n\nDECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get DECT Network Details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Details of the DECT network at this location." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk", "type": "path", "description": "Details of the specified DECT network." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Details of the DECT network in this organization." } ] }, "docs": "Retrieves the details of a DECT network.\n\nDECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update DECT Network", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Update DECT network details in the specified location." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk=", "type": "path", "description": "Update DECT network details in the specified DECT network." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update DECT network details in the specified organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the details of a DECT network.\n\nDECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete DECT Network", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA", "type": "path", "description": "Delete the DECT network in the specified location." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk=", "type": "path", "description": "Delete the specified DECT network." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete the DECT network in the specified organization." } ] }, "docs": "Delete a DECT network.\n\nDECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a list of DECT Network Base Stations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/baseStations", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Location containing the DECT network." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk", "type": "path", "description": "Retrieve the list of base stations in the specified DECT network ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization containing the DECT network." } ] }, "docs": "Retrieve a list of base stations in a DECT Network.\n\nA DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell.\nA DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Multiple Base Stations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/baseStations", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Create a base station in this location." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA", "type": "path", "description": "Create a base station for the DECT network." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create a base station for a DECT network in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API is used to create multiple base stations in a DECT network in an organization.\n\nCreating base stations in a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete bulk DECT Network Base Stations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/baseStations", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Location containing the DECT network." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk", "type": "path", "description": "Delete all the base stations in the specified DECT network ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization containing the DECT network." } ] }, "docs": "Delete all the base stations in the DECT Network.\n\nA DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell.\nA DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get the details of a specific DECT Network Base Station", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/baseStations/:baseStationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Location containing the DECT network." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk", "type": "path", "description": "Retrieve details of a specific base station in the specified DECT network ID." }, { "name": "baseStationId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj", "type": "path", "description": "Retrieve details of the specific DECT base station ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization containing the DECT network." } ] }, "docs": "Retrieve details of a specific base station in the DECT Network.\n\nA DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell.\nA DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Delete a specific DECT Network Base Station", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/baseStations/:baseStationId", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1", "type": "path", "description": "Location containing the DECT network." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk", "type": "path", "description": "Delete a specific base station in the specified DECT network ID." }, { "name": "baseStationId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj", "type": "path", "description": "Delete the specific DECT base station ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization containing the DECT network." } ] }, "docs": "Delete a specific base station in the DECT Network.\n\nA DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell.\nA DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only. A DECT DBS-210 can have up to 254 base stations and supports up to 1000 lines of registration.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get List of Handsets for a DECT Network ID", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/handsets", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OAss", "type": "path", "description": "Location containing the DECT network." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk", "type": "path", "description": "Search handset details in the specified DECT network ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Organization containing the DECT network." }, { "name": "basestationId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX1NUQVRJT04vYzRhMTQxN2ItZGNiYi00MGMzLWE3YWQtNTY1MGZkZGRkNTNj", "type": "query", "description": "Search handset details in the specified DECT base station ID." }, { "name": "memberId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9jODhiZGIwNC1jZjU5LTRjMjMtODQ4OC00NTNhOTE3ZDFlMjk", "type": "query", "description": "ID of the member of the handset. Members can be of type PEOPLE, PLACE, or VIRTUAL_LINE." } ] }, "docs": "List all the handsets associated with a DECT Network ID.\n\nA handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.\nA member on line1 of a DECT handset can be of type PEOPLE or PLACE while a member on line2 of a DECT handset can be of type PEOPLE, PLACE, or VIRTUAL_LINE.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Add a Handset to a DECT Network", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/handsets", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrd", "type": "path", "description": "Add handset in this location." }, { "name": "dectNetworkId", "value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxNzf", "type": "path", "description": "A unique identifier for the DECT network." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Add handset in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a handset to a DECT network in a location in an organization.\n\nAdding a handset to a DECT network requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n