{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Virtual Line Call Settings API", "version": "1.0.0" }, "items": [ { "info": { "name": "Virtual Line Call Settings", "type": "folder" }, "items": [ { "info": { "name": "Read the List of Virtual Lines", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List virtual lines for this organization." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg2LWVhMzMtNDc2Ny1iMTBmLWQ2MWIyNzFhMDVlZg", "type": "query", "description": "Return the list of virtual lines matching these location ids. Example for multiple values - `?locationId=locId1&locationId=locId2`." }, { "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": "id", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY", "type": "query", "description": "Return the list of virtual lines matching these virtualLineIds. Example for multiple values - `?id=id1&id=id2`." }, { "name": "ownerName", "value": "Bob Smith", "type": "query", "description": "Return the list of virtual lines matching these owner names. Example for multiple values - `?ownerName=name1&ownerName=name2`." }, { "name": "phoneNumber", "value": "+15558675311", "type": "query", "description": "Return the list of virtual lines matching these phone numbers. Example for multiple values - `?phoneNumber=number1&phoneNumber=number2`." }, { "name": "locationName", "value": "Boston", "type": "query", "description": "Return the list of virtual lines matching the location names. Example for multiple values - `?locationName=loc1&locationName=loc2`." }, { "name": "order", "value": "lastName", "type": "query", "description": "Return the list of virtual lines based on the order. Default sort will be in an Ascending order. Maximum 3 orders allowed at a time. Example for multiple values - `?order=order1&order=order2`." }, { "name": "hasDeviceAssigned", "value": "true", "type": "query", "description": "If `true`, includes only virtual lines with devices assigned. When not explicitly specified, the default includes both virtual lines with devices assigned and not assigned." }, { "name": "hasExtensionAssigned", "value": "'true'", "type": "query", "description": "If `true`, includes only virtual lines with an extension assigned. When not explicitly specified, the default includes both virtual lines with extension assigned and not assigned." }, { "name": "hasDnAssigned", "value": "true", "type": "query", "description": "If `true`, includes only virtual lines with an assigned directory number, also known as a Dn. When not explicitly specified, the default includes both virtual lines with a Dn assigned and not assigned." } ] }, "docs": "List all Virtual Lines for the organization.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\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 Virtual Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Create the virtual line for this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create new Virtual Line for the given location.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nCreating a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Call Recording Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording", "params": [ { "name": "virtualLineId", "value": "db2eed3c-06b1-4d68-8b4e-7ab1585dfa53", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve Virtual Line's Call Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_read` scope." }, { "info": { "name": "Configure Call Recording Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callRecording", "params": [ { "name": "virtualLineId", "value": "db2eed3c-06b1-4d68-8b4e-7ab1585dfa53", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual profile resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure virtual line's Call Recording settings.\n\nThe Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Get Details for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve virtual line settings from this organization." } ] }, "docs": "Retrieve Virtual Line details.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving virtual line details requires a full or user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update virtual line settings from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nUpdating a virtual line requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`." }, { "info": { "name": "Delete a Virtual Line", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Delete the virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Delete the virtual line from this organization." } ] }, "docs": "Delete the designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nDeleting a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`." }, { "info": { "name": "Get Phone Number assigned for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/number", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve virtual line settings from this organization." } ] }, "docs": "Get details on the assigned phone number and extension for the virtual line.\n\nRetrieving virtual line phone number details requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Update Directory search for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/directorySearch", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Update virtual line settings from this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the directory search for a designated Virtual Line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nUpdating Directory search for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`." }, { "info": { "name": "Get List of Devices assigned for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/devices", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve virtual line settings from this organization." } ] }, "docs": "Retrieve Device details assigned for a virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Get List of DECT Networks Handsets for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/dectNetworks", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Retrieve virtual line settings from this organization." } ] }, "docs": "
Not supported for Webex for Government (FedRAMP)
\n\nRetrieve DECT Network details assigned for a virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.\n\nRetrieving the assigned device detials for a virtual line requires a full or user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Read Caller ID Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callerId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter, as the default is the same organization as the token used to access the API." } ] }, "docs": "Retrieve a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nRetrieving the caller ID settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Caller ID Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callerId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter, as the default is the same organization as the token used to access the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's Caller ID settings.\n\nCaller ID settings control how a virtual line's information is displayed when making outgoing calls.\n\nUpdating the caller ID settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Call Waiting Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callWaiting", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's Call Waiting settings.\n\nWith this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.\n\nRetrieving the call waiting settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Call Waiting Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callWaiting", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's Call Waiting settings.\n\nWith this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.\n\nUpdating the call waiting settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Call Forwarding Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callForwarding", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's Call Forwarding settings.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the virtual line is busy.\n\n+ When no answer - forwarding only occurs when you are away or not answering your phone.\n\nIn addition, the Business Continuity feature will send calls to a destination of your choice if your phone is no" }, { "info": { "name": "Configure Call Forwarding Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callForwarding", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's Call Forwarding settings.\n\nThree types of call forwarding are supported:\n\n+ Always - forwards all incoming calls to the destination you choose.\n\n+ When busy - forwards all incoming calls to the destination you chose while the phone is in use or the virtual line is busy.\n\n+ When no answer - forwarding only occurs when you are away or not answering your phone.\n\nIn addition, the Business Continuity feature will send calls to a destination of your choice if your phone is n" }, { "info": { "name": "Read Incoming Permission Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/incomingPermission", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's Incoming Permission settings.\n\nYou can change the incoming calling permissions for a virtual line if you want them to be different from your organization's default.\n\nRetrieving the incoming permission settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Incoming Permission Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/incomingPermission", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's Incoming Permission settings.\n\nYou can change the incoming calling permissions for a virtual line if you want them to be different from your organization's default.\n\nUpdating the incoming permission settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve a virtual line's Outgoing Calling Permissions Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's Outgoing Calling Permissions settings.\n\nOutgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a virtual line if you want them to be different from your organization's default.\n\nRetrieving the outgoing permission settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_" }, { "info": { "name": "Modify a virtual line's Outgoing Calling Permissions Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a virtual line's Outgoing Calling Permissions settings.\n\nOutgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings. You can change the outgoing calling permissions for a virtual line if you want them to be different from your organization's default.\n\nUpdating the outgoing permission settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Access Codes for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodes", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API." } ] }, "docs": "Retrieve the virtual line's access codes.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read" }, { "info": { "name": "Create Access Codes for a Virtual Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodes", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new access codes for the virtual line.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Modify Access Codes for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodes", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a virtual line's access codes.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Delete Access Codes for a Virtual Line", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/accessCodes", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API." } ] }, "docs": "Deletes all access codes for the virtual line.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Retrieve Transfer Numbers for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/autoTransferNumbers", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API." } ] }, "docs": "Retrieve the virtual line's transfer numbers.\n\nWhen calling a specific call type, this virtual line will be automatically transferred to another number. The virtual line assigned to the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers.\n\nThis API requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read" }, { "info": { "name": "Modify Transfer Numbers for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/autoTransferNumbers", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access the API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a virtual line's transfer numbers.\n\nWhen calling a specific call type, this virtual line will be automatically transferred to another number. The virtual line assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers.\n\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Retrieve Digit Patterns for a Virtual Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Get list of digit patterns for the virtual profile.\n\nDigit patterns are used to bypass permissions.\n\nRetrieving this list requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Create Digit Pattern for a Virtual Profile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new digit pattern for a virtual profile.\n\nDigit patterns are used to bypass permissions.\n\nCreating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Modify the Digit Pattern Category Control Settings for a Virtual Profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies whether this virtual profile uses the specified digit patterns when placing outbound calls or not.\n\nUpdating the digit pattern category control settings requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete all Digit Patterns for a Virtual Profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Delete all digit patterns for a virtual profile.\n\nDigit patterns are used to bypass permissions.\n\nDeleting the digit patterns requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Specified Digit Pattern Details for a Virtual Profile", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Get the specified digit pattern for the virtual profile​.\n\nDigit patterns are used to bypass permissions.\n\nRetrieving the digit pattern details requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify a Digit Pattern for a Virtual Profile", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a digit patterns for a virtual profile.\n\nDigit patterns are used to bypass permissions.\n\nUpdating the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Delete a Digit Pattern for a Virtual Profile", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/outgoingPermission/digitPatterns/:digitPatternId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "digitPatternId", "value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3", "type": "path", "description": "Unique identifier for the digit pattern." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Delete a digit pattern for a virtual profile.\n\nDigit patterns are used to bypass permissions.\n\nDeleting the digit pattern requires a full or user or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Call Intercept Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/intercept", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieves Virtual Line's Call Intercept settings.\n\nThe intercept feature gracefully takes a virtual line's phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified virtual line are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nRetrieving the intercept settings for a virtual line" }, { "info": { "name": "Configure Call Intercept Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/intercept", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configures a virtual line's Call Intercept settings.\n\nThe intercept feature gracefully takes a virtual line's phone out of service, while providing callers with informative announcements and alternative routing options. Depending on the service configuration, none, some, or all incoming calls to the specified virtual line are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nUpdating the intercept settings for a virtual lin" }, { "info": { "name": "Configure Call Intercept Greeting for a Virtual Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/intercept/actions/announcementUpload/invoke", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Update settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the person resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Configure a virtual line's Call Intercept Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nUploading the intercept greeting announcement for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**WARNING:** This API is not callable using the developer portal web interface due to the la" }, { "info": { "name": "Retrieve Agent's List of Available Caller IDs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/agent/availableCallerIds", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI", "type": "path", "description": "Unique identifier for the Virtual Line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the Virtual Line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Get the list of call queues and hunt groups available for caller ID use by this virtual line as an agent.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`." }, { "info": { "name": "Retrieve Agent's Caller ID Information", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/agent/callerId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q", "type": "path", "description": "Unique identifier for the Virtual Line." } ] }, "docs": "Retrieve the Agent's Caller ID Information.\n\nEach agent will be able to set their outgoing Caller ID as either the Call Queue's Caller ID, Hunt Group's Caller ID or their own configured Caller ID.\n\nThis API requires a full admin or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Modify Agent's Caller ID Information", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/agent/callerId", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q", "type": "path", "description": "Unique identifier for the Virtual Line." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify Agent's Caller ID Information.\n\nEach Agent is able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or the Hunt Group's Caller ID or their own configured Caller ID.\nThis API requires a full or user administrator auth token with the `spark-admin:telephony_config_write` scope." }, { "info": { "name": "Read Voicemail Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/voicemail", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nRetrieving the voicemail settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Voicemail Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/voicemail", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nUpdating the voicemail settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Configure Busy Voicemail Greeting for a Virtual Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/voicemail/actions/uploadBusyGreeting/invoke", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Configure a virtual line's Busy Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nUploading the voicemail busy greeting announcement for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**WARNING:** This API is not callable using the developer portal web interface due to t" }, { "info": { "name": "Configure No Answer Voicemail Greeting for a Virtual Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/voicemail/actions/uploadNoAnswerGreeting/invoke", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Configure a virtual line's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, `.wav`, encoded audio file.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nUploading the voicemail no answer greeting announcement for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**WARNING:** This API is not callable using the developer portal web interfac" }, { "info": { "name": "Reset Voicemail PIN for a Virtual Line", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/voicemail/actions/resetPin/invoke", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Reset a voicemail PIN for a virtual line.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages.\n\nUpdating the voicemail pin for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: This API is expected to have an empty request body and Content-Type header should be set to `application/" }, { "info": { "name": "Modify a virtual line's voicemail passcode", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/voicemail/passcode", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS8wMzgzOWU1Mi03YTk0LTQ4MTgtYTliMC05YzJiMjBkYzRiZWY", "type": "path", "description": "Modify voicemail passcode for this virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "Modify voicemail passcode for a virtual line in this organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify a virtual line's voicemail passcode.\n\nModifying a virtual line's voicemail passcode requires a full administrator, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Retrieve Music On Hold Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/musicOnHold", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve the virtual line's music on hold settings.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nRetrieving the music on hold settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Music On Hold Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/musicOnHold", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's music on hold settings.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nTo configure music on hold settings for a virtual line, music on hold setting must be enabled for this location.\n\nUpdating the music on hold settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Push-to-Talk Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/pushToTalk", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's Push-to-Talk settings.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.\n\nRetrieving the Push-to-Talk settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Push-to-Talk Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/pushToTalk", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's Push-to-Talk settings.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.\n\nUpdating the Push-to-Talk settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Call Bridge Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callBridge", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's call bridge settings.\n\nRetrieving the call bridge settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Call Bridge Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callBridge", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's call bridge settings.\n\nUpdating the call bridge settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Read Barge In Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/bargeIn", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Retrieve a virtual line's barge in settings.\n\nThe Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.\n\nRetrieving the barge in settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure Barge In Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/bargeIn", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's barge in settings.\n\nThe Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.\n\nUpdating the barge in settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get a Virtual Line's Privacy Settings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/privacy", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ] }, "docs": "Get a virtual line's privacy settings for the specified virtual line ID.\n\nThe privacy feature enables the virtual line's line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nRetrieving the privacy settings for a virtual line requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`." }, { "info": { "name": "Configure a Virtual Line's Privacy Settings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/privacy", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85Y2JmYjYxZi00ZGM0LTQ1NWItYmMzYS00NmI4YmY5YjQzNzk", "type": "path", "description": "Retrieve settings for a virtual line with the matching ID." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization in which the virtual line resides. Only admin users of another organization (such as partners) may use this parameter as the default is the same organization as the token used to access API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Configure a virtual line's privacy settings for the specified virtual line ID.\n\nThe privacy feature enables the virtual line's line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nUpdating the privacy settings for a virtual line requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`." }, { "info": { "name": "Get Virtual Line Fax Message Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/faxMessage/availableNumbers", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY", "type": "path", "description": "Unique identifier for the virtual line." }, { "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 standard numbers that are available to be assigned as a virtual line's FAX message number.\nThese numbers are associated with the location of the virtual line 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 or read-only administrator auth token with a scope of" }, { "info": { "name": "Get Virtual Line Call Forward Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callForwarding/availableNumbers", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY", "type": "path", "description": "Unique identifier for the virtual line." }, { "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." }, { "name": "ownerName", "value": "Test", "type": "query", "description": "Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255." }, { "name": "extension", "value": "1234", "type": "query", "description": "Returns the list of PSTN phone numbers with the given `extension`." } ] }, "docs": "List the service and standard PSTN numbers that are available to be assigned as a virtual line's call forward number.\nThese numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity.\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 or read-only " }, { "info": { "name": "Get Virtual Line Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/availableNumbers", "params": [ { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "List numbers for this organization." }, { "name": "locationId", "value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg", "type": "query", "description": "Return the list of phone numbers for this location within the given organization. The maximum length is 36." }, { "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 standard numbers that are available to be assigned as a virtual line's phone number.\nBy default, this API returns unassigned numbers from all locations. To select the suitable number for assignment, ensure the virtual line's location ID is provided as the `locationId` request parameter.\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 " }, { "info": { "name": "Get Virtual Line ECBN Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/emergencyCallbackNumber/availableNumbers", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY", "type": "path", "description": "Unique identifier for the virtual line." }, { "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." }, { "name": "ownerName", "value": "Test", "type": "query", "description": "Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255." } ] }, "docs": "List standard numbers that can be assigned as a virtual line's call forward number.\nThese numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity.\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 or read-only administrator auth token with a sc" }, { "info": { "name": "Get Virtual Line Call Intercept Available Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/callIntercept/availableNumbers", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY", "type": "path", "description": "Unique identifier for the virtual line." }, { "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." }, { "name": "ownerName", "value": "Test", "type": "query", "description": "Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255." }, { "name": "extension", "value": "1234", "type": "query", "description": "Returns the list of PSTN phone numbers with the given `extension`." } ] }, "docs": "List the service and standard PSTN numbers that are available to be assigned as a virtual line's call intercept number.\nThese numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity.\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 " }, { "info": { "name": "Retrieve DoNotDisturb Settings for a Virtual Line", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/doNotDisturb", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the virtual line resides." } ] }, "docs": "Retrieve DoNotDisturb Settings for a Virtual Line.\n\nSilence incoming calls with the Do Not Disturb feature.\nWhen enabled, callers hear the busy signal.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `telephony_config_read`." }, { "info": { "name": "Modify DoNotDisturb Settings for a Virtual Line", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/doNotDisturb", "params": [ { "name": "virtualLineId", "value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=", "type": "path", "description": "Unique identifier for the virtual line." }, { "name": "orgId", "value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE", "type": "query", "description": "ID of the organization within which the virtual line resides." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify DoNotDisturb Settings for a Virtual Line.\n\nSilence incoming calls with the Do Not Disturb feature.\nWhen enabled, callers hear the busy signal.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:telephony_config_write` scope." } ] } ], "bundled": true }