{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Features: Single Number Reach API", "version": "1.0.0" }, "items": [ { "info": { "name": "Features: Single Number Reach", "type": "folder" }, "items": [ { "info": { "name": "Get Single Number Reach Primary Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/locations/:locationId/singleNumberReach/availableNumbers", "params": [ { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg", "type": "path", "description": "Return the list of phone numbers for this location within the given organization. The maximum length is 36." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List numbers for this organization." }, { "name": "max", "value": "5", "type": "query", "description": "Limit the number of phone numbers returned to this maximum count. The default is 2000." }, { "name": "start", "value": "0", "type": "query", "description": "Start at the zero-based offset in the list of matching phone numbers. The default is 0." }, { "name": "phoneNumber", "value": "+12056852221,+12056852222", "type": "query", "description": "Filter phone numbers based on the comma-separated list provided in the `phoneNumber` array." } ] }, "docs": "List the service and standard PSTN numbers that are available to be assigned as the single number reach's primary phone number.\nThese numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.\n\nThe available numbers APIs help identify candidate numbers and their owning entities to simplify the assignment or association of these numbers to members or features.\n\nRetrieving this list requires a full, read-only or location administrator auth" }, { "info": { "name": "Create Single Number Reach For a Person", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/people/:personId/singleNumberReach/numbers", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Unique identifier for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a single number reach for a person in an organization.\n\nSingle number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.\n\nCreating a single number reach for a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Single Number Reach Settings For A Person", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/people/:personId/singleNumberReach", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Unique identifier for the person." } ] }, "docs": "Retrieve Single Number Reach settings for the given person.\n\nSingle number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.\n\nRetrieving Single number reach settings requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Single Number Reach Settings For A Person", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/singleNumberReach", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Unique identifier for the person." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Single number reach settings for a person.\n\nSingle number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.\n\nUpdating a single number reach settings for a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Update Single Number Reach Settings For A Number", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/people/:personId/singleNumberReach/numbers/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL1NJTkdMRV9OVU1CRVJfUkVBQ0gvT1RnNU56WTNPRGMyTlE9PQ", "type": "path", "description": "Unique identifier for single number reach." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Single number reach settings for a number.\n\nSingle number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.\n\nThe response returns an ID that can change if the phoneNumber is modified, as the ID contains base64 encoded phone number data.\n\nUpdating a single number reach settings for a number requires a full administrator or locat" }, { "info": { "name": "Delete A Single Number Reach Number", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/people/:personId/singleNumberReach/numbers/:id", "params": [ { "name": "personId", "value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M", "type": "path", "description": "Unique identifier for the person." }, { "name": "id", "value": "Y2lzY29zcGFyazovL3VzL1NJTkdMRV9OVU1CRVJfUkVBQ0gvT1RnNU56WTNPRGMyTlE9PQ", "type": "path", "description": "Unique identifier for single number reach." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Unique identifier for the organization." } ] }, "docs": "Delete Single number reach number for a person.\n\nSingle number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.\n\nDeleting a Single number reach number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." } ] } ], "bundled": true }