Adding a DECT handset t"
},
{
"info": {
"name": "GET List of DECT networks associated with a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/dectNetworks",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "path",
"description": "List of DECT networks associated with this person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List of DECT networks associated with a person in this organization."
}
]
},
"docs": "Retrieves the list of DECT networks for a person in an organization.\n\nDECT Network provides roaming voice services via base stations and wireless handsets. 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 List of DECT networks associated with a workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/dectNetworks",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "path",
"description": "List of DECT networks associated with this workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List of DECT networks associated with a workspace in this organization."
}
]
},
"docs": "Retrieves the list of DECT networks for a workspace in an organization.\n\nDECT Network provides roaming voice services via base stations and wireless handsets. 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": "Search Available Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/availableMembers",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Search members in this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
},
{
"name": "memberName",
"value": "John",
"type": "query",
"description": "Search (Contains) numbers based on member name."
},
{
"name": "phoneNumber",
"value": "+19828282867",
"type": "query",
"description": "Search (Contains) based on number."
},
{
"name": "extension",
"value": "1234",
"type": "query",
"description": "Search (Contains) based on extension."
},
{
"name": "order",
"value": "lname",
"type": "query",
"description": "Sort the list of available members on the device in ascending order by name, using either last name `lname` or first name `fname`. Default sort is the last name in ascending order."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTrk",
"type": "query",
"description": "List members for the location ID."
},
{
"name": "excludeVirtualLine",
"value": "true",
"type": "query",
"description": "If true, search results will exclude virtual lines in the member list. NOTE: Virtual lines cannot be assigned as the primary line."
},
{
"name": "usageType",
"value": "SHARED_LINE",
"type": "query",
"description": "Search for members eligible to become the owner of the device, or share line on the device."
}
]
},
"docs": "List the members that are available to be assigned to DECT handset lines.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Generate and Enable DECT Serviceability Password",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/serviceabilityPassword/actions/generate/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "dectNetworkId",
"value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk=",
"type": "path",
"description": "Unique identifier for the DECT network."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Generates and enables a 16-character DECT serviceability password.\n\nGenerating a password and transmitting it to the DECT network can reboot the entire network. Be sure you choose an appropriate time to generate a new password.
\n\nThe DECT serviceability password, also known as the admin override password, provides read/write access to DECT base stations for performing system serviceability and troubleshooting functions.\n\nThis API requires either a full"
},
{
"info": {
"name": "Get DECT Serviceability Password status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/serviceabilityPassword",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "dectNetworkId",
"value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk=",
"type": "path",
"description": "Unique identifier for the DECT network."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieves the DECT serviceability password status.\n\nIf the serviceability password is enabled but has not been generated, the `enabled` status will be returned as `true` even though there is no active serviceability password.
\n\nThe DECT serviceability password, also known as the admin override password, provides read/write access to DECT base stations for performing system serviceability and troubleshooting functions.\n\nThis API requires an auth token with"
},
{
"info": {
"name": "Update DECT Serviceability Password status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/dectNetworks/:dectNetworkId/serviceabilityPassword",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "dectNetworkId",
"value": "Y2lzY29zcGFyazovL3VzL0RFQ1RfREVWX05FVC9iNWNhZWVkMi0yYTJlLTQ0NTQtYjU3Yy1jMWFhMTk4MTBiMDk=",
"type": "path",
"description": "Unique identifier for the DECT network."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Enables or disables the DECT serviceability password.\n\nEnabling or disabling the password and transmitting it to the DECT network can reboot the entire network. Be sure you choose an appropriate time for this action.
\n\nIf enabling is requested, but the serviceability password has not been generated, we will not actively reject the request even though there is no serviceability password.
\n\nThe DECT serviceability"
}
]
},
{
"info": {
"name": "Call Controls",
"type": "folder"
},
"items": [
{
"info": {
"name": "Dial",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/dial",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial. Alerts occur on all the devices belonging to a user unless an optional endpointId is specified in which case only the device or application identified by the endpointId is alerted. When a user answers an alerting device, an outbound call is placed from that device to the destination."
},
{
"info": {
"name": "Answer",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/answer",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API."
},
{
"info": {
"name": "Reject",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/reject",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Reject an unanswered incoming call."
},
{
"info": {
"name": "Hangup",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/hangup",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy."
},
{
"info": {
"name": "Hold",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/hold",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Hold a connected call."
},
{
"info": {
"name": "Resume",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/resume",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Resume a held call."
},
{
"info": {
"name": "Mute",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/mute",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Mute a call. This API can only be used for a call that reports itself as mute capable via the muteCapable field in the call details."
},
{
"info": {
"name": "Unmute",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/unmute",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Unmute a call. This API can only be used for a call that reports itself as mute capable via the muteCapable field in the call details."
},
{
"info": {
"name": "Divert",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/divert",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Divert a call to a destination or a user's voicemail. This is also commonly referred to as a Blind Transfer."
},
{
"info": {
"name": "Transfer",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/transfer",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Transfer two calls together.\n\nUnanswered incoming calls cannot be transferred but can be diverted using the divert API.\n\nIf the user has only two calls and wants to transfer them together, the `callId1` and `callId2` parameters are optional and when not provided the calls are automatically selected and transferred.\n\nIf the user has more than two calls and wants to transfer two of them together, the `callId1` and `callId2` parameters are mandatory to specify which calls are being transferred. Tho"
},
{
"info": {
"name": "Park",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/park",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Park a connected call. The number field in the response can be used as the destination for the retrieve command to retrieve the parked call."
},
{
"info": {
"name": "Retrieve",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/retrieve",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieve a parked call. A new call is initiated to perform the retrieval in a similar manner to the dial command. The number field from the park command response can be used as the destination for the retrieve command."
},
{
"info": {
"name": "Start Recording",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/startRecording",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Start recording a call. Use of this API is only valid when the user's call recording mode is set to \"On Demand\"."
},
{
"info": {
"name": "Stop Recording",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/stopRecording",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Stop recording a call. Use of this API is only valid when a call is being recorded and the user's call recording mode is set to \"On Demand\"."
},
{
"info": {
"name": "Pause Recording",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/pauseRecording",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Pause recording on a call. Use of this API is only valid when a call is being recorded and the user's call recording mode is set to \"On Demand\" or \"Always with Pause/Resume\"."
},
{
"info": {
"name": "Resume Recording",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/resumeRecording",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Resume recording a call. Use of this API is only valid when a call's recording is paused and the user's call recording mode is set to \"On Demand\" or \"Always with Pause/Resume\"."
},
{
"info": {
"name": "Transmit DTMF",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/transmitDtmf",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Transmit DTMF digits to a call."
},
{
"info": {
"name": "Push",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/push",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Pushes a call from the assistant to the executive the call is associated with. Use of this API is only valid when the assistant's call is associated with an executive."
},
{
"info": {
"name": "Pickup",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/pickup",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Picks up an incoming call to another user. A new call is initiated to perform the pickup in a similar manner to the dial command. When target is not present, the API pickups up a call from the user's call pickup group. When target is present, the API pickups an incoming call from the specified target user."
},
{
"info": {
"name": "Barge In",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/bargeIn",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Barge-in on another user's answered call. A new call is initiated to perform the barge-in in a similar manner to the dial command."
},
{
"info": {
"name": "List Calls",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/calls",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Get the list of details for all active calls associated with the user."
},
{
"info": {
"name": "Get Call Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/calls/:callId",
"params": [
{
"name": "callId",
"value": "string",
"type": "path",
"description": "The call identifier of the call."
},
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Get the details of the specified active call for the user."
},
{
"info": {
"name": "List Call History",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/calls/history",
"params": [
{
"name": "type",
"value": "placed",
"type": "query",
"description": "The type of call history records to retrieve. If not specified, then all call history records are retrieved."
}
]
},
"docs": "Get the list of call history records for the user. A maximum of 20 call history records per type (`placed`, `missed`, `received`) are returned."
},
{
"info": {
"name": "Pull",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/pull",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Pull a call from one device to another. A temporary new call is initiated to perform the call pull in a similar manner to the dial command. When a user answers an alerting device, the device is connected to the pulled call and the new call created for the call pull is released."
},
{
"info": {
"name": "Dial by Member ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/members/:memberId/dial",
"params": [
{
"name": "memberId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "Unique identifier for the member. Member ID can be one of the following: person, workspace, or virtual line"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE=",
"type": "query",
"description": "Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial. Alerts occur on all the devices belonging to a user unless an optional endpointId is specified in which case only the device or application identified by the endpointId is alerted. When a user answers an alerting device, an outbound call is placed from that device to the destination."
},
{
"info": {
"name": "Answer by Member ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/members/:memberId/answer",
"params": [
{
"name": "memberId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "Unique identifier for the member. Member ID can be one of the following: person, workspace, or virtual line"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE=",
"type": "query",
"description": "Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId. The answer API is rejected if the device is not alerting for the call or the device does not support answer via API."
},
{
"info": {
"name": "Hangup by Member ID",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/calls/members/:memberId/hangup",
"params": [
{
"name": "memberId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "Unique identifier for the member. Member ID can be one of the following: person, workspace, or virtual line"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE=",
"type": "query",
"description": "Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy."
},
{
"info": {
"name": "List Calls by Member ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/calls/members/:memberId/calls",
"params": [
{
"name": "memberId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "Unique identifier for the member. Member ID can be one of the following: person, workspace, or virtual line"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE=",
"type": "query",
"description": "Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization."
}
]
},
"docs": "Get the list of details for all active calls associated with the member."
},
{
"info": {
"name": "Get Call Details by Member ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/calls/members/:memberId/calls/:callId",
"params": [
{
"name": "memberId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "Unique identifier for the member. Member ID can be one of the following: person, workspace, or virtual line"
},
{
"name": "callId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA",
"type": "path",
"description": "The call identifier of the call."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE=",
"type": "query",
"description": "Id of the organization to which the member belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization."
}
]
},
"docs": "Get the details of the specified active call for the member."
}
]
},
{
"info": {
"name": "External Voicemail",
"type": "folder"
},
"items": [
{
"info": {
"name": "Set or Clear Message Waiting Indicator (MWI) Status",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/externalVoicemail/mwi",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "query",
"description": "Unique identifier for the user or workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE=",
"type": "query",
"description": "Id of the organization to which the user or workspace belongs. If not provided, the orgId of the Service App is used. If provided, the organization must be the same as or managed by the Service App's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Enables an external voicemail service to SET or CLEAR the Message Waiting Indicator (MWI) for a person or workspace.\n\nInvoke the API using a bearer token from a Service App in the target organization, created by a full admin with the scope `spark-admin:calls_write`.\n\nSpecify the target user or workspace with the required `id` query parameter.\n\nOptionally, use the orgId parameter to indicate the organization; if omitted, the Service App’s organization is used.\n\nIf `orgId` is provided, it must mat"
}
]
},
{
"info": {
"name": "Call Routing",
"type": "folder"
},
"items": [
{
"info": {
"name": "Test Call Routing",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/actions/testCallRouting/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which we are validating a call routing."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validates that an incoming call can be routed.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nTest call routing requires a full administrator auth token with a scope of `spark-admin:te"
},
{
"info": {
"name": "Get Local Gateway Dial Plan Usage for a Trunk",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usageDialPlan",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk belongs."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the trunks according to the designated fields. Available sort fields are `name`, and `locationName`. Sort order is ascending by default"
},
{
"name": "name",
"value": "LG1,LG2",
"type": "query",
"description": "Return the list of trunks matching the local gateway names"
}
]
},
"docs": "Get Local Gateway Dial Plan Usage for a Trunk.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Locations Using the Local Gateway as PSTN Connection Routing",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usagePstnConnection",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk belongs."
}
]
},
"docs": "Get Locations Using the Local Gateway as PSTN Connection Routing.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Route Groups Using the Local Gateway",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usageRouteGroup",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk belongs."
}
]
},
"docs": "Get Route Groups Using the Local Gateway.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Local Gateway Usage Count",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usage",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk belongs."
}
]
},
"docs": "Get Local Gateway Usage Count\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Dial Patterns",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId/dialPatterns",
"params": [
{
"name": "dialPlanId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the dial plan being modified."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which dial plan belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify dial patterns for the Dial Plan.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nModifying a dial pattern requires a full administrator auth token with a scope of `spark-admin:te"
},
{
"info": {
"name": "Validate a Dial Pattern",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/premisePstn/actions/validateDialPatterns/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which dial plan belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a Dial Pattern.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nValidating a dial pattern requires a full administrator auth token with a scope of `spark-admin:telephony_config"
},
{
"info": {
"name": "Read the List of Dial Plans",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List dial plans for this organization."
},
{
"name": "dialPlanName",
"value": "dialPlanName",
"type": "query",
"description": "Return the list of dial plans matching the dial plan name."
},
{
"name": "routeGroupName",
"value": "routeGroupName",
"type": "query",
"description": "Return the list of dial plans matching the Route group name.."
},
{
"name": "trunkName",
"value": "trunkName",
"type": "query",
"description": "Return the list of dial plans matching the Trunk name.."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "dpName-asc|rnTest-desc|TRUNK-desc",
"type": "query",
"description": "Order the dial plans according to the designated fields. Available sort fields: `name`, `routeName`, `routeType`. Sort order is ascending by default"
}
]
},
"docs": "List all Dial Plans for the organization.\n\nDial plans route calls to on-premises destinations by use of the trunks or route groups with which the dial plan is associated. Multiple dial patterns can be defined as part of your dial plan. Dial plans are configured globally for an enterprise and apply to all users, regardless of location.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Dial Plan",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which dial plan belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nCreating a dial plan requires a full administrator auth token with a scope of `spark-admin:telep"
},
{
"info": {
"name": "Get a Dial Plan",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId",
"params": [
{
"name": "dialPlanId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the dial plan."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which dial plan belongs."
}
]
},
"docs": "Get a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nRetrieving a dial plan requires a full or read-only administrator auth token with a scope of `spark"
},
{
"info": {
"name": "Modify a Dial Plan",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId",
"params": [
{
"name": "dialPlanId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the dial plan being modified."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which dial plan belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nModifying a dial plan requires a full administrator auth token with a scope of `spark-admin:tele"
},
{
"info": {
"name": "Delete a Dial Plan",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId",
"params": [
{
"name": "dialPlanId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the dial plan."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which dial plan belongs."
}
]
},
"docs": "Delete a Dial Plan for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nDeleting a dial plan requires a full administrator auth token with a scope of `spark-admin:telep"
},
{
"info": {
"name": "Validate Local Gateway FQDN and Domain for a Trunk",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/actions/fqdnValidation/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which trunk types belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate Local Gateway FQDN and Domain for the organization trunks.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nValidating Local Gateway FQDN and Domain requires a full administrator auth token with a scope of `spark-admin:telephony_config_wr"
},
{
"info": {
"name": "Read the List of Trunks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List trunks for this organization."
},
{
"name": "name",
"value": "LG1,LG2",
"type": "query",
"description": "Return the list of trunks matching the local gateway names."
},
{
"name": "locationName",
"value": "Boston,SJ-1",
"type": "query",
"description": "Return the list of trunks matching the location names."
},
{
"name": "trunkType",
"value": "REGISTERING",
"type": "query",
"description": "Return the list of trunks matching the trunk type."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the trunks according to the designated fields. Available sort fields: name, locationName. Sort order is ascending by default"
}
]
},
"docs": "List all Trunks for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Trunk",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nCreating a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get a Trunk",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which trunk belongs."
}
]
},
"docs": "Get a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving a trunk requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Trunk",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk being modified."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which trunk belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nModifying a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Trunk",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which trunk belongs."
}
]
},
"docs": "Delete a Trunk for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group - a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nDeleting a trunk requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the List of Trunk Types",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/trunkTypes",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk types belong."
}
]
},
"docs": "List all Trunk Types with Device Types for the organization.\n\nA Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy. Trunk Types are Registering or Certificate Based and are configured in Call Manager.\n\nRetrieving trunk types requires a full or rea"
},
{
"info": {
"name": "Read the List of Routing Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List route groups for this organization."
},
{
"name": "name",
"value": "routeGroupName",
"type": "query",
"description": "Return the list of route groups matching the Route group name.."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|ROUTE_GROUP-desc",
"type": "query",
"description": "Order the route groups according to designated fields. Available sort orders are `asc` and `desc`."
}
]
},
"docs": "List all Route Groups for an organization. A Route Group is a group of trunks that allows further scale and redundancy with the connection to the premises.\n\nRetrieving this route group list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create Route Group for a Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route Group belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a Route Group for the organization.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nCreating a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read a Route Group for a Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg",
"type": "path",
"description": "Route Group for which details are being requested."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
]
},
"docs": "Reads a Route Group for the organization based on id.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nReading a Route Group requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Route Group for a Organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg",
"type": "path",
"description": "Route Group for which details are being requested."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modifies an existing Route Group for an organization based on id.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nModifying a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Remove a Route Group from an Organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1JPVVRFX0dST1VQLzE4YzFhMGRkLWJhMjctNDkwMS1hNGUxLTBlNWIyNzM1YzlkZg",
"type": "path",
"description": "Route Group for which details are being requested."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
]
},
"docs": "Remove a Route Group from an Organization based on id.\n\nA Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.\n\nRemoving a Route Group requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the Usage of a Routing Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usage",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "ID of the requested Route group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization associated with the specific route group."
}
]
},
"docs": "List the number of \"Call to\" on-premises Extensions, Dial Plans, PSTN Connections, and Route Lists used by a specific Route Group.\nUsers within Call to Extension locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing Trunk or Route Group.\nPSTN Connections may be a Cisco PSTN, a cloud-connected PSTN, or a premises-based PSTN (local gateway).\nDial Plans allow you to route calls to on-premises extensions via "
},
{
"info": {
"name": "Read the Call to Extension Locations of a Routing Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usageCallToExtension",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "ID of the requested Route group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization associated with specific route group."
},
{
"name": "locationName",
"value": "locationName",
"type": "query",
"description": "Return the list of locations matching the location name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`."
}
]
},
"docs": "List \"Call to\" on-premises Extension Locations for a specific route group. Users within these locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing trunk or route group.\n\nRetrieving this location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Read the Dial Plan Locations of a Routing Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usageDialPlan",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "ID of the requested Route group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization associated with specific route group."
},
{
"name": "locationName",
"value": "locationName",
"type": "query",
"description": "Return the list of locations matching the location name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`."
}
]
},
"docs": "List Dial Plan Locations for a specific route group.\n\nDial Plans allow you to route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.\nA Dial Plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns. Specific dial patterns can be defined as part of your dial plan.\n\nRetrieving this location list requires a full or read-only administrato"
},
{
"info": {
"name": "Read the PSTN Connection Locations of a Routing Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usagePstnConnection",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "ID of the requested Route group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization associated with specific route group."
},
{
"name": "locationName",
"value": "locationName",
"type": "query",
"description": "Return the list of locations matching the location name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`."
}
]
},
"docs": "List PSTN Connection Locations for a specific route group. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN.\n\nRetrieving this Location list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Read the Route Lists of a Routing Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeGroups/:routeGroupId/usageRouteList",
"params": [
{
"name": "routeGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "ID of the requested Route group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization associated with specific route group."
},
{
"name": "name",
"value": "locationName",
"type": "query",
"description": "Return the list of locations matching the location name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the locations according to designated fields. Available sort orders are `asc`, and `desc`."
}
]
},
"docs": "List Route Lists for a specific route group. Route Lists are a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving this list of Route Lists requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Read the List of Route Lists",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List all Route List for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the Route List according to the designated fields. Available sort fields are `name`, and `locationId`. Sort order is ascending by default"
},
{
"name": "name",
"value": "LG1,LG2",
"type": "query",
"description": "Return the list of Route List matching the route list name."
},
{
"name": "locationId",
"value": "36e1e3f5-ba81-44b4-9dd5-b22ee4f5022d",
"type": "query",
"description": "Return the list of Route Lists matching the location id."
}
]
},
"docs": "List all Route Lists for the organization.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving the Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Route List",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route List belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Route List for the organization.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nCreating a Route List requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get a Route List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId",
"params": [
{
"name": "routeListId",
"value": "Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy",
"type": "path",
"description": "ID of the Route List."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route List belongs."
}
]
},
"docs": "Get a rout list details.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Route List",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId",
"params": [
{
"name": "routeListId",
"value": "Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy",
"type": "path",
"description": "ID of the Route List."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route List belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the details for a Route List.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Route List",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId",
"params": [
{
"name": "routeListId",
"value": "cbd93770-e6a3-448b-9bdf-86dbad3918c2",
"type": "path",
"description": "ID of the Route List."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route List belongs."
}
]
},
"docs": "Delete a route list for a customer.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nDeleting a Route List requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Numbers assigned to a Route List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId/numbers",
"params": [
{
"name": "routeListId",
"value": "cbd93770-e6a3-448b-9bdf-86dbad3918c2",
"type": "path",
"description": "ID of the Route List."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route List belongs."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "number",
"value": "+2147891122",
"type": "query",
"description": "Number assigned to the route list."
},
{
"name": "order",
"value": "number-asc|number-desc",
"type": "query",
"description": "Order the Route Lists according to number, ascending or descending."
}
]
},
"docs": "Get numbers assigned to a Route List\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Modify Numbers for Route List",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/premisePstn/routeLists/:routeListId/numbers",
"params": [
{
"name": "routeListId",
"value": "cbd93770-e6a3-448b-9bdf-86dbad3918c2",
"type": "path",
"description": "ID of the Route List."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the Route List belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify numbers for a specific Route List of a Customer.\n\nA Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.\n\nRetrieving a Route List requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Local Gateway Call to On-Premises Extension Usage for a Trunk",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/trunks/:trunkId/usageCallToExtension",
"params": [
{
"name": "trunkId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the trunk."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the trunk belongs."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "order",
"value": "name-asc|locationName-desc",
"type": "query",
"description": "Order the trunks according to the designated fields. Available sort fields are `name`, and `locationName`. Sort order is ascending by default"
},
{
"name": "name",
"value": "LG1,LG2",
"type": "query",
"description": "Return the list of trunks matching the local gateway names"
}
]
},
"docs": "Get local gateway call to on-premises extension usage for a trunk.\n\nA trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.\nThe trunk can be assigned to a Route Group which is a group of trunks that allow Webex Calling to distribute calls over multiple trunks or to provide redundancy.\n\nRetrieving this information requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Retrieve the list of Translation Patterns",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization containing the translation patterns."
},
{
"name": "limitToLocationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "When a location ID is passed, then return only the corresponding location level translation patterns."
},
{
"name": "limitToOrgLevelEnabled",
"value": "true",
"type": "query",
"description": "When set to be `true`, then return only the organization-level translation patterns."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc|name-desc",
"type": "query",
"description": "Sort the list of translation patterns according to translation pattern name, ascending or descending."
},
{
"name": "name",
"value": "Pattern1",
"type": "query",
"description": "Only return translation patterns with the matching `name`."
},
{
"name": "matchingPattern",
"value": "+2323",
"type": "query",
"description": "Only return translation patterns with the matching `matchingPattern`."
}
]
},
"docs": "Retrieve a list of translation patterns for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Translation Pattern for an Organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization containing the translation pattern."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Retrieve a specific Translation Pattern for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns/:translationId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization containing the translation pattern."
},
{
"name": "translationId",
"value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg",
"type": "path",
"description": "Retrieve the translation pattern with the matching ID."
}
]
},
"docs": "Retrieve the details of a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a specific Translation Pattern for an Organization",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns/:translationId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization containing the translation pattern."
},
{
"name": "translationId",
"value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg",
"type": "path",
"description": "Modify translation pattern with the matching ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Delete a specific Translation Pattern",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/callRouting/translationPatterns/:translationId",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization containing the translation pattern."
},
{
"name": "translationId",
"value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg",
"type": "path",
"description": "Delete a translation pattern with the matching ID."
}
]
},
"docs": "Delete a translation pattern for a given organization.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Create a Translation Pattern for a Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Retrieve a specific Translation Pattern for a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns/:translationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API."
},
{
"name": "translationId",
"value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg",
"type": "path",
"description": "Unique identifier for the translation pattern."
}
]
},
"docs": "Retrieve a specific translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a specific Translation Pattern for a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns/:translationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API."
},
{
"name": "translationId",
"value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg",
"type": "path",
"description": "Unique identifier for the translation pattern."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a specific translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Delete a specific Translation Pattern for a Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRouting/translationPatterns/:translationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Only admin users of another organization (such as partners) may use this parameter since the default is the same organization as the token used to access API."
},
{
"name": "translationId",
"value": "Y2lzY29zcGFyazovL3VzL0RJR0lUX1BBVFRFUk5TLzg3NGRjMjM1LTgwNTktNGM4OC05ZjU5LTRiNjdkZDJhZTZjMg",
"type": "path",
"description": "Unique identifier for the translation pattern."
}
]
},
"docs": "Delete a specific translation pattern for a given location.\n\nA translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See [this article](https://help.webex.com/en-us/article/nib9o6h/Translation-patterns-for-outbound-calls) for details about the translation pattern syntax.\n\nRequires a full administrator auth token with the `spark-admin:telephony_config_write` scope."
}
]
},
{
"info": {
"name": "Location Call Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Dial Patterns",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/premisePstn/dialPlans/:dialPlanId/dialPatterns",
"params": [
{
"name": "dialPlanId",
"value": "Y2lzY29zcGFyazovL3VzL0RJQUxfUExBTi8wNTlhMjczZS1iYmIwLTExZWMtODQyMi0wMjQyYWMxMjAwMDI",
"type": "path",
"description": "ID of the dial plan."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization to which the dial patterns belong."
},
{
"name": "dialPattern",
"value": "+5555",
"type": "query",
"description": "An enterprise dial pattern is represented by a sequence of digits (1-9), followed by optional wildcard characters.\nValid wildcard characters are `!` (matches any sequence of digits) and `X` (matches a single digit, 0-9).\nThe `!` wildcard can only occur once at the end and only in an E.164 pattern\n"
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "dialPattern-desc",
"type": "query",
"description": "Order the dial patterns according to the designated fields. Available sort fields: `dialPattern`."
}
]
},
"docs": "List all Dial Patterns for the organization.\n\nDial plans route calls to on-premises destinations by use of trunks or route groups.\nThey are configured globally for an enterprise and apply to all users, regardless of location.\nA dial plan also specifies the routing choice (trunk or route group) for calls that match any of its dial patterns.\nSpecific dial patterns can be defined as part of your dial plan.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `"
},
{
"info": {
"name": "List Locations Webex Calling Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List locations for this organization."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of locations in the response."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specify the offset from the first result that you want to fetch."
},
{
"name": "name",
"value": "Denver",
"type": "query",
"description": "List locations whose name contains this string."
},
{
"name": "order",
"value": "name-asc",
"type": "query",
"description": "Sort the list of locations based on `name`, either asc or desc."
}
]
},
"docs": "Lists Webex Calling locations for an organization with Webex Calling details.\n\nSearching and viewing locations with Webex Calling details in your\norganization require an administrator auth token with the\n`spark-admin:telephony_config_read` scope."
},
{
"info": {
"name": "Enable a Location for Webex Calling",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations",
"params": [
{
"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": "Enable a location by adding it to Webex Calling. This add Webex Calling support to a\nlocation created created using the POST /v1/locations API.\n\nLocations are used to support calling features which can be defined at the location level.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Location Webex Calling Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Retrieve Webex Calling location attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve Webex Calling location attributes for this organization."
}
]
},
"docs": "Shows Webex Calling details for a location, by ID.\n\nSpecifies the location ID in the locationId parameter in the URI.\n\nSearching and viewing locations in your organization requires an administrator auth token with the spark-admin:telephony_config_read scope."
},
{
"info": {
"name": "Update Location Webex Calling Details",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Updating Webex Calling location attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Updating Webex Calling location attributes for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Webex Calling details for a location, by ID.\n\nSpecifies the location ID in the `locationId` parameter in the URI.\n\nModifying the `connection` via API is only supported for the local PSTN types of `TRUNK` and `ROUTE_GROUP`.\n\nUpdating a location in your organization requires an administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Get a List of Update Routing Prefix jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/updateRoutingPrefix",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of update routing prefix jobs in this organization."
}
]
},
"docs": "Get the list of all update routing prefix jobs in an organization.\n\nThe routing prefix is associated with a location and is used to route calls belonging to that location.\nThis API allows users to retrieve all the update routing prefix jobs in an organization.\n\nRetrieving the list of update routing prefix jobs in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get the job status of Update Routing Prefix job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/updateRoutingPrefix/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI",
"type": "path",
"description": "Retrieve job status for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Check update routing prefix job status in this organization."
}
]
},
"docs": "Get the status of the update routing prefix job by its job ID.\n\nThe routing prefix is associated with a location and is used to route calls belonging to that location.\nThis API allows users to check the status of update routing prefix job by job ID in an organization.\n\nChecking the status of the update routing prefix job in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get job errors for update routing prefix job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/updateRoutingPrefix/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC81YWE1NWZjNC1lNTYwLTQ3MWQtOGZhZS0yNDc3NDM3MDNkNmI",
"type": "path",
"description": "Retrieve job errors for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of errors for update routing prefix job in this organization."
}
]
},
"docs": "GET job errors for the update routing prefix job in an organization.\n\nThe routing prefix is associated with a location and is used to route calls belonging to that location.\nThis API allows users to retrieve all the errors of the update routing prefix job by job ID in an organization.\n\nRetrieving all the errors of the update routing prefix job in an organization requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Change Announcement Language",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/modifyAnnouncementLanguage/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Change announcement language for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Change announcement language for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Change announcement language for the given location.\n\nChange announcement language for current people/workspaces and/or existing feature configurations. This does not change the default announcement language which is applied to new users/workspaces and new feature configurations.\n\nChanging the announcement language for the given location requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get a Location Emergency callback number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/features/emergencyCallbackNumber",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Update location attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update location attributes for this organization."
}
]
},
"docs": "Get location emergency callback number.\n\n* To retrieve location callback number requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Location Emergency callback number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/features/emergencyCallbackNumber",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Update location attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update location attributes for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update details for a location emergency callback number.\n\n* Updating a location callback number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Validate the List of Extensions",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/actions/validateExtensions/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Validate Extension for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validates the list of Extensions provided by the customer at the organization level. It checks the extension meets the current extension length limits and does not conflict with the extensions of organization-level entities and settings. To check for extension use across all locations, use the [Get Phone Numbers](/v1/telephony/config/numbers) API. To validate an extension and check for conflicts for a specific location, use the [Validate Extensions](/docs/api/v1/location-call-settings/validate-e"
},
{
"info": {
"name": "Validate Extensions",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/validateExtensions/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Validate extensions for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Validate extensions for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate extensions for a specific location.\n\nValidating extensions requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Music On Hold",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/musicOnHold",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0fetchcllrjjejgghbruudtlknjbcleukhihhgFUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve music on hold settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve music on hold settings for this organization."
}
]
},
"docs": "Retrieve the location's music on hold settings.\n\nLocation music on hold settings allows you to play music when a call is placed on hold or parked.\n\nRetrieving a location's music on hold settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Music On Hold",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/musicOnHold",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Update music on hold settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update music on hold settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the location's music on hold settings.\n\nLocation music on hold settings allows you to play music when a call is placed on hold or parked.\n\nUpdating a location's music on hold settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Private Network Connect",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/privateNetworkConnect",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve the network connection type for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve the network connection type for this organization."
}
]
},
"docs": "Retrieve the location's network connection type.\n\nNetwork Connection Type determines if the location's network connection is public or private.\n\nRetrieving a location's network connection type requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Private Network Connect",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/privateNetworkConnect",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Update the network connection type for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update network connection type for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the location's network connection type.\n\nNetwork Connection Type determines if the location's network connection is public or private.\n\nUpdating a location's network connection type requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the List of Routing Choices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/routeChoices",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List route identities for this organization."
},
{
"name": "routeGroupName",
"value": "routeGroupName",
"type": "query",
"description": "Return the list of route identities matching the Route group name."
},
{
"name": "trunkName",
"value": "trunkName",
"type": "query",
"description": "Return the list of route identities matching the Trunk name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "my_test_trunk-asc|ROUTE_GROUP-desc",
"type": "query",
"description": "Order the route identities according to the designated fields. Available sort fields: `routeName`, `routeType`."
}
]
},
"docs": "List all Routes for the organization.\n\nTrunk and Route Group qualify as Route. Trunks and Route Groups provide you the ability to configure Webex Calling to manage calls between Webex Calling hosted users and premises PBX users. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get the List of Phone Numbers Available for External Caller ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/externalCallerId/availableNumbers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzkzZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw",
"type": "path",
"description": "Retrieve available external caller ID numbers for this location."
},
{
"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 provided list 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": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8zZmQ1ZDMyLTRmYmItNGNjMS04ZTYxLTE0YTA1ZDhhMTIzMw",
"type": "query",
"description": "Retrieve available external caller ID numbers for this person. If `personId` is not provided it may result in the unsuccessful assignment of the returned number. This parameter has no effect when workspace or virtual line ID is used."
}
]
},
"docs": "Get the list of phone numbers available for external caller ID usage by a Webex Calling entity (such as a person, virtual line, or workspace) within the specified location.\nNumbers from the specified location are returned and cross location numbers are returned as well where the number's location has the same country, PSTN provider, and zone (only applicable for India locations) as the specified location.\nWhen `personId` is specified, and the person belongs to a cisco PSTN location, has a mobile"
},
{
"info": {
"name": "Get Available Phone Numbers for a Location with Given Criteria",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/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."
},
{
"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 the service and standard PSTN numbers that are available to be assigned as the location's main number.\nThese numbers are associated with the location specified in the request URL and can be active/inactive and assigned to an owning entity or 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 or loca"
},
{
"info": {
"name": "Get Webex Go Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/webexGo/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 standard numbers that are available to be assigned as the webex go 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 token with a scope of `spark-admin:teleph"
},
{
"info": {
"name": "Get Location ECBN Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/emergencyCallbackNumber/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."
},
{
"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 are available to be assigned as the location's emergency callback number.\nThese numbers are associated with the location 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 or location administrator auth token wi"
},
{
"info": {
"name": "Get Location Call Intercept Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callIntercept/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."
},
{
"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 phone numbers with the given `extension`."
}
]
},
"docs": "List the service and standard PSTN numbers that are available to be assigned as the location's call intercept number.\nThese numbers are associated with the location 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 or loc"
},
{
"info": {
"name": "Read list of Receptionist Contact Directories",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "List Receptionist Contact Directories for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List Receptionist Contact Directories for this organization."
}
]
},
"docs": "List all Receptionist Contact Directories for a location.\n\nReceptionist Contact Directories can be used to create named directories of 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 Receptionist Contact Directory",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Add a Receptionist Contact Directory to this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Add a Receptionist Contact Directory to this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Receptionist Contact Directory for a location.\n\nReceptionist Contact Directories can be used to create named directories of users and/or location features (Auto Attendant, Call Queue, Hunt Group, Single Number Reach, and Paging Group).\n\nAdding a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get details for a Receptionist Contact Directory",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories/:directoryId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Get a Receptionist Contact Directory from this location."
},
{
"name": "directoryId",
"value": "Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"type": "path",
"description": "Get details for the Receptionist Contact Directory with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get a Receptionist Contact Directory from this organization."
},
{
"name": "searchCriteriaModeOr",
"value": "true",
"type": "query",
"description": "When `true`, results matching any one of the search criteria are included. The value can only be `true` or not included in the request. Specifying `searchCriteriaModeOr` without any search criteria, or setting it to `false` results in an `ErrorResponse`. If no search criteria is specified, all results are returned."
},
{
"name": "firstName",
"value": "John",
"type": "query",
"description": "Search for directories that contain people with the indicated first name."
},
{
"name": "lastName",
"value": "Doe",
"type": "query",
"description": "Search for directories that contain people with the indicated last name."
},
{
"name": "phoneNumber",
"value": "+12225555309",
"type": "query",
"description": "Search for directories that contain people with the indicated phone number."
},
{
"name": "extension",
"value": "5309",
"type": "query",
"description": "Search for directories that contain people with the indicated extension."
},
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wNTUyZjY3Yi01OWE5LTQxYmItODczNi0xYjA0MWQxZGRkNWU",
"type": "query",
"description": "Search for directories that contain people with the indicated person ID."
}
]
},
"docs": "Get details for a specific Receptionist Contact Directory from a location.\n\nReceptionist Contact Directories are uniquely named per location and contain directories of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups.\n\nThis API is currently supported for Webex calling organizations with fewer than 2000 users or location-based calling features. For organizations with more than 2000 users or location features, the API will throw an error 25395.\n\nRetrievi"
},
{
"info": {
"name": "Modify a Receptionist Contact Directory",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories/:directoryId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Modify list of Receptionist Contact Directories for this location."
},
{
"name": "directoryId",
"value": "Y2lzY29zcGFyazovL3VzL0RFUEFSVE1FTlQvOTZhYmMyYWEtM2RjYy0xMWU1LWExNTItZmUzNDgxOWNkYzlh",
"type": "path",
"description": "Get details for the Receptionist Contact Directory with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify list of Receptionist Contact Directories for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify Receptionist Contact Directories attached to a location. This modification will replace the existing list of contacts with the new incoming contacts list from the request body. The API does not support incremental updates.\n\nReceptionist Contact Directories can be used to create named groups of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups.\n\nModifying a directory requires a full or write-only administrator auth token with a scope of `spark-adm"
},
{
"info": {
"name": "Delete a Receptionist Contact Directory",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/receptionistContacts/directories/:directoryId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Delete a Receptionist Contact Directory from this location."
},
{
"name": "directoryId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvUkdseVpXTjBiM0o1VkdWemREY3lNRGMxOjJiOTQzMWIzLWMyYWUtNDhhYi1iMDQxLWE2ZThiMjY1NjJjOQ",
"type": "path",
"description": "Delete the Receptionist Contact Directory ID with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete a Receptionist Contact Directory from this organization."
}
]
},
"docs": "Delete a Receptionist Contact Directory from a location.\n\nReceptionist Contact Directories can be used to create named directories of users.\n\nDeleting a directory requires a full or write-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Available Charge Numbers for a Location with Given Criteria",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/chargeNumber/availableNumbers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2YwYzRhOTcyLWIxNjQtMTFlZS05MWVhLWZiYjliMTkwMjI2Yg",
"type": "path",
"description": "Return the list of available charge 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."
},
{
"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 the numbers that are available to be assigned as the location's charge number.\n\nThese numbers are non-toll-free and non-mobile numbers assigned to the location specified in the request URL.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get a List of Disable Calling Location Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List disable calling location jobs for this organization."
},
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of jobs to return."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "Offset to start returning records from."
}
]
},
"docs": "Get a List of Disable Calling Location Jobs for the organization.\n\nRetrieving the list of disable calling location jobs requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Disable a Location for Webex Calling",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for disabling the location for Webex Calling."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Disable a Location for Webex Calling.\n\nInitiating a disable calling location job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\nThe API returns a jobId that can be used with other job-related APIs to track the status and progress of the disable operation."
},
{
"info": {
"name": "Safe Delete Check Before Disabling a Location for Webex Calling",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/precheckForDeletion/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzk2ZjA0YjUwLTYxMWItNGViYy05ZGE0LTQwMzU4ODYxZTI4NQ",
"type": "path",
"description": "Unique identifier for the location to be checked."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for which the safe delete check operation is being performed."
}
]
},
"docs": "Performs a safe delete check operation to identify any issues that would prevent the calling location from being disabled. This API helps identify resources that need to be addressed before a calling location can be successfully disabled.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Pause a Disable Calling Location Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId/actions/pause/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0",
"type": "path",
"description": "Unique identifier for the job to pause."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for which to pause the job."
}
]
},
"docs": "Pause an in-progress disable calling location job. The job must be in the PROCESSING state to be paused.\n\nPausing a job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Resume a Paused Disable Calling Location Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId/actions/resume/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0",
"type": "path",
"description": "Unique identifier for the job to resume."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for which to resume the job."
}
]
},
"docs": "Resume a previously paused disable calling location job. The job must be in the PAUSED state to be resumed.\n\nResuming a job requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve Errors for a Disable Calling Location Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0",
"type": "path",
"description": "Unique identifier for the job to get errors for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for disable calling location job."
}
]
},
"docs": "Retrieve detailed error information for a disable calling location job. This is particularly useful for jobs that have failed or encountered errors during processing.\n\nRetrieving job errors requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\nPossible error codes include:\n* `BATCH-1012002` - Unable to delete calling location from Broadworks.\n* `BATCH-1012004` - Safe delete checks failed.\n* `BATCH-1012005` - Failed to perform safe delete checks.\n* `BATCH-"
},
{
"info": {
"name": "Get Disable Calling Location Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/locations/deleteCallingLocation/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0",
"type": "path",
"description": "Unique identifier for the job."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for which to retrieve the job status."
}
]
},
"docs": "Get the status and details of a specific disable calling location job.\n\nRetrieving job status requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get the location call captions settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callCaptions",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieve the location's call captions settings.\n\n**NOTE**: The call captions feature is not supported for locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update the location call captions settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callCaptions",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the location's call captions settings.\n\n**NOTE**: The call captions feature is not supported for locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Call Settings For Me Phase 5",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Personal Assistant Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant"
},
"docs": "Retrieve personal assistant settings for a person. The personal assistant feature allows users to configure an automated attendant that can handle incoming calls when they are unavailable, including presence-based routing and call transfer options.\n\nPersonal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user's availability status.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Update Personal Assistant Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/personalAssistant",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update personal assistant settings for a person. Allows configuring the personal assistant feature including enabling/disabling it, setting presence status, configuring call transfer options, and alerting preferences.\n\nPersonal Assistant is a feature of Webex Calling that helps manage incoming calls based on the user's availability status.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Person's Voicemail Rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/voicemail/rules"
},
"docs": "Get person's voicemail passcode rules. Voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.\n\nThe voicemail feature allows users to manage their voicemail settings as part of Webex Calling. Voicemail rules help ensure secure access to voice messages by defining passcode complexity requirements.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Update Voicemail PIN",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/voicemail/pin",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the voicemail PIN for a person. Updates the PIN used to access voicemail messages. The PIN must comply with the passcode rules defined for the organization.\n\nThe voicemail feature is part of Webex Calling, allowing users to secure their voicemail access with a PIN. The PIN is required to retrieve voice messages via phone.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Hoteling Guest Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest"
},
"docs": "Retrieve hoteling guest settings for a person. Hoteling allows a person to temporarily use a device as a guest, associating their extension and configuration with that device for a limited time. This API returns the current hoteling guest configuration including any active host association details.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_co"
},
{
"info": {
"name": "Update Hoteling Guest Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/guest",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update hoteling guest settings for a person. Allows enabling or disabling the ability to use hoteling as a guest, configuring whether an association will be removed automatically after a specified time period, and associating with a hoteling host.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Available Hoteling Hosts",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/hoteling/availableHosts",
"params": [
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of hosts in the response. Default is 100."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start index for pagination. Default is 0."
},
{
"name": "name",
"value": "John",
"type": "query",
"description": "Filter hosts by name (first name or last name). Partial match is supported."
},
{
"name": "phoneNumber",
"value": "+14085551234",
"type": "query",
"description": "Filter hosts by phone number. Partial match is supported."
}
]
},
"docs": "Retrieve a list of available hoteling hosts that a person can associate with as a guest. Returns hosts that have hoteling enabled on their devices and are available for guest associations. The list can be filtered by name or phone number and supports pagination.\n\nHoteling is a feature of Webex Calling that enables flexible workspace solutions by allowing users to log into shared devices.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
}
]
},
{
"info": {
"name": "Call Settings For Me",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get List Available Preferred Answer Endpoints",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/availablePreferredAnswerEndpoints",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Get the person's preferred answer endpoint and the list of endpoints available for selection. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be "
},
{
"info": {
"name": "Get My Secondary Line Owner's Available Preferred Answer Endpoint List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineOwnerId/availablePreferredAnswerEndpoints",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Retrieve the list of available preferred answer endpoints for the secondary line owner of the authenticated person. \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line assigned to them"
},
{
"info": {
"name": "Get Preferred Answer Endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/preferredAnswerEndpoint",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the selected preferred answering endpoint for the user. If a preferred endpoint is not set for the person, API returns empty \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual lin"
},
{
"info": {
"name": "Modify Preferred Answer Endpoint",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/preferredAnswerEndpoint",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the `id` attribute must be set to null.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly when a person's extension (or a virtual line"
},
{
"info": {
"name": "Get My Secondary Line Owner's Preferred Answer Endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineOwnerId/preferredAnswerEndpoint",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieve the selected preferred answering endpoint for the secondary line owner of the authenticated person. If a preferred endpoint is not set for the person, API returns empty \n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particularly"
},
{
"info": {
"name": "Modify My Secondary Line Owner's Preferred Answer Endpoint",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineOwnerId/preferredAnswerEndpoint",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Sets or clears the preferred answer endpoint for the secondary line owner of the authenticated person. To clear the preferred answer endpoint the `id` attribute must be set to null.\n\n A Webex Calling user may be associated with multiple endpoints such as Webex App (desktop or mobile), Cisco desk IP phone, Webex Calling-supported analog devices or third-party endpoints. Preferred answering endpoints allow users to specify which of these devices should be prioritized for answering calls, particula"
},
{
"info": {
"name": "Get My WebexGoOverride Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/webexGoOverride"
},
"docs": "Retrieve \"Mobile User Aware\" override setting for Do Not Disturb feature.\n\nWhen enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nWhen disabled, a mobile device will return busy for all incoming calls if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nIt requires a user auth token with `spark:telephony_config_read` scope."
},
{
"info": {
"name": "Modify My WebexGoOverride Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/webexGoOverride",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update \"Mobile User Aware\" override setting for Do Not Disturb feature.\n\nWhen enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nWhen disabled, a mobile device will return busy for all incoming calls if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.\n\nIt requires a user auth token with the `spark:telephony_config_write` scope."
},
{
"info": {
"name": "Get My Caller ID Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callerId"
},
"docs": "Get Caller ID Settings for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Caller ID Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callerId",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Caller ID Settings for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Secondary Line Owner Caller ID Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callerId",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get Caller ID Settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Secondary Line Owner Caller ID Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callerId",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Caller ID Settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCalling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.\nConnected Line Identification Restriction allows you to block your name and phone number from being shown when receiving a call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Read My Selected Caller ID Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectedCallerId"
},
"docs": "Read selected caller ID settings associated with the authenticated user.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Configure My Selected Caller ID Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectedCallerId",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update selected caller ID settings associated with the authenticated user.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Secondary Line Owner's Selected Caller ID Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/selectedCallerId",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get details of selected caller ID settings associated with a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_rea"
},
{
"info": {
"name": "Modify My Secondary Line Owner's Selected Caller ID Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/selectedCallerId",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update selected caller ID settings associated with a secondary line owner of the authenticated user.\n\nNote that an authenticated user can only modify information for their configured secondary lines.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nSelected Caller ID settings allow users to choose which configuration among available caller IDs is selected currently.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Available Caller ID List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/availableCallerIds"
},
"docs": "Get details of available caller IDs of the authenticated user.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nThe available caller ID list shows the caller IDs that the user can choose from.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Secondary Line Owner's Available Caller ID List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/availableCallerIds",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get details of available caller IDs for a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\nThe available caller ID list shows the caller IDs that the user can choose from.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Read the List of My Endpoints",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/endpoints"
},
"docs": "Retrieve the list of endpoints associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Endpoints Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/endpoints/:endpointId",
"params": [
{
"name": "endpointId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS80NmNmMGEyYi0yNTE5LTQ1NGEtYTAzMi1iODYxMWZjYmZkNTQ",
"type": "path",
"description": "Unique identifier of the endpoint."
}
]
},
"docs": "Get details of an endpoint associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Endpoints Details",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/endpoints/:endpointId",
"params": [
{
"name": "endpointId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS85MGQyMmM0Yy0wMGI3LTQ4YzAtYjUwNi0yM2UwY2E2MTlkYmM",
"type": "path",
"description": "Unique identifier of the endpoint."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update alerting settings of the mobility endpoint associated with the authenticated user.\n\nEndpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Call Recording Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callRecording"
},
"docs": "Get details of call recording settings associated with the authenticated user.\n\nCall recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Secondary Line Owner's Call Recording Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callRecording",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get details of call recording settings associated with a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCall recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Own Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me"
},
"docs": "Get profile details for the authenticated user.\n\nProfile details include the user's name, email, location and calling details.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Feature Access Codes",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/featureAccessCode"
},
"docs": "Retrieve all Feature Access Codes configured for services that are assigned to the authenticated user. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.\n\nFeature access codes (FACs), also known as star codes, give users access to advanced calling features.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Feature Access Codes For Secondary Line Owner",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/featureAccessCode",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS82NDhjYjBkMC1kODU2LTQzNzQtYmI4My0zNWFhNTIxZDhiZmI",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Retrieve all Feature Access Codes configured for services that are assigned for the secondary line owner. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.\n\nFeature access codes (FACs), also known as star codes, give users access to advanced calling features.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Executive Assigned Assistants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assignedAssistants"
},
"docs": "Get list of assigned executive assistants for an authenticated user.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Executive Assigned Assistants",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assignedAssistants",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update assigned executive assistants for the authenticated user.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Executive Available Assistants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/availableAssistants"
},
"docs": "Get a list of available executive assistants for the authenticated user.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Executive Assistant Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assistant"
},
"docs": "Get settings for an executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Executive Assistant Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/assistant",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Settings for an executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Calling Services List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/services"
},
"docs": "Retrieves the list of enabled calling services for the authenticated user.\n\nThese services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Secondary Line Owner Calling Services List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/services",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Retrieves the list of enabled calling services for the secondary line owner of the authenticated user.\n\nThese services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get User's Single Number Reach Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach"
},
"docs": "Retrieves all single number reach settings configured for the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User's Single Number Reach Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates single number reach settings associated with the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add phone number as User's Single Number Reach",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach/numbers",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a phone number as a single number reach for the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Modify User's Single Number Reach Contact Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach/numbers/:phoneNumberId",
"params": [
{
"name": "phoneNumberId",
"value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx",
"type": "path",
"description": "Unique identifier of the phone number."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the contact settings of single number reach for the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete User's Single Number Reach Contact Settings",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/singleNumberReach/numbers/:phoneNumberId",
"params": [
{
"name": "phoneNumberId",
"value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx",
"type": "path",
"description": "Unique identifier of the phone number."
}
]
},
"docs": "Delete contact settings associated with the authenticated user.\n\nThe \"Single Number Reach\" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office. This is especially useful for remote or mobile workers needing flexibility.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Read My Call Forwarding Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callForwarding"
},
"docs": "Read call forwarding settings associated with the authenticated user.\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 person 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"
},
{
"info": {
"name": "Configure My Call Forwarding Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callForwarding",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update call forwarding settings associated with the authenticated user.\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 person 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 yo"
},
{
"info": {
"name": "Get My Secondary Line Owner's Call Forwarding Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callForwarding",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get details of call forwarding settings associated with a secondary line of the authenticated user.\n\nNote that an authenticated user can only retrieve information for their configured secondary lines.\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 person is busy.\n\n+ When no answer - forwarding only occurs when you are away"
},
{
"info": {
"name": "Modify My Secondary Line Owner's Call Forwarding Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callForwarding",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update call forwarding settings associated with a secondary line owner of the authenticated user.\n\nNote that an authenticated user can only modify information for their configured secondary lines.\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 person is busy.\n\n+ When no answer - forwarding only occurs when you are away or "
},
{
"info": {
"name": "Get My Call Pickup Group Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callPickupGroup"
},
"docs": "Get Call Pickup Group Settings for the authenticated user.\n\nCall pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Secondary Line Owner Call Pickup Group Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callPickupGroup",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get Call Pickup Group Settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCall pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Call Park Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callPark"
},
"docs": "Get details of call park settings associated with the authenticated user.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Secondary Line Owner Call Park Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/callPark",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Get details of call park settings for the secondary line owner of the authenticated user.\n\nNote that the secondary line information is only available for the authenticated user.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Read Voicemail Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/voicemail"
},
"docs": "Retrieve a person'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\nThis API requires a user auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Voicemail Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/voicemail",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Configure a person'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\nThis API requires a user auth token with a scope of `spark-admin:people_write`."
},
{
"info": {
"name": "Get My Secondary Line Owner's Voicemail Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/voicemail",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "GET voicemail settings for a secondary line of the authenticated user.\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\nThis API requires a user auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Modify My Secondary Line Owner's Voicemail Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/voicemail",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update voicemail settings associated with a secondary line owner of the authenticated user.\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\nThis API requires a user auth token with a scope of `spark-admin:people_write`."
},
{
"info": {
"name": "Get My Call Block Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock"
},
"docs": "Get details of call block settings associated with the authenticated user.\n\nCall block settings allow you to get the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Add a phone number to user's Call Block List",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock/numbers",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a phone number to the call block list for the authenticated user.\n\nCall block settings allow you to get the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Call Block State For Specific Number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock/numbers/:phoneNumberId",
"params": [
{
"name": "phoneNumberId",
"value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx",
"type": "path",
"description": "Unique identifier of the phone number."
}
]
},
"docs": "Get call block state details for a specific number associated with the authenticated user.\n\nCall block settings allow you to get the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Delete User Call Block Number",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callBlock/numbers/:phoneNumberId",
"params": [
{
"name": "phoneNumberId",
"value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi9LekU0T1RjMk5UUXpNekUx",
"type": "path",
"description": "Unique identifier of the phone number."
}
]
},
"docs": "Delete call block number settings associated with the authenticated user.\n\nCall block settings allow you to delete a number from the User Call Block Number List.\n\nThis API requires a user auth token with a scope of `spark-admin:people_write`."
},
{
"info": {
"name": "Get My Monitoring Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/monitoring"
},
"docs": "Retrieves the monitoring settings of the logged in person, which shows specified people, places, virtual lines or call park extensions that are being monitored.\n\nMonitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get My Call Center Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/queues"
},
"docs": "Retrieves the call center settings and list of all call centers the logged in user belongs to.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nThe user must have the call center service assigned.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Call Center Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/queues",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the call center settings and availability for an agent in one or more call centers to which the logged in user belongs.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nContains a list specifying the desired availability status of one or more call centers.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get My Secondary Line Owner's Call Center Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/queues",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
]
},
"docs": "Retrieves the call center settings and list of all call centers associated with a secondary line of the authenticated user.\nNote that an authenticated user can only retrieve information for their configured secondary lines.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nThe secondary line must have the call center service assigned.\n\nThis API requires a user auth token with a scope of"
},
{
"info": {
"name": "Modify My Secondary Line Owner's Call Center Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/secondaryLines/:lineownerId/queues",
"params": [
{
"name": "lineownerId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85NWM4MGY0My1mNjBlLTQzYTAtYTkwMy1iNWQ3ZDg0MThiNDU",
"type": "path",
"description": "Unique identifier for the secondary line owner (applicable only for Virtual Lines)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the call center settings and availability for an agent in one or more call centers associated with a secondary line owner of the authenticated user.\nNote that an authenticated user can only modify information for their configured secondary lines.\n\nCalls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.\nContains a list specifying the desired availability status of one or more call center"
},
{
"info": {
"name": "Get my call captions settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callCaptions"
},
"docs": "Retrieve the effective call captions settings of the authenticated user.\n\n**NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
}
]
},
{
"info": {
"name": "Beta Call Settings For Me With Userhub Phase1",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Call Policies Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callPolicies"
},
"docs": "Get call policies settings for the authenticated user.\n\nCall Policies in Webex allow you to manage how your call information is displayed and handled. You can view privacy settings for your connected line ID on redirected calls and review other call-related preferences.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Call Policies Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callPolicies",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update call policies settings for the authenticated user.\n\nCall Policies in Webex allow you to manage how your call information is displayed and handled. You can configure privacy settings for your connected line ID on redirected calls and control other call-related preferences.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User Executive Screening Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/screening"
},
"docs": "Get executive screening settings for the authenticated user.\n\nExecutive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User Executive Screening Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/screening",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive screening settings for the authenticated user.\n\nExecutive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User Executive Call Filtering Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/callFiltering"
},
"docs": "Get executive call filtering settings for the authenticated user.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User Executive Call Filtering Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/callFiltering",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive call filtering settings for the authenticated user.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User Executive Call Filtering Criteria Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/callFiltering/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`."
}
]
},
"docs": "Get executive call filtering criteria settings for the authenticated user.\n\nExecutive Call Filtering Criteria in Webex allows you to retrieve detailed configuration for a specific filter rule. This includes schedule settings, phone number filters, and call routing preferences for executive call filtering.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User Executive Call Filtering Criteria Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/callFiltering/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive call filtering criteria settings for the authenticated user.\n\nExecutive Call Filtering Criteria in Webex allows you to modify detailed configuration for a specific filter rule. This includes updating schedule settings, phone number filters, and call routing preferences for executive call filtering.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete User Executive Call Filtering Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/callFiltering/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`."
}
]
},
"docs": "Delete a specific executive call filtering criteria for the authenticated user.\n\nExecutive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Do Not Disturb Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/doNotDisturb"
},
"docs": "Get Do Not Disturb settings for the authenticated user.\n\nDo Not Disturb (DND) enables users to block or silence incoming calls on their phone. When activated, the phone either stops ringing or rejects calls depending on the configured option, but users can still see call information and answer calls if desired.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Do Not Disturb Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/doNotDisturb",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Do Not Disturb settings for the authenticated user.\n\nDo Not Disturb (DND) enables users to block or silence incoming calls on their phone. When activated, the phone either stops ringing or rejects calls depending on the configured option, but users can still see call information and answer calls if desired.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add User Executive Call Filtering Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/callFiltering/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new executive call filtering criteria for the authenticated user.\n\nExecutive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls. This API creates a new filter rule with the specified configuration, including schedule, phone numbers, and call routing preferences.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User Executive Alert Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/alert"
},
"docs": "Get executive alert settings for the authenticated user.\n\nExecutive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren't answered.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User Executive Alert Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/executive/alert",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive alert settings for the authenticated user.\n\nExecutive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren't answered.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get country-specific telephony configuration requirements",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/countries/:countryCode",
"params": [
{
"name": "countryCode",
"value": "US",
"type": "path",
"description": "The ISO country code for which configuration requirements are requested."
}
]
},
"docs": "Retrieve country-specific telephony configuration requirements for the authenticated user.\n\nWebex Calling supports multiple regions and time zones to validate and present the information using the local date and time, as well as localized dialing rules.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get announcement languages for the authenticated user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/announcementLanguages"
},
"docs": "Retrieve the list of available announcement languages for the authenticated user's telephony configuration.\n\nAnnouncement languages determine the language used for system prompts and announcements during calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
}
]
},
{
"info": {
"name": "Beta Settings Features For Barge-In",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Barge-In Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/bargeIn"
},
"docs": "Retrieve Barge-In settings of the user.\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\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Configure Barge-In Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/bargeIn",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Configure person'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\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
}
]
},
{
"info": {
"name": "Call Settings For Me With UserHub Phase2",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Priority Alert Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert"
},
"docs": "Get Priority Alert Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Priority Alert Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Priority Alert Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add a Priority Alert Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Priority Alert Criteria for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Priority Alert Criteria Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Get Priority Alert Criteria Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Settings for a Priority Alert Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify Priority Alert Criteria Settings for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete a Priority Alert Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/priorityAlert/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the priority alert criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Delete a Priority Alert criteria for the authenticated user.\n\nPriority alert allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User (and Location) Schedules",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/schedules"
},
"docs": "Get Schedules for Call Settings for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Add a User level Schedule for Call Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/schedules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Schedule for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Retrieve the schedule with the matching ID."
}
]
},
"docs": "Get a Schedule details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User Schedule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Update the schedule with the matching ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a Schedule details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Delete a User Schedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Delete the schedule with the matching ID."
}
]
},
"docs": "Delete a specific schedule for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add an event for a User Schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "add an event for the specified schedule ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Event for for the authenticated user's specified schedule.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User Schedule Event",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events/:eventId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Retrieve the schedule with the matching ID."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG",
"type": "path",
"description": "Retrieve the event with the matching ID."
}
]
},
"docs": "Get a Schedule Event details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify User Schedule Event",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events/:eventId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Update an event for the specified schedule ID."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG",
"type": "path",
"description": "Update the event with the matching ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a Schedule event details for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Delete User a Schedule Event",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/schedules/:scheduleType/:scheduleId/events/:eventId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Delete an event for the specified schedule ID."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUlZaRlRsUk9RVTFG",
"type": "path",
"description": "Delete the event with the matching ID."
}
]
},
"docs": "Delete a specific schedule event for the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get User's Location Level Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/locations/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "scheduleType",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule.\n * `businessHours` - Business hours schedule type.\n * `holidays` - Holidays schedule type.\n"
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvU0c5c2FXUmhlU0JXTWc",
"type": "path",
"description": "Retrieve the schedule with the matching ID."
}
]
},
"docs": "Get Location Schedule for Call Settings of the authenticated user.\n\nSchedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert. These call settings perform the defined actions based on the time frame in the schedule, making it more convenient for users to manage their calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Get Call Notify Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify"
},
"docs": "Get Call Notify Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Call Notify Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Notify Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add a Call Notify Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Call Notify Criteria for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Call Notify Criteria Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the call notify criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Get Call Notify Criteria Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify a Call Notify Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the call notify criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify Call Notify Criteria Settings for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete a Call Notify Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callNotify/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the call notify criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Delete a Call Notify criteria for the authenticated user.\n\nCall Notify allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Selective Call Accept Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept"
},
"docs": "Get Selective Call Accept Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Selective Call Accept Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Selective Call Accept Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add User Selective Call Accept Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Selective Call Accept Criteria for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Selective Call Accept Criteria Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call accept criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Get Selective Call Accept Criteria Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify a Selective Call Accept Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call accept. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify Selective Call Accept Criteria Settings for the authenticated user.\n\n\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete a Selective Call Accept Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveAccept/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call accept criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Delete a Selective Call Accept Criteria for the authenticated user.\n\n\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Available Numbers for User's Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/location/assignedNumbers",
"params": [
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of numbers in the response."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specify the offset from the first result that you want to fetch."
},
{
"name": "name",
"value": "Denver",
"type": "query",
"description": "List numbers whose owner name contains this string."
},
{
"name": "phoneNumber",
"value": "27888",
"type": "query",
"description": "List numbers whose phoneNumber contains this string."
},
{
"name": "extension",
"value": "7899",
"type": "query",
"description": "List numbers whose extension contains this string."
},
{
"name": "order",
"value": "lastName-asc",
"type": "query",
"description": "Sort the list of numbers based on `lastName`, `dn`, `extension` either asc or desc."
}
]
},
"docs": "Get Available Numbers for User's Location.\n\nFetch all the numbers available in User's location.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Add a Selective Call Forwarding Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Settings for a Selective Call Forwarding Criteria",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call forwarding criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Get settings for a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Settings for a Selective Call Forwarding Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call forwarding criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify settings for a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective Call Forward allows you to define rules that automatically forward incoming calls based on specific criteria, such as the caller’s phone number, caller identity, and the time and day the call is received.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete a Selective Call Forwarding Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call forwarding criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Delete a Selective Call Forwarding Criteria for the authenticated user.\n\nSelective call forwarding allows you to define rules that automatically forward incoming calls based on specific criteria. This API removes a specific criteria rule by its unique identifier.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Selective Call Forward Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward"
},
"docs": "Get Selective Call Forward Settings for the authenticated user.\n\nSelective Call Forward allows you to create customized rules to forward specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Selective Call Forward Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveForward",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the Selective Call Forward Settings for the authenticated user.\n\nSelective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number, identity, and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
}
]
},
{
"info": {
"name": "Call Settings For Me With UserHub Phase3",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Selective Call Reject Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveReject"
},
"docs": "Get Selective Call Reject Settings for the authenticated user.\n\nSelective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Selective Call Reject Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveReject",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Selective Call Reject Settings for the authenticated user.\n\nSelective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add User Selective Call Reject Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveReject/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Selective Call Reject Criteria for the authenticated user.\n\nSelective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Anonymous Call Rejection Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/anonymousCallReject"
},
"docs": "Get Anonymous Call Rejection Settings for the authenticated user.\n\nAnonymous Call Rejection allows you to reject calls from anonymous callers.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Anonymous Call Rejection Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/anonymousCallReject",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Anonymous Call Rejection Settings for the authenticated user.\n\nAnonymous Call Rejection allows you to reject calls from anonymous callers.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Selective Call Reject Criteria Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveReject/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call reject criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Get Selective Call Reject Criteria Settings for the authenticated user.\n\nSelective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify a Selective Call Reject Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveReject/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call reject. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify Selective Call Reject Criteria Settings for the authenticated user.\n\n\n\nSelective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete a Selective Call Reject Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/selectiveReject/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the selective call reject criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Delete a Selective Call Reject Criteria for the authenticated user.\n\n\n\nSelective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Call Waiting Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callWaiting"
},
"docs": "Get Call Waiting Settings for the authenticated user.\n\nCall Waiting allows a user to receive multiple calls simultaneously. When the user is on an active call, they can receive an incoming call and switch between the two calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Call Waiting Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/callWaiting",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Waiting Settings for the authenticated user.\n\nCall Waiting allows a user to receive multiple calls simultaneously. When the user is on an active call, they can receive an incoming call and switch between the two calls.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Sequential Ring Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/sequentialRing"
},
"docs": "Get Sequential Ring Settings for the authenticated user.\n\nSequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Sequential Ring Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/sequentialRing",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Sequential Ring Settings for the authenticated user.\n\nSequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Add User Sequential Ring Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/sequentialRing/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Sequential Ring Criteria for the authenticated user.\n\nSequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Get Sequential Ring Criteria Settings for User",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/sequentialRing/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the sequential ring criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Get Sequential Ring Criteria Settings for the authenticated user.\n\nSequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify Sequential Ring Criteria Settings for User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/sequentialRing/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the sequential ring criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Sequential Ring Criteria Settings for the authenticated user.\n\nSequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete Sequential Ring Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/sequentialRing/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the sequential ring criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzU0MzgzODQzNTA5NzY`."
}
]
},
"docs": "Delete a Sequential Ring Criteria for the authenticated user.\n\nSequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule.\n\nThis API requires a user auth token with a scope of `spark:telephony_config_write`."
}
]
},
{
"info": {
"name": "Mode Management",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Mode Management Features",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features",
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a list of all mode management features (Auto Attendants, Call Queues, and Hunt Groups) for which the authenticated user has been designated as a mode manager. This API returns basic information about each feature including its ID, name, and type.\n\nMode Management allows designated managers to switch features between different operational configurations based on time schedules or manual triggers. This is useful for managing business hours, holidays, and emergency scenarios.\n\nThis API re"
},
{
"info": {
"name": "Get Common Modes",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/commonModes",
"params": [
{
"name": "featureIds",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "query",
"description": "List of feature IDs (comma-separated) for auto attendants, call queues, or hunt groups"
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves a list of common operating mode names that are shared across multiple specified features. This API accepts a list of feature IDs and returns only the mode names that exist in all of the specified features, allowing managers to switch multiple features to the same mode simultaneously.\n\nCommon modes are useful when you need to coordinate operational changes across multiple features. For example, switching an entire office to \"Holiday\" mode across all Auto Attendants and Call Queues at on"
},
{
"info": {
"name": "Switch Mode for Multiple Features",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/actions/switchMode/invoke",
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Switches the operating mode for multiple features simultaneously by specifying a common mode name. This API accepts a list of feature IDs and sets all of them to the specified operating mode, provided that mode exists for all features.\n\nThis bulk operation is particularly useful for coordinating operational changes across an organization, such as activating holiday modes, emergency procedures, or after-hours configurations across multiple Auto Attendants, Call Queues, and Hunt Groups at once.\n\nT"
},
{
"info": {
"name": "Get Mode Management Feature",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId",
"params": [
{
"name": "featureId",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "path",
"description": "Unique identifier for the feature."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves detailed information about a specific mode management feature including its current operating mode and exception status. This API provides the feature's ID, name, type, current operating mode ID, and whether it is currently in an exception mode.\n\nException mode indicates that the feature has been manually switched to a different mode than what its schedule dictates. This information is critical for mode managers to understand the current state of their features.\n\nThis API requires a us"
},
{
"info": {
"name": "Get Normal Operation Mode",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/normalOperationMode",
"params": [
{
"name": "featureId",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "path",
"description": "Unique identifier for the feature."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves the current normal operating mode that the feature is scheduled to be in based on its time schedules. This represents the mode the feature would be in if no manual exceptions or overrides were active.\n\nThe normal operation mode is determined by the feature's configured schedules and may differ from the actual current operating mode if a manual exception has been applied. This API helps managers understand what the scheduled behavior is versus the actual current state.\n\nThis API require"
},
{
"info": {
"name": "Get Operating Mode",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/modes/:modeId",
"params": [
{
"name": "featureId",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "path",
"description": "Unique identifier for the feature."
},
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFLzAyZjZlMmI4LTFjZDktNWI3ZS1jOTVjLTczYzZkYzk1MTZjMg==",
"type": "path",
"description": "Unique identifier for the operating mode."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Retrieves detailed information about a specific operating mode for a feature, including the mode's ID and name. This API allows managers to get the details of any operating mode configured for a feature.\n\nOperating modes define different configurations for how a feature behaves (e.g., business hours routing vs. after-hours routing). Each mode has a unique ID and a descriptive name that helps managers identify its purpose.\n\nThis API requires a user auth token with the `spark:telephony_config_read"
},
{
"info": {
"name": "Switch to Normal Operation",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/switchToNormalOperation/invoke",
"params": [
{
"name": "featureId",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "path",
"description": "Unique identifier for the feature."
}
],
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Switches the feature back to its normal scheduled operation mode, removing any manual exceptions or overrides that may be active. This returns the feature to operating according to its configured time schedules.\n\nThis operation is useful when a temporary manual mode change (exception) is no longer needed and you want to restore automatic schedule-based operation. It effectively cancels any active manual mode switches.\n\nThis API requires a user auth token with the `spark:telephony_config_write` s"
},
{
"info": {
"name": "Switch Mode for Single Feature",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/switchMode/invoke",
"params": [
{
"name": "featureId",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "path",
"description": "Unique identifier for the feature."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Switches the operating mode for a single feature to a specified mode, either temporarily or with manual switchback. This API creates an exception to the feature's normal scheduled operation, allowing managers to manually control the feature's behavior.\n\nYou can configure whether the mode switch is temporary (automatically reverts based on schedule) or requires manual switchback. This is useful for handling unexpected situations like emergency closures, special events, or unscheduled breaks.\n\nThi"
},
{
"info": {
"name": "Extend Current Operating Mode Duration",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/modeManagement/features/:featureId/actions/extendMode/invoke",
"params": [
{
"name": "featureId",
"value": "Y2lzY29zcGFyazovL3VzL0ZFQVRVUkUvYjQzMmI2NmQtM2VkYy00ZGNkLTg4ODctNDZlOGU2NWQwYzIw",
"type": "path",
"description": "Unique identifier for the feature."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "bearer",
"token": "{{bearerToken}}"
}
},
"docs": "Extends the duration of the current operating mode by adding additional time before it expires or reverts to scheduled operation. This API allows managers to prolong a temporary mode change without having to switch modes again.\n\nExtension time can be specified in 30-minute increments up to 720 minutes (12 hours). If no extension time is provided, the mode is extended with a manual switchback exception, meaning it will remain active until manually changed.\n\nThis API requires a user auth token wit"
}
]
},
{
"info": {
"name": "Call Settings For Me Phase 4",
"type": "folder"
},
"items": [
{
"info": {
"name": "Upload Voicemail Busy Greeting",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/busyGreetingUpload/invoke",
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
}
]
}
},
"docs": "Uploads a new busy greeting audio file for the authenticated user's voicemail.\n\nThis endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.\n\nRequires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail."
},
{
"info": {
"name": "Upload Voicemail No Answer Greeting",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/voicemail/actions/noAnswerGreetingUpload/invoke",
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
}
]
}
},
"docs": "Uploads a new no answer greeting audio file for the authenticated user's voicemail.\n\nThis endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the `wxc-csg-hydra-call-184017-phase4` feature is enabled. The greeting must be in WAV format and not exceed 5000 kilobytes.\n\nRequires a user auth token with the `spark:telephony_config_write` scope. Only the authenticated user may upload greetings for their own voicemail."
},
{
"info": {
"name": "Retrieve My Simultaneous Ring Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing"
},
"docs": "Retrieve simultaneous ring settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nRetrieving settings requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Simultaneous Ring Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify simultaneous ring settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nModifying settings requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Retrieve My Simultaneous Ring Criteria",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
}
]
},
"docs": "Retrieve simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nRetrieving criteria requires a user auth token with a scope of `spark:telephony_config_read`."
},
{
"info": {
"name": "Modify My Simultaneous Ring Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nModifying criteria requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Delete My Simultaneous Ring Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
}
]
},
"docs": "Delete simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nDeleting criteria requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Create My Simultaneous Ring Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/me/settings/simultaneousRing/criteria",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create simultaneous ring criteria settings for the authenticated user.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Simultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nCreating criteria requires a user auth token with a scope of `spark:telephony_config_write`."
},
{
"info": {
"name": "Retrieve My Guest Calling Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/guestCalling/numbers"
},
"docs": "Retrieve available guest calling numbers for the authenticated user.\n\nThis API returns a list of phone numbers that can be used for guest calling purposes.\n\nRetrieving guest calling numbers requires a user auth token with a scope of `spark:telephony_config_read`."
}
]
},
{
"info": {
"name": "Calling Service Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Announcement Languages",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcementLanguages",
"params": [
{
"name": "ttsLanguage",
"value": "",
"type": "query",
"description": "Filter languages by TTS support."
}
]
},
"docs": "List all languages supported by Webex Calling for announcements and voice prompts.\n\nRetrieving announcement languages requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Voicemail Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/voicemail/settings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve voicemail settings for this organization."
}
]
},
"docs": "Retrieve the organization's voicemail settings.\n\nOrganizational voicemail settings determines what voicemail features a person can configure and automatic message expiration.\n\nRetrieving organization's voicemail settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Voicemail Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/voicemail/settings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update voicemail settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the organization's voicemail settings.\n\nOrganizational voicemail settings determines what voicemail features a person can configure and automatic message expiration.\n\nUpdating an organization's voicemail settings requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Voicemail Rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/voicemail/rules",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve voicemail rules for this organization."
}
]
},
"docs": "Retrieve the organization's voicemail rules.\n\nOrganizational voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.\n\nRetrieving the organization's voicemail rules requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Voicemail Rules",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/voicemail/rules",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update voicemail rules for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the organization's default voicemail passcode and/or rules.\n\nOrganizational voicemail rules specify the default passcode requirements.\n\nIf you choose to set a default passcode for new people added to your organization, communicate to your people what that passcode is, and that it must be reset before they can access their voicemail. If this feature is not turned on, each new person must initially set their own passcode.\n\nUpdating an organization's voicemail passcode and/or rules requires "
},
{
"info": {
"name": "Get the organization Music on Hold configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/moh/settings",
"params": [
{
"name": "orgId",
"value": "631e6768-c7fa-4179-acb3-c98f248a6d4b",
"type": "query",
"description": "Retrieve Music on Hold settings for this organization."
}
]
},
"docs": "Retrieve the organization's Music on Hold settings."
},
{
"info": {
"name": "Update the organization Music on Hold configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/moh/settings",
"params": [
{
"name": "orgId",
"value": "631e6768-c7fa-4179-acb3-c98f248a6d4b",
"type": "query",
"description": "Patch Music on Hold for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the organization's Music on Hold settings."
},
{
"info": {
"name": "Get Large Organization Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/largeOrgStatus",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves large organization status for this organization."
}
]
},
"docs": "Get the large organization status for a customer.\n\nLarge organization status indicates whether an organization is categorized as a large organization based on the threshold percentage.\n\nThis API requires a full or read-only administrator auth token with the `spark-admin:telephony_config_read` scope."
},
{
"info": {
"name": "Get the organization call captions settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callCaptions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieve the organization's call captions settings.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update the organization call captions settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/callCaptions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the organization's call captions settings.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Client Call Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get an Organization's MS Teams Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/settings/msTeams",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve MS Teams settings for the organization."
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP)
\n\nGet organization MS Teams settings.\n\nAt an organization level, MS Teams settings allow access to viewing the `HIDE WEBEX APP` and `PRESENCE SYNC` settings.\n\nTo retrieve an organization's MS Teams settings requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update an Organization's MS Teams Setting",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/settings/msTeams",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Update MS Teams setting value for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Not supported for Webex for Government (FedRAMP)
\n\nUpdate an MS Teams setting.\n\nMS Teams setting can be updated at the organization level.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Conference Controls",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Conference Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/conference",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Get the details of the conference. An empty JSON object body is returned if there is no conference."
},
{
"info": {
"name": "Start Conference",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Join the user's calls into a conference. A minimum of two call IDs are required. Each call ID identifies an existing call between the user\nand a participant to be added to the conference."
},
{
"info": {
"name": "Release Conference",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/conference",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Release the conference (the host and all participants). Note that for a 3WC (three-way call) the [Transfer API](/docs/api/v1/call-controls/transfer) can be used to perform an attended transfer so that the participants remain connected."
},
{
"info": {
"name": "Add Participant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/addParticipant",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a participant to an existing conference. The request body contains the participant's call ID."
},
{
"info": {
"name": "Mute",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/mute",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Mutes the host or a participant. Mutes the host when no request body is provided (i.e. media stream from the host will not be transmitted to the conference). Mutes a participant when the request body contains the participant's call ID (i.e. media stream from the participant will not be transmitted to the conference)."
},
{
"info": {
"name": "Unmute",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/unmute",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Unmutes the host or a participant. Unmutes the host when no request body is provided (i.e. media stream from the host will be transmitted to the conference). Unmutes a participant when the request body contains the participant's call ID (i.e. media stream from the participant will be transmitted to the conference)."
},
{
"info": {
"name": "Deafen Participant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/deafen",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deafens a participant (i.e. media stream will not be transmitted to the participant).\nThe request body contains the call ID of the participant to deafen"
},
{
"info": {
"name": "Undeafen Participant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/undeafen",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Undeafens a participant (i.e. resume transmitting the conference media stream to the participant). \nThe request body contains the call ID of the participant to undeafen."
},
{
"info": {
"name": "Hold",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/hold",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Hold the conference host. There is no request body."
},
{
"info": {
"name": "Resume",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/conference/resume",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Resumes the held conference host. There is no request body."
}
]
},
{
"info": {
"name": "Default",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the Contact Center Extensions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/me/settings/contactCenterExtensions"
},
"docs": "Retrieves the Contact Center phone number, extension, virtual numbers, endpoints, and endpoints registration status associated with the authenticated user. This API returns all primary and secondary endpoints, the hot desk guest profiles currently hosted on the agent's own devices, if any, and registration status of those endpoints. Only virtual line extensions hosted exclusively on the agent's devices and the registration status of those virtual line endpoints will be retrieved. Any virtual lin"
}
]
},
{
"info": {
"name": "Converged Recordings",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Recordings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/convergedRecordings",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`."
},
{
"name": "status",
"value": "available",
"type": "query",
"description": "Recording's status. If not specified or `available`, retrieves recordings that are available. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin."
},
{
"name": "serviceType",
"value": "calling",
"type": "query",
"description": "Recording's service-type. If specified, the API filters recordings by service-type. Valid values are `calling` and `customerAssist`."
},
{
"name": "format",
"value": "MP3",
"type": "query",
"description": "Recording's file format. If specified, the API filters recordings by format. Valid values are `MP3`."
},
{
"name": "ownerType",
"value": "user",
"type": "query",
"description": "Recording based on type of user."
},
{
"name": "storageRegion",
"value": "US",
"type": "query",
"description": "Recording stored in certain Webex locations."
},
{
"name": "locationId",
"value": "02a43ee9-17ae-4e0c-9e79-720e3a6503fd",
"type": "query",
"description": "Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub)."
},
{
"name": "topic",
"value": "Call with User7",
"type": "query",
"description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner."
}
]
},
"docs": "List recordings. You can specify a date range, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\nList recordings requires the `spark:recordings_read` scope.\n\nPlease use `List Recordings for Admin or Compliance Officer` API to list all recordings for a user with the role Compliance officer or Admin\n\nRequest Header\n\n* `timezone`: "
},
{
"info": {
"name": "List Recordings for Admin or Compliance officer",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/admin/convergedRecordings",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recordings to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. The interval between `from` and `to` must be within 30 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for List recordings to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. The interval between `from` and `to` must be within 30 days."
},
{
"name": "status",
"value": "available",
"type": "query",
"description": "Recording's status. If not specified or `available`, retrieves recordings that are available. if specified as `purged`, retrieves recordings those are deleted but available to a compliance officer. Otherwise, if specified as `deleted`, retrieves recordings that have been moved into the recycle bin."
},
{
"name": "serviceType",
"value": "calling",
"type": "query",
"description": "Recording's service-type. If specified, the API filters recordings by service-type. Valid values are `calling` and `customerAssist`."
},
{
"name": "format",
"value": "MP3",
"type": "query",
"description": "Recording's file format. If specified, the API filters recordings by format. Valid values are `MP3`."
},
{
"name": "ownerId",
"value": "24683d6c-5529-4b60-a6c7-91e8b293bbab",
"type": "query",
"description": "Webex user Id to fetch recordings for a particular user."
},
{
"name": "ownerEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Webex email address to fetch recordings for a particular user."
},
{
"name": "ownerType",
"value": "user",
"type": "query",
"description": "Recording based on type of user."
},
{
"name": "storageRegion",
"value": "US",
"type": "query",
"description": "Recording stored in certain Webex locations."
},
{
"name": "locationId",
"value": "02a43ee9-17ae-4e0c-9e79-720e3a6503fd",
"type": "query",
"description": "Fetch recordings for users in a particular Webex Calling location (as configured in Control Hub)."
},
{
"name": "topic",
"value": "Call with User7",
"type": "query",
"description": "Recording's topic. If specified, the API filters recordings by topic in a case-insensitive manner."
}
]
},
"docs": "List recordings for an admin or compliance officer. You can specify a date range, and the maximum number of recordings to return.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\nList recordings requires the `spark-compliance:recordings_read` scope for compliance officer and `spark-admin:recordings_read` scope for admin.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https"
},
{
"info": {
"name": "Get Recording Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/convergedRecordings/:recordingId",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "recordingId",
"value": "62807eaf-0c89-492e-a3c3-c4751812603b",
"type": "path",
"description": "A unique identifier for the recording."
}
]
},
"docs": "Retrieves details for a recording with a specified recording ID.\n\nOnly recordings of owner with the authenticated user may be retrieved.\n\nGet Recording Details requires the `spark-compliance:recordings_read` scope for compliance officer, `spark-admin:recordings_read` scope for admin and `spark:recordings_read` scope for user.\n\n#### Request Header\n\n* `timezone`: *[Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https:"
},
{
"info": {
"name": "Delete a Recording",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/convergedRecordings/:recordingId",
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes a recording with a specified recording ID. The deleted recording cannot be recovered.\n\nIf a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), and to the Compliance officer as well. This action purges the recordings from Webex.\n\nDelete a Recording requires the `spark-compliance:recordings_write` scope."
},
{
"info": {
"name": "Get Recording metadata",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/convergedRecordings/:recordingId/metadata",
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "path",
"description": "A unique identifier for the recording."
},
{
"name": "showAllTypes",
"value": "false",
"type": "query",
"description": "If `showAllTypes` is `true`, all attributes will be shown. If it's `false` or not specified, the following attributes of the metadata will be hidden.\n serviceData.callActivity.mediaStreams\n serviceData.callActivity.participants\n serviceData.callActivity.redirectInfo\n serviceData.callActivity.redirectedCall\n"
}
]
},
"docs": "Retrieves metadata details for a recording with a specified recording ID. The recording must be owned by the authenticated user.\n\nFor information on the metadata fields, refer to [Metadata Guide](https://developer.webex.com/docs/api/guides/consolidated-metadata-documentation-and-samples-guide)\n\nGet Recording metadata requires the `spark-compliance:recordings_read` scope for compliance officer, `spark-admin:recordings_read` for admin and `spark:recordings_read` for user."
},
{
"info": {
"name": "Reassign Recordings",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/convergedRecordings/reassign",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Reassigns recordings to a new user. As an administrator, you can reassign a list of recordings or all recordings of a particular user to a new user.\nThe recordings can belong to an org user, a virtual line, or a workspace, but the destination user should only be a valid org user.\n\n* For a org user either `ownerEmail` or `recordingIds` or both must be provided.\n\n* For a virtual line or a workspace, `ownerID` or `recordingIds` or both must be provided.\n\n* If `recordingIds` and `ownerID` is empty b"
},
{
"info": {
"name": "Move Recordings into the Recycle Bin",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/convergedRecordings/softDelete",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Move recordings into the recycle bin with recording IDs or move all the recordings to the recycle bin.\n\nOnly the following two entities can use this API\n\n* Administrator: A user or an application with the scope `spark-admin:recordings_write`.\n\n* User: An authenticated user who does not have the scope `spark-admin:recordings_write` but has `spark:recordings_write`.\n\nAs an `administrator`, you can move a list of recordings or all recordings of a particular user within the org you manage to the rec"
},
{
"info": {
"name": "Restore Recordings from Recycle Bin",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/convergedRecordings/restore",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Restore recordings from the recycle bin with recording IDs or restore all the recordings that are in the recycle bin.\n\nOnly the following two entities can use this API\n\n* Administrator: A user or an application with the scope `spark-admin:recordings_write`.\n\n* User: An authenticated user who does not have the scope `spark-admin:recordings_write` but has `spark:recordings_write`.\n\nAs an `administrator`, you can restore a list of recordings or all recordings of a particular user within the org you"
},
{
"info": {
"name": "Purge Recordings from Recycle Bin",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/convergedRecordings/purge",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Purge recordings from the recycle bin matching the supplied recording IDs, or purge all the recordings that are in the recycle bin. A recording, once purged, cannot be restored.\n\nOnly the following two entities can use this API\n\n* Administrator: A user or an application with the scope `spark-admin:recordings_write`.\n\n* User: An authenticated user who does not have the scope `spark-admin:recordings_write` but has `spark:recordings_write`.\n\nAs an `administrator`, you can purge a list of recordings"
}
]
},
{
"info": {
"name": "Device Call Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Device Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/members",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves the list of all members of the device in this organization."
}
]
},
"docs": "Get the list of all the members of the device including primary and secondary users.\n\nA device member can be either a person or a workspace. An admin can access the list of member details, modify member details and\nsearch for available members on a device.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Members on the device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/members",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify members on the device in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify member details on the device.\n\nA device member can be either a person, virtual line or a workspace. An admin can access the list of member details, modify member details and\nsearch for available members on a device.\n\nModifying members on the device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Search Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/availableMembers",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves the list of available members on the device in this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
},
{
"name": "memberName",
"value": "John",
"type": "query",
"description": "Search (Contains) numbers based on member name."
},
{
"name": "phoneNumber",
"value": "9828282867",
"type": "query",
"description": "Search (Contains) based on number."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the location."
},
{
"name": "extension",
"value": "1234",
"type": "query",
"description": "Search (Contains) based on extension."
},
{
"name": "usageType",
"value": "SHARED_LINE",
"type": "query",
"description": "Search for members eligible to become the owner of the device, or share line on the device."
},
{
"name": "order",
"value": "lname",
"type": "query",
"description": "Sort the list of available members on the device in ascending order by name, use either last name `lname` or first name `fname`. Default: last name in ascending order."
}
]
},
"docs": "Search members that can be assigned to the device.\n\nA device member can be either a person or a workspace. A admin can access the list of member details, modify member details and\nsearch for available members on a device.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Count of Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/availableMembers/count",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves the count of available members on the device in this organization."
},
{
"name": "memberName",
"value": "John",
"type": "query",
"description": "Search (Contains) numbers based on member name."
},
{
"name": "phoneNumber",
"value": "9828282867",
"type": "query",
"description": "Search (Contains) based on number."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw",
"type": "query",
"description": "Unique identifier for the location."
},
{
"name": "extension",
"value": "1234",
"type": "query",
"description": "Search (Contains) based on extension."
},
{
"name": "usageType",
"value": "SHARED_LINE",
"type": "query",
"description": "Search for members eligible to become the owner of the device, or share line on the device.\n * `DEVICE_OWNER` - Search for members eligible to become the owner of the device.\n * `SHARED_LINE` - Search for members eligible to share line on the device."
}
]
},
"docs": "Get the count of members that can be assigned to the device.\n\nA device member can be either a person or a workspace.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Count of Available Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/availableMembers/count",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves the count of available members in this organization."
},
{
"name": "memberName",
"value": "John",
"type": "query",
"description": "Search (Contains) numbers based on member name."
},
{
"name": "phoneNumber",
"value": "9828282867",
"type": "query",
"description": "Search (Contains) based on number."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw",
"type": "query",
"description": "Unique identifier for the location."
},
{
"name": "extension",
"value": "1234",
"type": "query",
"description": "Search (Contains) based on extension."
},
{
"name": "usageType",
"value": "SHARED_LINE",
"type": "query",
"description": "Search for members eligible to become the owner of the device, or share line on the device.\n * `DEVICE_OWNER` - Search for members eligible to become the owner of the device.\n * `SHARED_LINE` - Search for members eligible to share line on the device."
},
{
"name": "excludeVirtualLine",
"value": "true",
"type": "query",
"description": "If true, filters out virtual lines from the available members list."
},
{
"name": "deviceLocationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw",
"type": "query",
"description": "Unique identifier for the device's location. When specified, filters available members to those in the same location as the device."
}
]
},
"docs": "Get the count of members that can be assigned to devices.\n\nA device member can be either a person or a workspace.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Apply Changes for a specific device",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/actions/applyChanges/invoke",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Apply changes for a device in this organization."
}
]
},
"docs": "Issues request to the device to download and apply changes to the configuration.\n\nApplying changes for a specific device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Device Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/settings",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Settings on the device in this organization."
},
{
"name": "deviceModel",
"value": "DMS Cisco 8811",
"type": "query",
"description": "The model type of the device. The corresponding device model display name sometimes called the product name, can also be used to specify the model."
}
]
},
"docs": "Get override settings for a device.\n\nDevice settings lists all the applicable settings for MPP, ATA and Wifi devices at the device level. An admin can also modify the settings. DECT devices do not support settings at the device level.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update device settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/settings",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvMzAwMmViYmYtYjE1Zi00NTg5LWFjYmUtZGY2NzkwNzE1OTVh",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the device resides.."
},
{
"name": "deviceModel",
"value": "DMS Cisco 8811",
"type": "query",
"description": "The model type of the device. The corresponding device model display name sometimes called the product name, can also be used to specify the model."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify override settings for a device.\n\nDevice settings list all the applicable settings for an MPP and an ATA devices at the device level. Admins can also modify the settings. NOTE: DECT devices do not support settings at the device level.\n\nUpdating settings on the device requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Location Device Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/devices/settings",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw",
"type": "path",
"description": "Unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the device resides."
}
]
},
"docs": "Get device override settings for a location.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Webex Calling Device Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the device resides."
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP)
\n\nRetrieves Webex Calling device details that include information needed for third-party device management.\n\nWebex calling devices are associated with a specific user Workspace or Virtual Line. Webex Calling devices share the location with the entity that owns them.\n\nPerson or workspace to which the device is assigned. Its fields point to a primary line/port of the device.\n\nRequires a full, location, use"
},
{
"info": {
"name": "Update Third Party Device",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExJTkdfREVWSUNFLzAwMDA1ZTAwLTUzYjQtNDBjMy1hN2FkLTU2NTBmZGRkZDUzYw",
"type": "query",
"description": "ID of the organization in which the device resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Not supported for Webex for Government (FedRAMP)
\n\nModify a device's `sipPassword`.\n\nUpdating `sipPassword` on the device requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Person Devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/devices",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "Person for whom to retrieve devices."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the person belongs."
}
]
},
"docs": "Get all devices for a person.\n\nThis requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Hoteling Settings for a Person's Primary Devices",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/devices/settings/hoteling",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "ID of the person associated with the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the person belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify hoteling login configuration on a person's Webex Calling Devices which are in effect when the device is the user's primary device and device type is PRIMARY. To view the current hoteling login settings, see the `hoteling` field in [Get Person Devices](/docs/api/v1/device-call-settings/get-person-devices).\n\nModifying devices for a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Workspace Devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "ID of the workspace for which to retrieve devices."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the workspace belongs."
}
]
},
"docs": "Get all devices for a workspace.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Workspace Devices",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "ID of the workspace for which to modify devices."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the workspace belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify devices for a workspace.\n\nModifying devices for a workspace requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the device override settings for a organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/settings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List supported devices for an organization."
}
]
},
"docs": "Get device override settings for an organization.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Read the list of Line Key Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List line key templates for this organization."
}
]
},
"docs": "List all Line Key Templates available for this organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve the list of Line Key Templates that are available for the organization.\n\nRetrieving this list requires a full, user or read-only administrator or location ad"
},
{
"info": {
"name": "Create a Line Key Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the line key template belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Line Key Template in this organization.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows customers to create a `Line Key Template` for a device model.\n\nCreating a Line Key Template requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get details of a Line Key Template",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates/:templateId",
"params": [
{
"name": "templateId",
"value": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM",
"type": "path",
"description": "Get line key template for this template ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve a line key template for this organization."
}
]
},
"docs": "Get detailed information about a Line Key Template by template ID in an organization.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve a line key template by its ID in an organization.\n\nRetrieving a line key template requires a full, user, or read-only administrator"
},
{
"info": {
"name": "Modify a Line Key Template",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates/:templateId",
"params": [
{
"name": "templateId",
"value": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM",
"type": "path",
"description": "Modify line key template with this template ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify a line key template for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a Line Key Template by its template ID in an organization.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to modify an existing Line Key Template by its ID in an organization.\n\nModifying an existing Line Key Template requires a full administrator auth token with a scop"
},
{
"info": {
"name": "Delete a Line Key Template",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/devices/lineKeyTemplates/:templateId",
"params": [
{
"name": "templateId",
"value": "Y2lzY29zcGFyazovL3VzL0RFVklDRV9MSU5FX0tFWV9URU1QTEFURS9kNDUzM2MwYi1hZGRmLTRjODUtODk0YS1hZTVkOTAyYzAyMDM",
"type": "path",
"description": "Delete line key template with this template ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete a line key template for this organization."
}
]
},
"docs": "Delete a Line Key Template by its template ID in an organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to delete an existing Line Key Templates by its ID in an organization.\n\nDeleting an existing line key template requires a full administrator auth token with a scope"
},
{
"info": {
"name": "Preview Apply Line Key Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/devices/actions/previewApplyLineKeyTemplate/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Preview Line Key Template for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Preview the number of devices that will be affected by the application of a Line Key Template or when resetting devices to their factory Line Key settings.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to preview the number of devices that will be affected if a customer were"
},
{
"info": {
"name": "Get List of Apply Line Key Template jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of line key templates jobs in this organization."
}
]
},
"docs": "Get the list of all apply line key templates jobs in an organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve all the apply line key templates jobs in an organization.\n\nRetrieving the list of apply line key templates jobs in an organization requires a full, "
},
{
"info": {
"name": "Apply a Line Key Template",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Apply Line Key Template for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Apply a Line Key Template or reset devices to their factory Line Key settings.\n\nLine Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to apply a line key template or apply factory default Line Key settings to devices in a set of locations or across all locations in the organization.\n"
},
{
"info": {
"name": "Get the job status of an Apply Line Key Template job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job status for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Check a line key template job status in this organization."
}
]
},
"docs": "Get the status of an apply line key template job by its job ID.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to check the status of an apply line key templates job by job ID in an organization.\n\nChecking the the status of an apply line key templates job in an organization re"
},
{
"info": {
"name": "Get job errors for an Apply Line Key Template job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/applyLineKeyTemplate/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job errors for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of errors for an apply line key template job in this organization."
}
]
},
"docs": "GET job errors for an apply Line Key Template job in an organization.\n\nLine Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.\nA Line Key Template is a definition of actions that will be performed by each of the Line Keys for a particular device model.\nThis API allows users to retrieve all the errors of an apply line key templates job by job ID in an organization.\n\nRetrieving all the errors of an apply line key templates job in an "
},
{
"info": {
"name": "Read the DECT device type list - Deprecated",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/dects/supportedDevices",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query"
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP).
\n\nThe REST path for this API has changed to [GET /telephony/config/devices/dectNetworks/supportedDevices{?orgId}]. The use of this old REST path is deprecated and will be decommissioned on October 10, 2024. Please start using it for all future projects.
\n\nGet DECT device type list with base stations and line ports supported count. This is a static list.\n\nRetri"
},
{
"info": {
"name": "Read the DECT device type list",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/dectNetworks/supportedDevices",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query"
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP).
\n\nGet DECT device type list with base stations and line ports supported count. This is a static list.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Validate a list of MAC address",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/devices/actions/validateMacs/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Validate the mac address(es) for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate a list of MAC addresses.\n\nValidating this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Change Device Settings Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of 'calldevicesettings' jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of jobs. Default is 0."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the number of jobs returned to this maximum count. Default is 2000."
}
]
},
"docs": "List change device settings jobs.\n\nLists all the jobs for jobType `calldevicesettings` for the given organization in order of most recent one to oldest one irrespective of its status.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Change Device Settings Across Organization Or Location Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Apply change device settings for all the devices under this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Change device settings across organization or locations jobs.\n\nPerforms bulk and asynchronous processing for all types of device settings initiated by organization and system admins in a stateful persistent manner. This job will modify the requested device settings across all the devices. Whenever a location ID is specified in the request, it will modify the requested device settings only for the devices that are part of the provided location within an organization.\n\nReturns a unique job ID whic"
},
{
"info": {
"name": "Get Change Device Settings Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ",
"type": "path",
"description": "Retrieve job details for this `jobId`."
}
]
},
"docs": "Get change device settings job status.\n\nProvides details of the job with `jobId` of `jobType` `calldevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "List Change Device Settings Job Errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/callDeviceSettings/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ",
"type": "path",
"description": "Retrieve job details for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the offset from the first result that you want to fetch. Default is 0."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch. Default is 2000"
}
]
},
"docs": "List change device settings job errors.\n\nLists all error details of the job with `jobId` of `jobType` `calldevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Device Layout by Device ID",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/layout",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8yM2VlNDM5OS1lZWYwLTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "path",
"description": "Get device layout for this device ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve a device layout for the device in this organization."
}
]
},
"docs": "Get layout information of a device by device ID in an organization.\n\nDevice layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Device Layout by Device ID",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/layout",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8yM2VlNDM5OS1lZWYwLTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM/",
"type": "path",
"description": "Modify device layout for this device ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify a device layout for the device in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the layout of a device by device ID in an organization.\n\nDevice layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Rebuild Phones Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List of rebuild phones jobs in this organization."
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP)
.\n\nGet the list of all Rebuild Phones jobs in an organization.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Rebuild Phones Configuration",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Rebuild phones for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Not supported for Webex for Government (FedRAMP)
.\n\nRebuild all phone configurations for the specified location.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get the Job Status of a Rebuild Phones Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job status for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Check a rebuild phones job status in this organization."
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP)
.\n\nGet the details of a rebuild phones job by its job ID.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Job Errors for a Rebuild Phones Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/rebuildPhones/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job errors for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of errors for a rebuild phones job in this organization."
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP)
.\n\nGet errors for a rebuild phones job in an organization.\n\nRebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e. a change in the network configuration of devices in a location from public to private and vice-versa.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Device Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/devices/settings",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDM2ZWI2NC1iNDliLTQ1ZTUtOTM1ZS1hYmQ2NGUwNjc2ZmI",
"type": "path",
"description": "ID of the person for whom to retrieve device settings."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE",
"type": "query",
"description": "Retrieves the device settings for a person in this organization."
}
]
},
"docs": "Device settings list the compression settings for a person.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Device Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/devices/settings",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80MDM2ZWI2NC1iNDliLTQ1ZTUtOTM1ZS1hYmQ2NGUwNjc2ZmI",
"type": "path",
"description": "ID of the person for whom to update device settings."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE",
"type": "query",
"description": "Modify device settings for a person in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update device settings modifies the compression settings for a person.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, or user administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Device Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices/settings",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWdvdi13ZXN0LTFfYTEvUExBQ0UvYTA4MTEyOWMtMTExYi00NTEyLWI1OGItZTdjODY0ZGZlMzY0",
"type": "path",
"description": "ID of the workspace for which to retrieve device settings."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE",
"type": "query",
"description": "Retrieves the device settings for a workspace in this organization."
}
]
},
"docs": "Device settings list the compression settings for a workspace.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Device Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/devices/settings",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWdvdi13ZXN0LTFfYTEvUExBQ0UvYTA4MTEyOWMtMTExYi00NTEyLWI1OGItZTdjODY0ZGZlMzY0",
"type": "path",
"description": "ID of the workspace for which to update device settings."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9jNzJmNWM3My02OGJlLTRlNTctODNjYS00NjBiMWMzNzBkMmE",
"type": "query",
"description": "Modify the device settings for a workspace in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update device settings modifies the compression settings for a workspace.\n\nDevice settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.\n\nThis API requires a full, location, or user administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the List of Background Images",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/backgroundImages",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves the list of images in this organization."
}
]
},
"docs": "Gets the list of device background images for an organization.\n\nWebex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image.\n\nRetrieving this list requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Delete Device Background Images",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/devices/backgroundImages",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Deletes the list of images in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Delete the list of designated device background images for an organization. Maximum is 10 images per request.\n\nDeleting a device background image requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Upload a Device Background Image",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/actions/backgroundImageUpload/invoke",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Uploads the image in this organization."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
},
{
"name": "fileName",
"type": "text",
"value": ""
}
]
}
},
"docs": "Configure a device's background image by uploading an image with file format, `.jpeg` or `.png`, encoded image file. Maximum image file size allowed to upload is 625 KB.\n\nThe request must be a multipart/form-data request rather than JSON, using the image/jpeg or image/png content-type.\n\nWebex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image.\n\nUploading a device backgr"
},
{
"info": {
"name": "Get User Devices Count",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/devices/count",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "Person for whom to retrieve the device count."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the person belongs."
}
]
},
"docs": "Get the total device and application count for a person.\n\nThe device count can be used to determine if more devices can be added for users with a device count limit. For example, users with standard calling licenses can only have one physical device.\n\nThis requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
}
]
},
{
"info": {
"name": "Device Call Settings With Device Dynamic Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Supported Devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/supportedDevices",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List supported devices for an organization."
},
{
"name": "allowConfigureLayoutEnabled",
"value": "true",
"type": "query",
"description": "List supported devices that allow the user to configure the layout."
},
{
"name": "type",
"value": "MPP",
"type": "query",
"description": "List supported devices of a specific type. To excluded device types from a request or query, add `type=not:DEVICE_TYPE`. For example, `type=not:MPP`."
}
]
},
"docs": "Gets the list of supported devices for an organization.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Settings Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/dynamicSettings/settingsGroups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Settings groups for devices in this organization."
},
{
"name": "familyOrModelDisplayName",
"value": "Poly",
"type": "query",
"description": "Device family or model display name to filter the `settingsGroups`."
},
{
"name": "includeSettingsType",
"value": "ALL",
"type": "query",
"description": "To show groups or tabs or both. Query param is case insensitive. Default is `ALL`."
}
]
},
"docs": "This API returns the `settingsGroups` that define the structure and association of tags for device dynamic settings.\n\n The `settingsGroups` are used to organize the tags into logical groups, making it easier to manage and configure device dynamic settings."
},
{
"info": {
"name": "Get Customer Device Dynamic Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/lists/devices/dynamicSettings/actions/getSettings/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List of device dynamic settings in this organization."
},
{
"name": "familyOrModelDisplayName",
"value": "Poly",
"type": "query",
"description": "The family or model name for the device. If no tag is specified, all tags related to `familyOrModelDisplayName` are returned."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieve dynamic settings for specific device tags at customer level, allowing filters by `familyOrModelDisplayName` and `tag` identifier.\n\nThis API lets you request the values of multiple `Device Settings` at once by specifying a list of `familyOrModelDisplayName` and tag combinations.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Location Device Dynamic Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/lists/locations/:locationId/devices/dynamicSettings/actions/getSettings/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMzZjBlZDFiLWQ1YjctNGI4Mi1iMzIzLTg4ZTFmODMzNGNmMw",
"type": "path",
"description": "Unique identifier for the `location`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the `organization` to which this location belongs."
},
{
"name": "familyOrModelDisplayName",
"value": "Poly",
"type": "query",
"description": "The family or model name for the device. If no tag is specified, all tags related to `familyOrModelDisplayName` are returned."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieve dynamic settings for specific device tags at the specified location level, allowing filters by `familyOrModelDisplayName` and `tag` identifier.\n\nThis API lets you request the values of multiple `Device Settings` at once by specifying a list of `familyOrModelDisplayName` and tag combinations for a specific location.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Device Dynamic Settings",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/lists/devices/:deviceId/dynamicSettings/actions/getSettings/invoke",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Device for which to retrieve settings."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the `device` belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Retrieve settings for a specified device.\n\nThis API retrieves device settings based on the specified `tags`; if the `tags` field is empty or missing, all settings for the device are returned.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Device Dynamic Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/devices/:deviceId/dynamicSettings",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9DQUxMSU5HX0RFVklDRS8zMDAyZWJiZi1iMTVmLTQ1ODktYWNiZS1kZjY3OTA3MTU5NWE=",
"type": "path",
"description": "Device for which to update settings."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the device belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify dynamic settings for a specified device.\n\nThis API updates device settings based on the specified `tags`. If the `tags` field is empty, the request has no effect.\n\nThis requires a full, device, or read-only administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Device Dynamic Settings Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve list of device dynamic settings jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of jobs. Default is 0."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the number of jobs returned to this maximum count. Default is 2000."
}
]
},
"docs": "List device dynamic settings jobs.\n\nLists all the jobs for job type `dynamicdevicesettings` for the given organization in order of most recent one to oldest one irrespective of its status.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Device Dynamic Settings Across Organization or Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Apply update device dynamic settings for all the devices under this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a job to update device settings at location or organization level.\n\nThe job runs asynchronously and persistently, applying the requested settings in bulk to all relevant devices, which may belong to multiple families as specified in the request. If a `locationId` is provided, only devices in that location are affected.\n\nA unique job ID is returned to track status and errors.\n\nOnly one job can run per customer per organization at a time. Additionally, this job cannot run in parallel with "
},
{
"info": {
"name": "Get Device Dynamic Settings Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ",
"type": "path",
"description": "Retrieve job details for this `jobId`."
}
]
},
"docs": "Get device dynamic settings job status.\n\nProvides details of the job with `jobId` of `jobType` `dynamicdevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "List Device Dynamic Settings Job Errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/devices/dynamicDeviceSettings/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8wMTA4NDJjMy1mNWQ5LTRjOWQtOGZiYi0yYzIxZmU4OWI0YzQ",
"type": "path",
"description": "Retrieve job details for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve the status of job for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the offset from the first result that you want to fetch. Default is 0."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch. Default is 2000"
}
]
},
"docs": "List Update device dynamic settings job errors.\n\nLists all error details of the job with `jobId` of `jobType` `dynamicdevicesettings`.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
}
]
},
{
"info": {
"name": "Beta Device Call Settings With Dynamic Device Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Validation Schema",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/devices/dynamicSettings/validationSchema",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Validation schema for devices in this organization."
},
{
"name": "familyOrModelDisplayName",
"value": "Poly",
"type": "query",
"description": "Device family or model display name to filter the schema."
}
]
},
"docs": "This API returns the validation schema for `tags` of all or specific `familyOrModelDisplayName`.\n\nThe schema is used to validate the `tag` for devices in the `Webex Calling` platform. The schema includes information about the required fields, data types, and validation rules for each setting."
}
]
},
{
"info": {
"name": "Devices",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Devices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/devices",
"params": [
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of devices in the response."
},
{
"name": "start",
"value": "",
"type": "query",
"description": "\nOffset. Default is 0.\n"
},
{
"name": "displayName",
"value": "SFO12-3-PanHandle",
"type": "query",
"description": "\nList devices with this display name.\n"
},
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"type": "query",
"description": "\nList devices by person ID.\n"
},
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=",
"type": "query",
"description": "\nList devices by workspace ID.\n"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "\nList devices in this organization. Only admin users of another organization (such as partners) may use this parameter.\n"
},
{
"name": "connectionStatus",
"value": "",
"type": "query",
"description": "\nList devices with this connection status.\n"
},
{
"name": "product",
"value": "",
"type": "query",
"description": "\nList devices with this product name.\n"
},
{
"name": "type",
"value": "",
"type": "query",
"description": "\nList devices with this type.\n"
},
{
"name": "serial",
"value": "",
"type": "query",
"description": "\nList devices with this serial number.\n"
},
{
"name": "tag",
"value": "",
"type": "query",
"description": "\nList devices which have a tag. Searching for multiple tags (logical AND) can be done by comma separating the `tag` values or adding several `tag` parameters.\n"
},
{
"name": "software",
"value": "",
"type": "query",
"description": "\nList devices with this software version.\n"
},
{
"name": "upgradeChannel",
"value": "",
"type": "query",
"description": "\nList devices with this upgrade channel.\n"
},
{
"name": "errorCode",
"value": "",
"type": "query",
"description": "\nList devices with this error code.\n"
},
{
"name": "capability",
"value": "xapi",
"type": "query",
"description": "\nList devices with this capability.\n"
},
{
"name": "permission",
"value": "",
"type": "query",
"description": "\nList devices with this permission.\n"
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=",
"type": "query",
"description": "\nList devices by location ID.\n"
},
{
"name": "workspaceLocationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc=",
"type": "query",
"description": "\nList devices by workspace location ID. Deprecated, prefer `locationId`.\n"
},
{
"name": "mac",
"value": "",
"type": "query",
"description": "\nList devices with this MAC address.\n"
},
{
"name": "devicePlatform",
"value": "cisco",
"type": "query",
"description": "\nList devices with this device platform.\n"
},
{
"name": "plannedMaintenance",
"value": "off",
"type": "query",
"description": "\nList devices with this planned maintenance.\n"
}
]
},
"docs": "Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. This requires the `spark:devices_read` scope. Administrators can list all devices within their organization. This requires an administrator auth token with the `spark-admin:devices_read` scope."
},
{
"info": {
"name": "Create a Device by MAC Address",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/devices",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ",
"type": "query",
"description": "The organization associated with the device. If left empty, the organization associated with the caller will be used."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a phone by its MAC address in a specific workspace or for a person.\n\nSpecify the `mac`, `model` and either `workspaceId` or `personId`.\n\n* You can get the `model` from the [supported devices](/docs/api/v1/device-call-settings/read-the-list-of-supported-devices) API.\n\n* Either `workspaceId` or `personId` should be provided. If both are supplied, the request will be invalid.\n\n* The `password` field is only required for third party devices. You can obtain the required third party phone confi"
},
{
"info": {
"name": "Get Device Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"type": "path",
"description": "\nA unique identifier for the device.\n"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ",
"type": "query",
"description": "The organization associated with the device. If left empty, the organization associated with the caller will be used."
}
]
},
"docs": "Shows details for a device, by ID. This requires an auth token with the `spark:devices_read` scope to see your own device, or `spark-admin:devices_read` to see any other device in your organization.\n\nSpecify the device ID in the `deviceId` parameter in the URI."
},
{
"info": {
"name": "Modify Device Tags",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"type": "path",
"description": "Unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ",
"type": "query",
"description": "The organization associated with the device. If left empty, the organization associated with the caller will be used."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create, delete or update tags on a device. For your own device, this requires an auth token with the `spark:devices_write` scope. An auth token with the `spark-admin:devices_write` scope is required to operate on other devices within the organization.\n\nSpecify the device ID in the `deviceId` parameter in the URI.\n\nInclude only the tag array in the request body, no other device attributes can be changed. This action will overwrite any previous tags. A common approach is to first [GET the devices'"
},
{
"info": {
"name": "Delete a Device",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/devices/:deviceId",
"params": [
{
"name": "deviceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"type": "path",
"description": "A unique identifier for the device."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ",
"type": "query",
"description": "The organization associated with the device. If left empty, the organization associated with the caller will be used."
}
]
},
"docs": "Deletes a device, by ID. Deleting your own device requires an auth token with the `spark:devices_write` scope. Deleting any other device in the organization will require an administrator auth token with the `spark-admin:devices_write` scope.\n\nSpecify the device ID in the `deviceId` parameter in the URI.\n\nDeleting a device from a person with a Webex Calling Standard license will enable Webex Calling across their Webex mobile, tablet, desktop, and browser applications."
},
{
"info": {
"name": "Create a Device Activation Code",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/devices/activationCode",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLXdlc3QtMl9yL09SR0FOSVpBVElPTi9mN2I3MzYwYy1lMDcxLTQwN2EtYTU1Ny04NDI4YmIyMjhlODQ",
"type": "query",
"description": "The organization associated with the activation code generated. If left empty, the organization associated with the caller will be used."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Generate an activation code for a device in a specific workspace by `workspaceId` or for a person by `personId`. This requires an auth token with the `spark-admin:devices_write` scope, and either `identity:placeonetimepassword_create` (allows creating activation codes for workspaces only) or `identity:one_time_password` (allows creating activation codes for workspaces or persons).\n\n* Adding a device to a workspace with calling type `none` or `thirdPartySipCalling` will reset the workspace callin"
}
]
},
{
"info": {
"name": "Emergency Services Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Update RedSky Service Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/redSky/serviceSettings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update E911 settings for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the RedSky service settings.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nUpdating the RedSky service settings requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve RedSky Account Details for an Organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/redSky",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve RedSky account for the organization."
}
]
},
"docs": "Retrieve RedSky account details for an organization.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nTo retrieve the RedSky account details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony"
},
{
"info": {
"name": "Create an Account and Admin in RedSky",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/redSky",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create RedSky account for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create an account and admin in RedSky.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nCreating a RedSky account requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get the Organization Compliance Status for a RedSky Account",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/redSky/status",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve the compliance status for the organization."
}
]
},
"docs": "Get the organization compliance status for a RedSky account. The `locationStatus.state` in the response will show the state for the location that is in the earliest stage of configuration.\n\nThe enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canad"
},
{
"info": {
"name": "Update the Organization RedSky Account's Compliance Status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/redSky/status",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update E911 compliance status for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the compliance status for the customer's RedSky account.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nUpdating the RedSky account's compliance status requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get the Organization Compliance Status and the Location Status List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/redSky/complianceStatus",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve the compliance status and the list of location statuses for the organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
},
{
"name": "order",
"value": "locationName-asc",
"type": "query",
"description": "Sort the list of locations in ascending or descending order. To sort in descending order append `-desc` to possible sort order values. Possible sort order values are `locationName` and `locationState`."
}
]
},
"docs": "Get the organization compliance status and the location status list for a RedSky account.\n\nThe enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.\n\nTo retrieve organization compliance status requires a full, user or read-only administrator aut"
},
{
"info": {
"name": "Login to a RedSky Admin Account",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/redSky/actions/login/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Login to a RedSky account for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Login to Redsky for an existing account admin user to retrieve the `companyId` and verify the status of `externalTenantEnabled`. The password provided will not be stored.\n\nThe enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.\n\nLogging in req"
},
{
"info": {
"name": "Get a Location's RedSky Emergency Calling Parameters",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/redSky",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Retrieve Calling Parameters for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Calling Parameters for the location in this organization."
}
]
},
"docs": "Get the Emergency Calling Parameters for a specific location.\n\nThe enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.\n\nTo retrieve location calling parameters requires a full, user, or read-only administrator auth token with a scope of `spark"
},
{
"info": {
"name": "Get a Location's RedSky Compliance Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/redSky/status",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Retrieve the compliance status for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve compliance status for the location in this organization."
}
]
},
"docs": "Get RedSky compliance status for a specific location.\n\nThe enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce. It provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.\n\nRetrieving the location's compliance status requires a full, user, or read-only administrator auth token with a scope of `spark-adm"
},
{
"info": {
"name": "Update a Location's RedSky Compliance Status",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/redSky/status",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Update the E911 compliance status for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the E911 compliance status for the location in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the compliance status for a specific location.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nUpdating the RedSky account's compliance status requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create a RedSky Building Address and Alert Email for a Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/redSky/building",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Create the building address and alert email for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization in which the location exists."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a RedSky building address and alert email for a specified location.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nCreating a building address and alert email requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Update a RedSky Building Address for a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/redSky/building",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Update the building address for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization in which the location exists."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a RedSky building address for a specified location.\n\nThe Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada. E911 services are provided in conjunction with a RedSky account.\n\nUpdating a building address requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get an Organization Emergency Call Notification",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/emergencyCallNotification",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Emergency Call Notification attributes for the organization."
}
]
},
"docs": "Get organization emergency call notification.\n\nEmergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that's made from within your organization to emergency services must generate an email notification.\n\nTo retrieve organization call notifications requires a full, user or read-only administrator auth token wit"
},
{
"info": {
"name": "Update an Organization Emergency Call Notification",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/emergencyCallNotification",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Update Emergency Call Notification attributes for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an organization emergency call notification.\n\nOnce settings are enabled at the organization level, the configured email address will receive emergency call notifications for all locations.\n\nEmergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that's made from within your organization to emergency serv"
},
{
"info": {
"name": "Get a Location Emergency Call Notification",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/emergencyCallNotification",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Retrieve Emergency Call Notification attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Emergency Call Notification attributes for the location in this organization."
}
]
},
"docs": "Get location emergency call notification.\n\nEmergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. Once activated at the organization level, individual locations can configure this setting to direct notifications to specific email addresses. To comply with U.S. Public Law 115-127, also known as Kari’s Law, any call that's made from within your organization to emergency services must g"
},
{
"info": {
"name": "Update a Location Emergency Call Notification",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/emergencyCallNotification",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzc4OWRkZTBjLWQ3N2ItNGYwZS1hYmJmLWY5YWFkMzQzOTJhZg",
"type": "path",
"description": "Update Emergency Call Notification attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Update Emergency Call Notification attributes for a location in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a location emergency call notification.\n\nOnce settings enabled at the organization level, the configured email address will receive emergency call notifications for all locations; for specific location customization, users can navigate to Management > Locations, select the Calling tab, and update the Emergency Call Notification settings.\n\nEmergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergen"
},
{
"info": {
"name": "Get Dependencies for a Hunt Group Emergency Callback Number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/huntGroups/:huntGroupId/emergencyCallbackNumber/dependencies",
"params": [
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the hunt group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Emergency Callback Number attributes for the hunt group under this organization."
}
]
},
"docs": "Retrieves the emergency callback number dependencies for a specific hunt group.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nRetrieving the dependencies requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get a Person's Emergency Callback Number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/emergencyCallbackNumber",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "ID of the organization within 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 person's emergency callback number settings.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emergency Service Addresses to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes."
},
{
"info": {
"name": "Update a Person's Emergency Callback Number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/emergencyCallbackNumber",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "ID of the organization within 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": "Update a person's emergency callback number settings.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.\n\nTo update an emergency callback "
},
{
"info": {
"name": "Retrieve A Person's Emergency Callback Number Dependencies",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/emergencyCallbackNumber/dependencies",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Emergency Callback Number attributes for this organization."
}
]
},
"docs": "Retrieve Emergency Callback Number dependencies for a person.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.\n\nRetrieving the dependen"
},
{
"info": {
"name": "Get a Workspace Emergency Callback Number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/emergencyCallbackNumber",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk",
"type": "path",
"description": "Retrieve Emergency Callback Number attributes for this workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Emergency Callback Number attributes for this organization."
}
]
},
"docs": "Retrieve the emergency callback number setting associated with a specific workspace.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emergency Service Addresses to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that loc"
},
{
"info": {
"name": "Update a Workspace Emergency Callback Number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/emergencyCallbackNumber",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk",
"type": "path",
"description": "Updating Emergency Callback Number attributes for this workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Updating Emergency Callback Number attributes for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the emergency callback number settings for a workspace.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.\n\nTo update an emergency"
},
{
"info": {
"name": "Retrieve Workspace Emergency Callback Number Dependencies",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/emergencyCallbackNumber/dependencies",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzBjZWViMWZjLThmYTItNDk4YS1hYzc2LTY3YzJkZDcwZDZk",
"type": "path",
"description": "Retrieve Emergency Callback Number attributes for this workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi84NzU2ZjkwZS1iZDg4LTRhOTQtOGZiZC0wMzM2NzhmMDU5ZjM",
"type": "query",
"description": "Retrieve Emergency Callback Number attributes for this organization."
}
]
},
"docs": "Retrieve Emergency Callback Number dependencies for a workspace.\n\nEmergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Call Back Numbers (ECBN) to enable them to make emergency calls. These users can either utilize the default ECBN for their location or be assigned another specific telephone number from that location for emergency purposes.\n\nRetrieving the depen"
},
{
"info": {
"name": "Get Dependencies for a Virtual Line Emergency Callback Number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/emergencyCallbackNumber/dependencies",
"params": [
{
"name": "virtualLineId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfUFJPRklMRS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY",
"type": "path",
"description": "Unique identifier for the virtual line."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List virtual lines for this organization."
}
]
},
"docs": "Retrieves the emergency callback number dependencies for a specific virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.\n\nRetrieving the dependencies requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get the Virtual Line's Emergency Callback settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/emergencyCallbackNumber",
"params": [
{
"name": "virtualLineId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY=",
"type": "path",
"description": "Unique identifier for the virtual line."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List virtual lines for this organization."
}
]
},
"docs": "Retrieves the emergency callback number settings for a specific virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.\n\nRetrieving the dependencies requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Virtual Line's Emergency Callback settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/virtualLines/:virtualLineId/emergencyCallbackNumber",
"params": [
{
"name": "virtualLineId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS84ZDRkMDNlYS03NTUzLTQ0NTgtYmI4OS02YzExNzgyMzA4OWY=",
"type": "path",
"description": "Unique identifier for the virtual line."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List virtual lines for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the emergency callback number settings for a specific virtual line.\n\nVirtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.\n\nTo update virtual line callback number requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Features: Announcement Playlist",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Announcement Playlists",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements/playlists",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get announcements playlist in this organization."
}
]
},
"docs": "Fetch a list of announcement playlist at an organization.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create Announcement Playlist",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/announcements/playlists",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create an announcement playlist in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create announcement Playlist at an organization level. A maximum of 25 announcement files can be included in a single playlist.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Announcement Playlist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId",
"params": [
{
"name": "playlistId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jNzAwNmI4ZC1kYmQ3LTQ3YjctOWQ0Ny05ZDJkMWEzYmY1Yzc",
"type": "path",
"description": "Unique identifier of an announcement playlist."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get an announcement playlist in this organization."
}
]
},
"docs": "Fetch details of announcement playlist by its ID at an organization level.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Announcement Playlist",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId",
"params": [
{
"name": "playlistId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement playlist."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify an announcement playlist in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify an existing announcement playlist at an organization level.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete Announcement Playlist",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId",
"params": [
{
"name": "playlistId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC9jNzAwNmI4ZC1kYmQ3LTQ3YjctOWQ0Ny05ZDJkMWEzYmY1Yzc",
"type": "path",
"description": "Unique identifier of an announcement playlist."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete an announcement playlist in this organization."
}
]
},
"docs": "Delete an announcement playlist for an organization.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Playlist Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId/locations",
"params": [
{
"name": "playlistId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of playlist."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get location associated to a playlist in this organization."
}
]
},
"docs": "Fetch list of locations which are assigned to the given announcement playlist\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Playlist Locations",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/announcements/playlists/:playlistId/locations",
"params": [
{
"name": "playlistId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement playlist."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify an assign location for announcement playlist for organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify list of assigned locations or add new locations to the announcement playlist. This will assing the playlist to the location's music on hold.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Call Queue Settings with Playlist Settings",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Playlist Usage",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements/playlists/:playListId/usage",
"params": [
{
"name": "playListId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQVlMSVNULzg1NWU1N2M0LWUzYTAtNGEyZS1hYWYxLTQ3ZWUxMmI3M2U2MA==",
"type": "path",
"description": "Unique identifier of the playlist."
},
{
"name": "playlistUsageType",
"value": "feature",
"type": "query",
"description": "Filter usage by type."
}
]
},
"docs": "Get Playlist Usage"
}
]
},
{
"info": {
"name": "Features: Announcement Repository",
"type": "folder"
},
"items": [
{
"info": {
"name": "Fetch list of announcement greetings on location and organization level",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get announcements in this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Return the list of enterprise or Location announcement files. Without this parameter, the Enterprise level announcements are returned."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "fileName-desc",
"type": "query",
"description": "Sort the list according to fileName or fileSize. The default sort will be in Ascending order."
},
{
"name": "fileName",
"value": "RegionalAnnouncement",
"type": "query",
"description": "Return the list of announcements with the given fileName."
},
{
"name": "fileType",
"value": "audio",
"type": "query",
"description": "Return the list of announcement files for this fileType."
},
{
"name": "mediaFileType",
"value": "wav",
"type": "query",
"description": "Return the list of announcement files for this mediaFileType."
},
{
"name": "name",
"value": "General Announcement",
"type": "query",
"description": "Return the list of announcement files for this announcement label."
}
]
},
"docs": "Fetch a list of binary announcement greetings at an organization as well as location level.\n\nAn admin can upload a file at an organization level. This file will be uploaded to the announcement repository.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Upload a binary announcement greeting at organization level",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/announcements",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create an announcement in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upload a binary file to the announcement repository at an organization level.\n\nAn admin can upload a file at an organization level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Fetch repository usage for announcements for an organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements/usage",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get announcement usage in this organization."
}
]
},
"docs": "Retrieves repository usage for announcements for an organization.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Fetch details of a binary announcement greeting at the organization level",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/announcements/:announcementId",
"params": [
{
"name": "announcementId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get an announcement in this organization."
}
]
},
"docs": "Fetch details of a binary announcement greeting by its ID at an organization level.\n\nAn admin can upload a file at an organization level. This file will be uploaded to the announcement repository.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a binary announcement greeting at organization level",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/announcements/:announcementId",
"params": [
{
"name": "announcementId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify an announcement in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify an existing announcement greeting at an organization level.\n\nAn admin can upload a file or modify an existing file at an organization level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete an announcement greeting of the organization",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/announcements/:announcementId",
"params": [
{
"name": "announcementId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete an announcement in this organization."
}
]
},
"docs": "Delete an announcement greeting for an organization.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Upload a binary announcement greeting at the location level",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/announcements",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2U1MjQ0OGU5LTE1NjQtNDNlOS04YzY1LWMyYWMwNDY1ZWMwYw",
"type": "path",
"description": "Unique identifier of a location where an announcement is being created."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create an announcement for location in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upload a binary file to the announcement repository at a location level.\n\nAn admin can upload a file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Fetch repository usage for announcements in a location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/announcements/usage",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2U1MjQ0OGU5LTE1NjQtNDNlOS04YzY1LWMyYWMwNDY1ZWMwYw",
"type": "path",
"description": "Unique identifier of a location where an announcement is being created."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get announcement usage for location in this organization."
}
]
},
"docs": "Retrieves repository usage for announcements in a location.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Fetch details of a binary announcement greeting at location level",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/announcements/:announcementId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2U1MjQ0OGU5LTE1NjQtNDNlOS04YzY1LWMyYWMwNDY1ZWMwYw",
"type": "path",
"description": "Unique identifier of a location where an announcement is being created."
},
{
"name": "announcementId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Fetch an announcement for location in this organization."
}
]
},
"docs": "Fetch details of a binary announcement greeting by its ID at a location level.\n\nAn admin can upload a file at a location level. This file will be uploaded to the announcement repository.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a binary announcement greeting at location level",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/announcements/:announcementId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2U1MjQ0OGU5LTE1NjQtNDNlOS04YzY1LWMyYWMwNDY1ZWMwYw",
"type": "path",
"description": "Unique identifier of a location where an announcement is being created."
},
{
"name": "announcementId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify an announcement for location in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify an existing announcement greeting at a location level.\n\nAn admin can upload a file or modify an existing file at a location level. This file will be uploaded to the announcement repository.\n\nYour request will need to be an `application/json` request with the announcement details including name, fileUri, fileName, and isTextToSpeech fields.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete an announcement greeting in a location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/announcements/:announcementId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2U1MjQ0OGU5LTE1NjQtNDNlOS04YzY1LWMyYWMwNDY1ZWMwYw",
"type": "path",
"description": "Unique identifier of a location where announcement is being created."
},
{
"name": "announcementId",
"value": "Y2lzY29zcGFyazovL3VzL0FOTk9VTkNFTUVOVC8zMjAxNjRmNC1lNWEzLTQxZmYtYTMyNi02N2MwOThlNDFkMWQ",
"type": "path",
"description": "Unique identifier of an announcement."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete an announcement for location in this organization."
}
]
},
"docs": "Delete an announcement greeting in a location.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Generate a Text-to-Speech Prompt",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/textToSpeech/actions/generate/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Generate text-to-speech for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Generate a text-to-speech prompt from the provided text, voice, and language.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Text-to-Speech Usage",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/textToSpeech/usage",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get text-to-speech usage for this organization."
}
]
},
"docs": "Retrieve text-to-speech usage information, including the number of API calls made, the maximum allowed within the time window, and the timestamp indicating when the usage will reset.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or loc"
},
{
"info": {
"name": "Get Text-to-Speech Generation Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/textToSpeech/:ttsId",
"params": [
{
"name": "ttsId",
"value": "Y2lzY29zcGFyazovL3VzL1RFWFRfVE9fU1BFRUNILzMyMDE2NGY0LWU1YTMtNDFmZi1hMzI2LTY3YzA5OGU0MWQxZA",
"type": "path",
"description": "Unique identifier of the text-to-speech generation request."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get text-to-speech status for this organization."
}
]
},
"docs": "Get the status of a text-to-speech generation request by its ID. If the status is SUCCESS, the response includes `promptUrl`, `kmsKeyUri`, and `fileUri` to preview or use the audio prompt.\n\nTo preview the audio prompt:\n\n1. Download the KMS key - use the Webex Node.js SDK and provide `kmsKeyUri` to download the key from KMS.\n\n2. Download the encrypted audio - The encrypted audio file content is stored in cloud and can be retrieved using `promptURL`.\n\n3. Decrypt the audio content - Use the jose li"
},
{
"info": {
"name": "List Text-to-Speech Voices",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/textToSpeech/voices",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List text-to-speech voices supported for this organization."
}
]
},
"docs": "Fetch a list of available text-to-speech voices. Use the returned voice ID in the generation request.\n\nText-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice. The generated audio functions like a recorded WAV file, eliminating the need for manual recording.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read"
}
]
},
{
"info": {
"name": "Features: Auto Attendant",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Auto Attendants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/autoAttendants",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List auto attendants for this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Return the list of auto attendants for this location."
},
{
"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": "name",
"value": "Main Line AA - Test",
"type": "query",
"description": "Only return auto attendants with the matching name."
},
{
"name": "phoneNumber",
"value": "9705550028",
"type": "query",
"description": "Only return auto attendants with the matching phone number."
}
]
},
"docs": "List all Auto Attendants for the organization.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Details for an Auto Attendant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Retrieve an auto attendant details in this location."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Retrieve the auto attendant with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve auto attendant details from this organization."
}
]
},
"docs": "Retrieve an Auto Attendant details.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nRetrieving an auto attendant details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update an Auto Attendant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Update an auto attendant with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update an auto attendant from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Auto Attendant.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nUpdating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete an Auto Attendant",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete an auto attendant."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Delete the auto attendant with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the auto attendant from this organization."
}
]
},
"docs": "Delete the designated Auto Attendant.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nDeleting an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create an Auto Attendant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Create the auto attendant for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the auto attendant for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Auto Attendant for the given location.\n\nAuto attendants play customized prompts and provide callers with menu options for routing their calls through your system.\n\nCreating an auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Call Forwarding Settings for an Auto Attendant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Retrieve the call forwarding settings for this auto attendant."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve auto attendant forwarding settings from this organization."
}
]
},
"docs": "Retrieve Call Forwarding settings for the designated Auto Attendant including the list of call forwarding rules.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nRetrieving call forwarding settings for an auto "
},
{
"info": {
"name": "Update Call Forwarding Settings for an Auto Attendant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Update call forwarding settings for this auto attendant."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update auto attendant forwarding settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Forwarding settings for the designated Auto Attendant.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nUpdating call forwarding settings for an auto attendant requires a full administrator or locat"
},
{
"info": {
"name": "Create a Selective Call Forwarding Rule for an Auto Attendant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding/selectiveRules",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which the auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Create the rule for this auto attendant."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the auto attendant rule for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Selective Call Forwarding Rule for the designated Auto Attendant.\n\nA selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the auto attendant's call forwarding settings.\n\nCreating a selective call forwarding rule for an auto attendant requires a full administrator auth token with a scope of `spark-admin:telephony_config_"
},
{
"info": {
"name": "Get Selective Call Forwarding Rule for an Auto Attendant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2J6QjJlRGd6Ym1GeU5rQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Retrieve settings for a rule for this auto attendant."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WR1Z6ZENCU2RXeGw",
"type": "path",
"description": "Auto attendant rule you are retrieving settings for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve auto attendant rule settings for this organization."
}
]
},
"docs": "Retrieve a Selective Call Forwarding Rule's settings for the designated Auto Attendant.\n\nA selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the auto attendant's call forwarding settings.\n\nRetrieving a selective call forwarding rule's settings for an auto attendant requires a full or read-only administrator or location admini"
},
{
"info": {
"name": "Update Selective Call Forwarding Rule for an Auto Attendant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Update settings for a rule for this auto attendant."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WR1Z6ZENCU2RXeGw",
"type": "path",
"description": "Auto attendant rule you are updating settings for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update auto attendant rule settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a Selective Call Forwarding Rule's settings for the designated Auto Attendant.\n\nA selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the auto attendant's call forwarding settings.\n\nUpdating a selective call forwarding rule's settings for an auto attendant requires a full administrator or location administrator auth toke"
},
{
"info": {
"name": "Delete a Selective Call Forwarding Rule for an Auto Attendant",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5UL2QzVjBPWFIxWjJkM2FFQm1iR1Y0TWk1amFYTmpieTVqYjIw",
"type": "path",
"description": "Delete the rule for this auto attendant."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9WR1Z6ZENCU2RXeGw",
"type": "path",
"description": "Auto attendant rule you are deleting."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete auto attendant rule from this organization."
}
]
},
"docs": "Delete a Selective Call Forwarding Rule for the designated Auto Attendant.\n\nA selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the auto attendant's call forwarding settings.\n\nDeleting a selective call forwarding rule for an auto attendant requires a full administrator or location administrator auth token with a scope of `spa"
},
{
"info": {
"name": "Get Auto Attendant Primary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/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 auto attendant'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 toke"
},
{
"info": {
"name": "Get Auto Attendant Alternate Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/alternate/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 auto attendant's alternate 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 token wi"
},
{
"info": {
"name": "Get Auto Attendant Call Forward Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/callForwarding/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."
},
{
"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 the auto attendant's call forward number.\nThese numbers are associated with the location 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 or location admini"
},
{
"info": {
"name": "Switch Mode for Call Forwarding Settings for an Auto Attendant",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/callForwarding/actions/switchMode/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "`Location` in which this `auto attendant` exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0FVVE9fQVRURU5EQU5ULzk3ZjJiODY1LTc3NTUtNGVlOC05NDY0LTFjOGU1NGE1OGVjNQ",
"type": "path",
"description": "Switch operating mode to normal operations for this `auto attendant`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Switch operating mode as per normal operations for the `auto attendant` from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Switches the current operating mode of the `Auto Attendant` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for an `auto attendant` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Auto Attendant Announcement File",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/announcements/:fileName",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Delete an announcement for a auto attendant in this location."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete an announcement for the auto attendant with this identifier."
},
{
"name": "fileName",
"value": "Greeting-2.wav",
"type": "path"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete auto attendant announcement from this organization."
}
]
},
"docs": "Delete an announcement file for the designated auto attendant.\n\nAuto Attendant announcement files contain messages and music that callers hear while waiting in the queue. A auto attendant can be configured to play whatever subset of these announcement files is desired.\n\nDeleting an announcement file for a auto attendant requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the List of Auto Attendant Announcement Files",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/autoAttendants/:autoAttendantId/announcements",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this auto attendant exists."
},
{
"name": "autoAttendantId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve announcement files for the auto attendant with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve announcement files for a auto attendant from this organization."
}
]
},
"docs": "List file info for all auto attendant announcement files associated with this auto attendant.\n\nAuto attendant announcement files contain messages and music that callers hear while waiting in the queue. A auto attendant can be configured to play whatever subset of these announcement files is desired.\n\nRetrieving this list of files requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\nNote that uploading of announcemen"
}
]
},
{
"info": {
"name": "Features: Call Park",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Call Parks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Return the list of call parks for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List call parks for this organization."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of call parks returned to this maximum count. Default is 2000."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching call parks. Default is 0."
},
{
"name": "order",
"value": "ASC",
"type": "query",
"description": "Sort the list of call parks by name, either ASC or DSC. Default is ASC."
},
{
"name": "name",
"value": "technical support",
"type": "query",
"description": "Return the list of call parks that contains the given name. The maximum length is 80."
}
]
},
"docs": "List all Call Parks for the organization.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**NOTE**: The Call Park ID will change upon modification of the Call Park name."
},
{
"info": {
"name": "Create a Call Park",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Create the call park for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the call park for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Call Parks for the given location.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nCreating a call park requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Park ID will change upon modification of the Call Park name."
},
{
"info": {
"name": "Get Details for a Call Park",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/:callParkId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Retrieve settings for a call park in this location."
},
{
"name": "callParkId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9kR1ZqYUc1cFkyRnNJSE4xY0hCdmNuUWdMU0JwYm5OMWNtRnVZMlVnTFNCamRYTjBiMjFsY2lBeA==",
"type": "path",
"description": "Retrieve settings for a call park with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call park settings from this organization."
}
]
},
"docs": "Retrieve Call Park details.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nRetrieving call park details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**NOTE**: The Call Park ID will change upon modification of the Call Park name."
},
{
"info": {
"name": "Update a Call Park",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/:callParkId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Location in which this call park exists."
},
{
"name": "callParkId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9kR1ZqYUc1cFkyRnNJSE4xY0hCdmNuUWdMU0JwYm5OMWNtRnVZMlVnTFNCamRYTjBiMjFsY2lBeA==",
"type": "path",
"description": "Update settings for a call park with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call park settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Call Park.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nUpdating a call park requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Park ID will change upon modification of the Call Park name."
},
{
"info": {
"name": "Delete a Call Park",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/:callParkId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete a call park."
},
{
"name": "callParkId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSSy9kR1ZqYUc1cFkyRnNJSE4xY0hCdmNuUWdMU0JwYm5OMWNtRnVZMlVnTFNCamRYTjBiMjFsY2lBeA==",
"type": "path",
"description": "Delete the call park with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the call park from this organization."
}
]
},
"docs": "Delete the designated Call Park.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nDeleting a call park requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Park ID will change upon modification of the Call Park name."
},
{
"info": {
"name": "Get available agents from Call Parks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/availableUsers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Return the available agents for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Return the available agents for this organization."
},
{
"name": "callParkName",
"value": "technical support - insurance - customer 1",
"type": "query",
"description": "Only return available agents from call parks with the matching name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of available agents returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching available agents."
},
{
"name": "name",
"value": "John",
"type": "query",
"description": "Only return available agents with the matching name."
},
{
"name": "phoneNumber",
"value": "+19075552859",
"type": "query",
"description": "Only return available agents with the matching primary number."
},
{
"name": "order",
"value": "lname|fname|extension",
"type": "query",
"description": "Order the available agents according to the designated fields. Up to three vertical bar (|) separated sort order fields may be specified. Available sort fields: fname, lname, number and extension. The maximum supported sort order value is 3."
}
]
},
"docs": "Retrieve available agents from call parks for a given location.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nRetrieving available agents from call parks requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get available recall hunt groups from Call Parks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/availableRecallHuntGroups",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Return the available recall hunt groups for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Return the available recall hunt groups for this organization."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of available recall hunt groups returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching available recall hunt groups."
},
{
"name": "name",
"value": "Technical Support Group",
"type": "query",
"description": "Only return available recall hunt groups with the matching name."
},
{
"name": "order",
"value": "lname",
"type": "query",
"description": "Order the available recall hunt groups according to the designated fields. Available sort fields: lname."
}
]
},
"docs": "Retrieve available recall hunt groups from call parks for a given location.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nRetrieving available recall hunt groups from call parks requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Call Park Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/settings",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Return the call park settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Return the call park settings for this organization."
}
]
},
"docs": "Retrieve Call Park Settings from call parks for a given location.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nRetrieving settings from call parks requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Call Park settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParks/settings",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location for which call park settings will be updated."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call park settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Park settings for the designated location.\n\nCall Park allows call recipients to place a call on hold so that it can be retrieved from another device.\n\nUpdating call park settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the List of Call Park Extensions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callParkExtensions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List call park extensions for this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Only return call park extensions with matching location ID."
},
{
"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": "extension",
"value": "1415",
"type": "query",
"description": "Only return call park extensions with the matching extension."
},
{
"name": "locationName",
"value": "Customer Support",
"type": "query",
"description": "Only return call park extensions with the matching extension."
},
{
"name": "name",
"value": "14159265",
"type": "query",
"description": "Only return call park extensions with the matching name."
},
{
"name": "order",
"value": "groupName|callParkExtension|callParkExtensionName|callParkExtensionExternalId",
"type": "query",
"description": "Order the available agents according to the designated fields. Available sort fields: `groupName`, `callParkExtension`, `callParkExtensionName`, `callParkExtensionExternalId`."
}
]
},
"docs": "List all Call Park Extensions for the organization.\n\nThe Call Park service, enabled for all users by default, allows a user to park a call against an available user's extension or to a Call Park Extension. Call Park Extensions are extensions defined within the Call Park service for holding parked calls.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Details for a Call Park Extension",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParkExtensions/:callParkExtensionId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Retrieve details for a call park extension in this location."
},
{
"name": "callParkExtensionId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vMGYzZTkwNGItYzliNC00ODNmLWI4MWItZmI0ZjkyMWcxNDUzCg",
"type": "path",
"description": "Retrieve details for a call park extension with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call park extension details from this organization."
}
]
},
"docs": "Retrieve Call Park Extension details.\n\nThe Call Park service, enabled for all users by default, allows a user to park a call against an available user's extension or to a Call Park Extension. Call Park Extensions are extensions defined within the Call Park service for holding parked calls.\n\nRetrieving call park extension details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Call Park Extension",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParkExtensions/:callParkExtensionId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this call park extension exists."
},
{
"name": "callParkExtensionId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNmFlNjI4ZGEtOTg5My00ODYyLWE0YTItM2VmZDIwNDJmODEy",
"type": "path",
"description": "Update a call park extension with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update a call park extension from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Call Park Extension.\n\nCall Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension. Call Park Extensions can be added as monitored lines by users' Cisco phones, so users can park and retrieve calls by pressing the associated phone line key.\n\nUpdating a call park extension requires a full administrator or location administrator auth token with a scope of `spark"
},
{
"info": {
"name": "Delete a Call Park Extension",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParkExtensions/:callParkExtensionId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete a call park extension."
},
{
"name": "callParkExtensionId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUEFSS19FWFRFTlNJT04vNmFlNjI4ZGEtOTg5My00ODYyLWE0YTItM2VmZDIwNDJmODEy",
"type": "path",
"description": "Delete the call park extension with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the call park extension from this organization."
}
]
},
"docs": "Delete the designated Call Park Extension.\n\nCall Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension. Call Park Extensions can be added as monitored lines by users' Cisco phones, so users can park and retrieve calls by pressing the associated phone line key.\n\nDeleting a call park extension requires a full administrator or location administrator auth token with a scope of `spark"
},
{
"info": {
"name": "Create a Call Park Extension",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callParkExtensions",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Create the call park extension for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the call park extension for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Call Park Extensions for the given location.\n\nCall Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension. Call Park Extensions can be added as monitored lines by users' Cisco phones, so users can park and retrieve calls by pressing the associated phone line key.\n\nCreating a call park extension requires a full administrator or location administrator auth token with a sc"
}
]
},
{
"info": {
"name": "Features: Call Pickup",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Call Pickups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Return the list of call pickups for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List call pickups for this organization."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of call pickups returned to this maximum count. Default is 2000."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching call pickups. Default is 0."
},
{
"name": "order",
"value": "ASC",
"type": "query",
"description": "Sort the list of call pickups by name, either ASC or DSC. Default is ASC."
},
{
"name": "name",
"value": "Alaska-Group",
"type": "query",
"description": "Return the list of call pickups that contains the given name. The maximum length is 80."
}
]
},
"docs": "List all Call Pickups for the organization.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
},
{
"info": {
"name": "Create a Call Pickup",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Create the call pickup for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the call pickup for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Call Pickups for the given location.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nCreating a call pickup requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
},
{
"info": {
"name": "Get Details for a Call Pickup",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/:callPickupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Retrieve settings for a call pickup in this location."
},
{
"name": "callPickupId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
"type": "path",
"description": "Retrieve settings for a call pickup with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call pickup settings from this organization."
}
]
},
"docs": "Retrieve the designated Call Pickup details.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nRetrieving call pickup details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
},
{
"info": {
"name": "Update a Call Pickup",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/:callPickupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Location in which this call pickup exists."
},
{
"name": "callPickupId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
"type": "path",
"description": "Update settings for a call pickup with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call pickup settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Call Pickup.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nUpdating a call pickup requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
},
{
"info": {
"name": "Delete a Call Pickup",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/:callPickupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete a call pickup."
},
{
"name": "callPickupId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
"type": "path",
"description": "Delete the call pickup with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the call pickup from this organization."
}
]
},
"docs": "Delete the designated Call Pickup.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nDeleting a call pickup requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Call Pickup ID will change upon modification of the Call Pickup name."
},
{
"info": {
"name": "Get available agents from Call Pickups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callPickups/availableUsers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Return the available agents for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Return the available agents for this organization."
},
{
"name": "callPickupName",
"value": "North Alaska-Pickup",
"type": "query",
"description": "Only return available agents from call pickups with the matching name."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of available agents returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching available agents."
},
{
"name": "name",
"value": "John",
"type": "query",
"description": "Only return available agents with the matching name."
},
{
"name": "phoneNumber",
"value": "9075552334",
"type": "query",
"description": "Only return available agents with the matching primary number."
},
{
"name": "order",
"value": "lname|fname|number",
"type": "query",
"description": "Order the available agents according to the designated fields. Up to three vertical bar (|) separated sort order fields may be specified. Available sort fields: `fname`, `lname`, `extension`, `number`."
}
]
},
"docs": "Retrieve available agents from call pickups for a given location.\n\nCall Pickup enables a user (agent) to answer any ringing line within their pickup group.\n\nRetrieving available agents from call pickups requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
}
]
},
{
"info": {
"name": "Features: Call Queue",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Call Queues with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/queues",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Returns the list of call queues in this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Returns the list of call queues in this location."
},
{
"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": "name",
"value": "Customer Support",
"type": "query",
"description": "Returns only the call queues matching the given name."
},
{
"name": "phoneNumber",
"value": "+15558675309",
"type": "query",
"description": "Returns only the call queues matching the given primary phone number or extension."
},
{
"name": "departmentId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSU1fR1JPVVAvZjA2ZWRiOGMtMjMxNC00ZTcxLWIzNzgtZTdiMmQwNjk3OTliOjk2YWJjMmFhLTNkY2MtMTFlNS1hMTUyLWZlMzQ4MTljZGM5YQ",
"type": "query",
"description": "Returns only call queues matching the given department ID."
},
{
"name": "departmentName",
"value": "HR",
"type": "query",
"description": "Returns only call queues matching the given department name."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues."
}
]
},
"docs": "List all Call Queues for the organization.\n\nCall queues temporarily hold calls in the cloud, when all agents\nassigned to receive calls from the queue are unavailable. Queued calls are routed to \nan available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach the users assig"
},
{
"info": {
"name": "Create a Call Queue with Customer Assist",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "The location ID where the call queue needs to be created."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization ID where the call queue needs to be created."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Creates a Customer Assist call queue, when `true`. This requires Customer Assist licensed agents."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Call Queues for the given location.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users as"
},
{
"info": {
"name": "Get Details for a Call Queue with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieves the details of a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx",
"type": "path",
"description": "Retrieves the details of call queue with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieves the details of a call queue in this organization."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Must be set to `true`, to view the details of a call queue with Customer Assist license. This can otherwise be ommited or set to `false`."
}
]
},
"docs": "Retrieve Call Queue details.\n\nCall queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable.\nQueued calls are routed to an available agent, when not on an active call. Each call queue is assigned a lead number, which is a telephone\nnumber that external callers can dial to reach the users assigned to the call queue. Call queues are also assigned an internal extension,\nwhich can be dialed internally to reach the users assigned to the call"
},
{
"info": {
"name": "Update a Call Queue",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update setting for the call queue with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Call Queue.\n\nCall queues temporarily hold calls in the cloud when all agents, which\ncan be users or agents, assigned to receive calls from the queue are\nunavailable. Queued calls are routed to an available agent when not on an\nactive call. Each call queue is assigned a Lead Number, which is a telephone\nnumber outside callers can dial to reach users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach users "
},
{
"info": {
"name": "Delete a Call Queue",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location from which to delete a call queue."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete the call queue with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the call queue from this organization."
}
]
},
"docs": "Delete the designated Call Queue.\n\nCall queues temporarily hold calls in the cloud when all agents, which\ncan be users or agents, assigned to receive calls from the queue are\nunavailable. Queued calls are routed to an available agent when not on an\nactive call. Each call queue is assigned a Lead Number, which is a telephone\nnumber outside callers can dial to reach users assigned to the call queue.\nCall queues are also assigned an internal extension, which can be dialed\ninternally to reach users "
},
{
"info": {
"name": "Read the List of Call Queue Announcement Files",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/announcements",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve anouncement files for the call queue with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve announcement files for a call queue from this organization."
}
]
},
"docs": "List file info for all Call Queue announcement files associated with this Call Queue.\n\nCall Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired.\n\nRetrieving this list of files requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\nNote that uploading of announcement files via API "
},
{
"info": {
"name": "Delete a Call Queue Announcement File",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/announcements/:fileName",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Delete an announcement for a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete an announcement for the call queue with this identifier."
},
{
"name": "fileName",
"value": "Greeting-2.wav",
"type": "path"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete call queue announcement from this organization."
}
]
},
"docs": "Delete an announcement file for the designated Call Queue.\n\nCall Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired.\n\nDeleting an announcement file for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Call Forwarding Settings for a Call Queue",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNDI0OTlmZjUtYWI1ZC00NzU4LTliMWItZjg3MTVhM2UwNmVh",
"type": "path",
"description": "Retrieve the call forwarding settings for this call queue."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue forwarding settings from this organization."
}
]
},
"docs": "Retrieve Call Forwarding settings for the specified Call Queue, including the list of call forwarding rules.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nRetrieving call forwarding settings for a call queue"
},
{
"info": {
"name": "Update Call Forwarding Settings for a Call Queue",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNDI0OTlmZjUtYWI1ZC00NzU4LTliMWItZjg3MTVhM2UwNmVh",
"type": "path",
"description": "Update call forwarding settings for this call queue."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue forwarding settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Forwarding settings for the designated Call Queue.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nUpdating call forwarding settings for a call queue requires a full administrator or location admin"
},
{
"info": {
"name": "Create a Selective Call Forwarding Rule for a Call Queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding/selectiveRules",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which the call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Create the rule for this call queue."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the call queue rule for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Selective Call Forwarding Rule for the designated Call Queue.\n\nA selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the call queue's call forwarding settings.\n\nCreating a selective call forwarding rule for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony"
},
{
"info": {
"name": "Get Selective Call Forwarding Rule for a Call Queue",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which to call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve setting for a rule for this call queue."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp",
"type": "path",
"description": "Call queue rule you are retrieving settings for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue rule settings for this organization."
}
]
},
"docs": "Retrieve a Selective Call Forwarding Rule's settings for the designated Call Queue.\n\nA selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the call queue's call forwarding settings.\n\nRetrieving a selective call forwarding rule's settings for a call queue requires a full or read-only administrator or location administrator auth token"
},
{
"info": {
"name": "Update a Selective Call Forwarding Rule for a Call Queue",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update settings for a rule for this call queue."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp",
"type": "path",
"description": "Call queue rule you are updating settings for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue rule settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a Selective Call Forwarding Rule's settings for the designated Call Queue.\n\nA selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the call queue's call forwarding settings.\n\nUpdating a selective call forwarding rule's settings for a call queue requires a full administrator or location administrator auth token with a scope of "
},
{
"info": {
"name": "Delete a Selective Call Forwarding Rule for a Call Queue",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete the rule for this call queue."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp",
"type": "path",
"description": "Call queue rule you are deleting."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete call queue rule from this organization."
}
]
},
"docs": "Delete a Selective Call Forwarding Rule for the designated Call Queue.\n\nA selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the call queue's call forwarding settings.\n\nDeleting a selective call forwarding rule for a call queue requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony"
},
{
"info": {
"name": "Get Details for a Call Queue Holiday Service",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/holidayService",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve settings for a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve settings for the call queue with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue settings from this organization."
}
]
},
"docs": "Retrieve Call Queue Holiday Service details.\n\nConfigure the call queue to route calls differently during the holidays.\n\nRetrieving call queue holiday service details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Call Queue Holiday Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/holidayService",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update setting for the call queue with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Call Queue Holiday Service.\n\nConfigure the call queue to route calls differently during the holidays.\n\nUpdating a call queue holiday service requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Call Queue Night Service",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/nightService",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve settings for a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve settings for the call queue night service with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue night service settings from this organization."
}
]
},
"docs": "Retrieve Call Queue Night service details.\n\nConfigure the call queue to route calls differently during the hours when the queue is not in service. This is\ndetermined by a schedule that defines the business hours of the queue.\n\nRetrieving call queue details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Call Queue Night Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/nightService",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Update settings for a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update settings for the call queue night service with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue night service settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Queue Night Service details.\n\nConfigure the call queue to route calls differently during the hours when the queue is not in service. This is\ndetermined by a schedule that defines the business hours of the queue.\n\nUpdating call queue night service details requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Call Queue Forced Forward",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/forcedForward",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve settings for a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve settings for the call queue with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue settings from this organization."
}
]
},
"docs": "Retrieve Call Queue policy Forced Forward details.\n\nThis policy allows calls to be temporarily diverted to a configured destination.\n\nRetrieving call queue Forced Forward details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Call Queue Forced Forward Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/forcedForward",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update setting for the call queue with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Forced Forward Service.\n\nIf the option is enabled, then incoming calls to the queue are forwarded to the configured destination. Calls that are already in the queue remain queued.\nThe policy can be configured to play an announcement prior to proceeding with the forward.\n\nUpdating a call queue Forced Forward service requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Call Queue Stranded Calls",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/strandedCalls",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve settings for a call queue in this location."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve settings for the call queue with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue settings from this organization."
}
]
},
"docs": "Allow admin to view default/configured Stranded Calls settings.\n\nStranded-All agents logoff Policy: If the last agent staffing a queue “unjoins” the queue or signs out, then all calls in the queue become stranded.\nStranded-Unavailable Policy: This policy allows for the configuration of the processing of calls that are in a staffed queue when all agents are unavailable.\n\nRetrieving call queue Stranded Calls details requires a full or read-only administrator or location administrator auth token wi"
},
{
"info": {
"name": "Update a Call Queue Stranded Calls Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/strandedCalls",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this call queue exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update setting for the call queue with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update call queue settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Call Stranded Calls Service.\n\nAllow admin to modify configured Stranded Calls settings.\n\nUpdating a call queue stranded calls requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Call Queue Primary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/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 call queue'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 token wi"
},
{
"info": {
"name": "Get Call Queue Alternate Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/alternate/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 call queue's alternate 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 token "
},
{
"info": {
"name": "Get Call Queue Call Forward Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/callForwarding/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."
},
{
"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 the call queue's call forward number.\nThese numbers are associated with the location 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 or location administra"
},
{
"info": {
"name": "Get Call Queue Available Agents",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/queues/agents/availableAgents",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "The location ID of the call queue. Temporary mandatory query parameter, used for performance reasons only and not a filter."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List available agents for this organization."
},
{
"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": "name",
"value": "Customer Support",
"type": "query",
"description": "Search based on name (user first and last name combination)."
},
{
"name": "phoneNumber",
"value": "+15558675309",
"type": "query",
"description": "Search based on number or extension."
},
{
"name": "order",
"value": "lname-asc,fname-desc,extension",
"type": "query",
"description": "Order the available agents according to the designated fields. Up to three comma-separated sort order fields may be specified. Available sort fields are: `userId`, `fname`, `firstname`, `lname`, `lastname`, `dn`, and `extension`. Sort order can be added together with each field using a hyphen, `-`. Available sort orders are: `asc`, and `desc`."
}
]
},
"docs": "List all available users, workspaces, or virtual lines that can be assigned as call queue agents.\n\nAvailable agents are users (excluding users with Webex Calling Standard license), workspaces, or virtual lines that can be assigned to a call queue. \nCalls from the call queue are routed to assigned agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving this list requires a full, read-only or location administrator auth tok"
},
{
"info": {
"name": "Get List of Supervisors with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/supervisors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List the supervisors in this organization."
},
{
"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": "name",
"value": "John",
"type": "query",
"description": "Only return the supervisors that match the given name."
},
{
"name": "phoneNumber",
"value": "+19845550186",
"type": "query",
"description": "Only return the supervisors that match the given phone number, extension, or ESN."
},
{
"name": "order",
"value": "firstName|lastName|firstName-desc|lastName-desc",
"type": "query",
"description": "Sort results alphabetically by supervisor name, in ascending or descending order."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Returns only the list of supervisors with Customer Assist license, when `true`. Otherwise returns the list of supervisors with Customer Experience Basic license."
}
]
},
"docs": "Get list of supervisors for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nRequires a full, location, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Supervisor with Customer Assist",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/supervisors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization ID where the supervisor needs to be created."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Creates a Customer Assist queue supervisor, when `true`. Customer Assist queue supervisors must have a Customer Assist license."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new supervisor. The supervisor must be created with at least one agent.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete Bulk Supervisors",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/supervisors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete supervisors in bulk for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes supervisors in bulk from an organization.\n\nSupervisors are users who manage agents and who perform functions including monitoring, coaching, and more.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Supervisor Detail with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/supervisors/:supervisorId",
"params": [
{
"name": "supervisorId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU",
"type": "path",
"description": "List the agents assigned to this supervisor."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List the agents assigned to a supervisor in this organization."
},
{
"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": "name",
"value": "John",
"type": "query",
"description": "Only return the agents that match the given name."
},
{
"name": "phoneNumber",
"value": "+19845550186",
"type": "query",
"description": "Only return agents that match the given phone number, extension, or ESN."
},
{
"name": "order",
"value": "firstName\\lastName\\firstName-desc\\lastName-desc",
"type": "query",
"description": "Sort results alphabetically by supervisor name, in ascending or descending order."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Must be set to `true`, to view the details of a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`."
}
]
},
"docs": "Get details of a specific supervisor, which includes the agents associated agents with the supervisor, in an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Assign or Unassign Agents to Supervisor with Customer Assist",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/supervisors/:supervisorId",
"params": [
{
"name": "supervisorId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU",
"type": "path",
"description": "Identifier of the supervisor to be updated."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Assign or unassign agents to a supervisor in this organization."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Must be set to `true` to modify a supervisor with Customer Assist license. This can otherwise be ommited or set to `false`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign or unassign agents to the supervisor for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Supervisor",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/supervisors/:supervisorId",
"params": [
{
"name": "supervisorId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU",
"type": "path",
"description": "Delete the specified supervisor."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the supervisor in the specified organization."
}
]
},
"docs": "Deletes the supervisor from an organization.\n\nSupervisors are users who manage agents and who perform functions including monitoring, coaching, and more.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Available Supervisors with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/supervisors/availableSupervisors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List the available supervisors in this organization."
},
{
"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": "name",
"value": "Adam",
"type": "query",
"description": "Only return the supervisors that match the given name."
},
{
"name": "phoneNumber",
"value": "+19845550186",
"type": "query",
"description": "Only return the supervisors that match the given phone number, extension, or ESN."
},
{
"name": "order",
"value": "firstName|lastName|firstName-desc|lastName-desc",
"type": "query",
"description": "Sort results alphabetically by supervisor name, in ascending or descending order."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Returns only the list of available supervisors with Customer Assist license, when `true`. When ommited or set to 'false', will return the list of available supervisors with Customer Experience Basic license."
}
]
},
"docs": "Get list of available supervisors for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "List Available Agents with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/supervisors/availableAgents",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List of available agents in a supervisor's list for this organization."
},
{
"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": "name",
"value": "Adam",
"type": "query",
"description": "Returns only the agents that match the given name."
},
{
"name": "phoneNumber",
"value": "+19845550186",
"type": "query",
"description": "Returns only the agents that match the phone number, extension, or ESN."
},
{
"name": "order",
"value": "firstName|lastName|firstName-desc|lastName-desc",
"type": "query",
"description": "Sort results alphabetically by supervisor name, in ascending or descending order."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Returns only the list of available agents with Customer Assist license, when `true`. When ommited or set to `false`, will return the list of available agents with Customer Experience Basic license."
}
]
},
"docs": "Get list of available agents for an organization.\n\nAgents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.\n\nThis operation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Read the List of Call Queue Agents with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/queues/agents",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List call queues agents in this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Return only the call queue agents in this location."
},
{
"name": "queueId",
"value": "``",
"type": "query",
"description": "Only return call queue agents with the matching queue ID."
},
{
"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": "name",
"value": "Customer Support",
"type": "query",
"description": "Returns only the list of call queue agents that match the given name."
},
{
"name": "phoneNumber",
"value": "+15558675309",
"type": "query",
"description": "Returns only the list of call queue agents that match the given phone number or extension."
},
{
"name": "joinEnabled",
"value": "true",
"type": "query",
"description": "Returns only the list of call queue agents that match the given `joinEnabled` value."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Returns only the list of call queues with Customer Assist license when `true`, otherwise returns the list of Customer Experience Basic call queues."
},
{
"name": "order",
"value": "firstName|lastName|firstName-desc|lastName-desc",
"type": "query",
"description": "Sort results alphabetically by call queue agent's name, in ascending or descending order."
}
]
},
"docs": "List all Call Queues Agents for the organization.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The decoded value of the agent's `id`, and the `type` returned in the respon"
},
{
"info": {
"name": "Get Details for a Call Queue Agent with Customer Assist",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/queues/agents/:id",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNTU1MzY4Y2QtZDg5Mi00YzFlLTk0YjYtNzdjNjRiYWQ3NWMx",
"type": "path",
"description": "Retrieve call queue agents with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call queue agents from this organization."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Must be set to `true` to view the details of an agent with Customer Assist license. This can otherwise be ommited or set to `false`."
},
{
"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."
}
]
},
"docs": "Retrieve details of a particular Call queue agent based on the agent ID.\n\nAgents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nRetrieving a call queue agent's details require a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`.\n\n**Note**: The agent's `type` returned in the "
},
{
"info": {
"name": "Update an Agent's Settings of One or More Call Queues with Customer Assist",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/queues/agents/:id/settings",
"params": [
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9lNWI2NjIyMi1jZTE2LTQ0ZTAtOGY1MS05NzU2ZGE0MDhiZWU",
"type": "path",
"description": "Identifier of the agent to be updated."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the settings of an agent in this organization."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Must be set to `true` to modify an agent that has Customer Assist license. This can otherwise be ommited or set to `false`."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify an agent's call queue settings for an organization.\n\nCalls from the call queue are routed to agents based on configuration. \nAn agent can be assigned to one or more call queues and can be managed by supervisors.\n\nThis operation requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Switch Mode for Call Forwarding Settings for a Call Queue",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/callForwarding/actions/switchMode/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "`Location` in which this `call queue` exists."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvNDI0OTlmZjUtYWI1ZC00NzU4LTliMWItZjg3MTVhM2UwNmVh",
"type": "path",
"description": "Switch operating mode to normal operations for this `call queue`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Switch operating mode as per normal operations for the `call queue` from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Switches the current operating mode of the `Call Queue` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for a `call queue` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Features: Call Recording",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Call Recording Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRecording",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU",
"type": "query",
"description": "Retrieve call recording settings from this organization."
}
]
},
"docs": "Retrieve call recording settings for the organization.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nRetrieving call recording settings requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Call Recording Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/callRecording",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU",
"type": "query",
"description": "Retrieve call recording settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update call recording settings for the organization.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nUpdating call recording settings requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: This API is for Cisco partners only."
},
{
"info": {
"name": "Get Call Recording Terms Of Service Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRecording/vendors/:vendorId/termsOfService",
"params": [
{
"name": "vendorId",
"value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw",
"type": "path",
"description": "Retrieve call recording terms of service details for the given vendor."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU",
"type": "query",
"description": "Retrieve call recording terms of service details from this organization."
}
]
},
"docs": "Retrieve call recording terms of service settings for the organization.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nRetrieving call recording terms of service settings requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Call Recording Terms Of Service Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/callRecording/vendors/:vendorId/termsOfService",
"params": [
{
"name": "vendorId",
"value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvNTNkYzRjODctODQwOC00ODgyLTk1NzAtZGNhMmJjZGI5Mjgw",
"type": "path",
"description": "Update call recording terms of service settings for the given vendor."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU",
"type": "query",
"description": "Update call recording terms of service settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update call recording terms of service settings for the given vendor.\n\nThe Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.\n\nUpdating call recording terms of service settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get details for the organization Compliance Announcement Setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRecording/complianceAnnouncement",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve compliance announcement setting from this organization."
}
]
},
"docs": "Retrieve the organization compliance announcement settings.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nRetrieving organization compliance announcement setting requires a full or read-only administrator auth token with "
},
{
"info": {
"name": "Update the organization Compliance Announcement",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/callRecording/complianceAnnouncement",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the compliance announcement setting from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the organization compliance announcement.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nUpdating the organization compliance announcement requires a full administrator auth token with a scope of `spark-admin:teleph"
},
{
"info": {
"name": "Get details for the Location Compliance Announcement Setting",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/complianceAnnouncement",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Retrieve compliance announcement settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve compliance announcement setting from this organization."
}
]
},
"docs": "Retrieve the location compliance announcement settings.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nRetrieving location compliance announcement setting requires a full or read-only administrator auth token with a scope "
},
{
"info": {
"name": "Update the Location Compliance Announcement",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/complianceAnnouncement",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Update the compliance announcement settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the compliance announcement setting from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the location compliance announcement.\n\nThe Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement. When the compliance announcement is played to the PSTN party, and the PSTN party is connected to a party with call recording enabled, then the start/stop announcement is inhibited.\n\nUpdating the location compliance announcement requires a full administrator auth token with a scope of `spark-admin:telephony_conf"
},
{
"info": {
"name": "Get Call Recording Regions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRecording/regions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call recording regions for this organization."
}
]
},
"docs": "Retrieve all the call recording regions that are available for an organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Call Recording Vendor Users",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRecording/vendorUsers",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve call recording vendor users for this organization."
},
{
"name": "max",
"value": "10",
"type": "query",
"description": "Limit the number of vendor users 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 objects. The default is 0."
},
{
"name": "standardUserOnly",
"value": "true",
"type": "query",
"description": "If true, results only include Webex Calling standard users."
}
]
},
"docs": "Retrieve call recording vendor users of an organization. This API is used to get the list of users who are assigned to the default call-recording vendor of the organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administ"
},
{
"info": {
"name": "Set Call Recording Vendor for a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/vendor",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj",
"type": "path",
"description": "Update the call recording vendor for this location"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the call recording vendor for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign a call recording vendor to a location of an organization. Response will be `204` if the changes can be applied immediatley otherwise `200` with a job ID is returned.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administr"
},
{
"info": {
"name": "Get Location Call Recording Vendors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/vendors",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj",
"type": "path",
"description": "Retrieve vendor details for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve vendor details for this organization."
}
]
},
"docs": "Retrieve details of the call recording vendor that the location is assigned and also a list of vendors.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Call Recording Vendor Users for a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/callRecording/vendorUsers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL1JFQ09SRElOR19WRU5ET1IvMGE0MjY3NTQtYTQ3MC00YzJkLThiYTAtZmJjNjc3M2E4YTdj",
"type": "path",
"description": "Retrieve vendor users for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve vendor users for this organization."
},
{
"name": "max",
"value": "10",
"type": "query",
"description": "Limit the number of vendor users 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 objects. The default is 0."
},
{
"name": "standardUserOnly",
"value": "true",
"type": "query",
"description": "If true, results only include Webex Calling standard users."
}
]
},
"docs": "Retrieve call recording vendor users of a location. This API is used to get the list of users assigned to the call recording vendor of the location.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a s"
},
{
"info": {
"name": "List Call Recording Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/callRecording",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List call recording jobs in this organization."
},
{
"name": "max",
"value": "10",
"type": "query",
"description": "Limit the number of jobs returned to this maximum count. The default is 50."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects. The default is 0."
}
]
},
"docs": "Get the list of all call recording jobs in an organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get the Job Status of a Call Recording Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/callRecording/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job status for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve job status in this organization."
}
]
},
"docs": "Get the details of a call recording job by its job ID.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Job Errors for a Call Recording Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/callRecording/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job errors for this job."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve job errors for a call recording job in this organization."
},
{
"name": "max",
"value": "10",
"type": "query",
"description": "Limit the number of errors returned to this maximum count. The default is 50."
}
]
},
"docs": "Get errors for a call recording job in an organization.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Organization Call Recording Vendors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/callRecording/vendors",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU",
"type": "query",
"description": "Retrieve call recording settings from this organization."
}
]
},
"docs": "Returns what the current vendor is as well as a list of all the available vendors.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Set Organization Call Recording Vendor",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/callRecording/vendor",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9lNTEzMTg1Zi01YTJmLTQ0OTUtYjM1Yi03MDY3YmY3Y2U0OGU",
"type": "query",
"description": "Modify call recording settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns a Job ID that you can use to get the status of the job.\n\nThe Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings. An organization is configured with an overall provider, but locations can be configured to use a different vendor than the overall organization default.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`, `spark-admin:telephony_config_read`, and `spark-admi"
}
]
},
{
"info": {
"name": "Features: Customer Assist",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Wrap Up Reasons",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons"
},
"docs": "Return the list of wrap-up reasons configured for a customer.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues. Upon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue. Admins can also configure a timer, which dictates the time agents have to sele"
},
{
"info": {
"name": "Create Wrap Up Reason",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default"
},
{
"info": {
"name": "Read Wrap Up Reason",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId",
"params": [
{
"name": "wrapupReasonId",
"value": "Y2lzY29zcGFyazovL3VzL1dSQVBVUF9SRUFTT05fSUQvOGVmNzM4OTctMmQzNS00ZjgwLWJkOGQtYzRjNmRhNWNlZjA2",
"type": "path",
"description": "Wrap-up reason ID."
}
]
},
"docs": "Return the wrap-up reason by ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a"
},
{
"info": {
"name": "Update Wrap Up Reason",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId",
"params": [
{
"name": "wrapupReasonId",
"value": "Y2lzY29zcGFyazovL3VzL1dSQVBVUF9SRUFTT05fSUQvOGVmNzM4OTctMmQzNS00ZjgwLWJkOGQtYzRjNmRhNWNlZjA2",
"type": "path",
"description": "Wrap-up reason ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default"
},
{
"info": {
"name": "Delete Wrap Up Reason",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId",
"params": [
{
"name": "wrapupReasonId",
"value": "Y2lzY29zcGFyazovL3VzL1dSQVBVUF9SRUFTT05fSUQvOGVmNzM4OTctMmQzNS00ZjgwLWJkOGQtYzRjNmRhNWNlZjA2",
"type": "path",
"description": "Wrap-up reason ID."
}
]
},
"docs": "Delete a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with a default"
},
{
"info": {
"name": "Validate Wrap Up Reason",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/actions/validateName/invoke",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate the wrap-up reason name.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason post-call, with "
},
{
"info": {
"name": "Read Available Queues",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/cxEssentials/wrapup/reasons/:wrapupReasonId/availableQueues",
"params": [
{
"name": "wrapupReasonId",
"value": "Y2lzY29zcGFyazovL3VzL1dSQVBVUF9SRUFTT05fSUQvOGVmNzM4OTctMmQzNS00ZjgwLWJkOGQtYzRjNmRhNWNlZjA2",
"type": "path",
"description": "Wrap-up reason ID."
}
]
},
"docs": "Return the available queues for a wrap-up reason.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reason "
},
{
"info": {
"name": "Read Wrap Up Reason Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2ZkZDA1MzYyLTdlZjctNDYzYS1hMjg5LTY5NzgxMzc5Y2NhNg==",
"type": "path",
"description": "The location ID."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvOGY1MDI2ZjMtMDZjYi00OTU3LWE0MDQtNDYyM2UzYjJjYzVi",
"type": "path",
"description": "The queue ID."
}
]
},
"docs": "Return a wrap-up reason by location ID and queue ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reas"
},
{
"info": {
"name": "Update Wrap Up Reason Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/cxEssentials/locations/:locationId/queues/:queueId/wrapup/settings",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2ZkZDA1MzYyLTdlZjctNDYzYS1hMjg5LTY5NzgxMzc5Y2NhNg==",
"type": "path",
"description": "The location ID."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvOGY1MDI2ZjMtMDZjYi00OTU3LWE0MDQtNDYyM2UzYjJjYzVi",
"type": "path",
"description": "The queue ID."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a wrap-up reason by location ID and queue ID.\n\nAgents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.\nUpon call completion, agents select a wrap-up reason from the queue's assigned list. Each wrap-up reason includes a name and description, and can be set as the default for a queue.\nAdmins can also configure a timer, which dictates the time agents have to select a reas"
},
{
"info": {
"name": "Read Screen Pop Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
"type": "path",
"description": "The location ID where the call queue resides."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "The call queue ID for which screen pop configuration is modified."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization ID of the customer or partner's organization."
}
]
},
"docs": "Returns the screen pop configuration for a call queue in a location.\n\nScreen pop lets agents view customer-related info in a pop-up window.\n\nRetrieving the screen pop configuration requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Screen Pop Configuration",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/queues/:queueId/cxEssentials/screenPop",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA",
"type": "path",
"description": "The location ID where the call queue resides."
},
{
"name": "queueId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "The call queue ID for which screen pop configuration is modified."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization ID of the customer or partner's organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modifies the screen pop configuration for a call queue in a location.\n\nScreen pop lets agents view customer-related info in a pop-up window.\n\nModifying the screen pop configuration requires a full or device administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Available Agents",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/cxEssentials/agents/availableAgents",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve the list of avaiilable agents in this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "The organization ID of the customer or partner's organization."
},
{
"name": "hasCxEssentials",
"value": "true",
"type": "query",
"description": "Returns only the list of available agents with Customer Assist license when `true`, otherwise returns the list of available agents with Customer Experience Basic license."
}
]
},
"docs": "Return a list of available agents with Customer Assist license in a location.\n\nRetrieving the list of available agents requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
}
]
},
{
"info": {
"name": "Features: Hot Desking Sign-in via Voice Portal",
"type": "folder"
},
"items": [
{
"info": {
"name": "Voice Portal Hot desking sign in details for a location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/features/hotDesking",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzM2ZTFlM2Y1LWJhODEtNDRiNC05ZGQ1LWIyMmVlNGY1MDIyZA",
"type": "path",
"description": "Location in which the hot desking sign in resides."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization. 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": "Get the Hot desking sign in details for a location.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Voice Portal Hot desking sign in details for a location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/features/hotDesking",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzM2ZTFlM2Y1LWJhODEtNDRiNC05ZGQ1LWIyMmVlNGY1MDIyZA",
"type": "path",
"description": "Location in which the hot desking sign in resides."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization. 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": "Update the Hot desking sign in details for a location.\n\nThis requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Voice Portal Hot desking sign in details for a user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/features/hotDesking/guest",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "ID of the person associated with the hot desking details."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization. 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": "Get the Hot desking sign in details for a user.\n\nThis requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Voice Portal Hot desking sign in details for a user",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/features/hotDesking/guest",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi8wMDAwNWUwMC01M2I0LTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
"type": "path",
"description": "ID of the person associated with the hot desking details."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization. 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": "Update the Hot desking sign in details for a user.\n\nThis requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Features: Hunt Group",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Hunt Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/huntGroups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List hunt groups for this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Only return hunt groups with matching location ID."
},
{
"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": "name",
"value": "Customer Support",
"type": "query",
"description": "Only return hunt groups with the matching name."
},
{
"name": "phoneNumber",
"value": "+15558675309",
"type": "query",
"description": "Only return hunt groups with the matching primary phone number or extension."
}
]
},
"docs": "List all calling Hunt Groups for the organization.\n\nHunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Hunt Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Create the hunt group for the given location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the hunt group for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Hunt Groups for the given location.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nCreating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Hunt Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Retrieve settings for a hunt group in this location."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve settings for the hunt group with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve hunt group settings from this organization."
}
]
},
"docs": "Retrieve Hunt Group details.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nRetrieving hunt group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Hunt Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Update the hunt group for this location."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update settings for the hunt group with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update hunt group settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Hunt Group.\n\nHunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.\n\nUpdating a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Hunt Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location from which to delete a hunt group."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete the hunt group with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the hunt group from this organization."
}
]
},
"docs": "Delete the designated Hunt Group.\n\nHunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.\n\nDeleting a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Call Forwarding Settings for a Hunt Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this hunt group exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOTgxYTIy",
"type": "path",
"description": "Read the call forwarding settings for this hunt group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve hunt group forwarding settings from this organization."
}
]
},
"docs": "Retrieve Call Forwarding settings for the specified Hunt Group including the list of call forwarding rules.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nRetrieving call forwarding settings for a hunt group "
},
{
"info": {
"name": "Update Call Forwarding Settings for a Hunt Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location from which this hunt group exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOTgxYTIy",
"type": "path",
"description": "Update call forwarding settings for this hunt group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update hunt group forwarding settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Call Forwarding settings for the specified Hunt Group.\n\nThe call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.\nBelow are the available options for configuring your call forwarding:\n1. Always forward calls to a designated number.\n2. Forward calls to a designated number based on certain criteria.\n3. Forward calls using different modes.\n\nUpdating call forwarding settings for a hunt group requires a full administrator or location admini"
},
{
"info": {
"name": "Create a Selective Call Forwarding Rule for a Hunt Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding/selectiveRules",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this hunt group exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Create the rule for this hunt group."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the hunt group rule for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a Selective Call Forwarding Rule for the designated Hunt Group.\n\nA selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the hunt group's call forwarding settings.\n\nCreating a selective call forwarding rule for a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony"
},
{
"info": {
"name": "Get Selective Call Forwarding Rule for a Hunt Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this hunt group exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Retrieve settings for a rule for this hunt group."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp",
"type": "path",
"description": "Hunt group rule you are retrieving settings for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve hunt group rule settings for this organization."
}
]
},
"docs": "Retrieve a Selective Call Forwarding Rule's settings for the designated Hunt Group.\n\nA selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the hunt group's call forwarding settings.\n\nRetrieving a selective call forwarding rule's settings for a hunt group requires a full or read-only administrator or location administrator auth token"
},
{
"info": {
"name": "Update a Selective Call Forwarding Rule for a Hunt Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this hunt group exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Update settings for a rule for this hunt group."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp",
"type": "path",
"description": "Hunt group rule you are updating settings for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update hunt group rule settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a Selective Call Forwarding Rule's settings for the designated Hunt Group.\n\nA selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the hunt group's call forwarding settings.\n\nUpdating a selective call forwarding rule's settings for a hunt group requires a full administrator or location administrator auth token with a scope of "
},
{
"info": {
"name": "Delete a Selective Call Forwarding Rule for a Hunt Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding/selectiveRules/:ruleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location in which this hunt group exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete the rule for this hunt group."
},
{
"name": "ruleId",
"value": "Y2lzY29zcGFyazovL3VzL0NBTExfRk9SV0FSRElOR19TRUxFQ1RJVkVfUlVMRS9RbTlp",
"type": "path",
"description": "Hunt group rule you are deleting."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete hunt group rule from this organization."
}
]
},
"docs": "Delete a Selective Call Forwarding Rule for the designated Hunt Group.\n\nA selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.\n\nNote that the list of existing call forward rules is available in the hunt group's call forwarding settings.\n\nDeleting a selective call forwarding rule for a hunt group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony"
},
{
"info": {
"name": "Get Hunt Group Primary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/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 hunt group'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 token wi"
},
{
"info": {
"name": "Get Hunt Group Alternate Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/alternate/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 hunt group's alternate 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 token "
},
{
"info": {
"name": "Get Hunt Group Call Forward Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/callForwarding/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."
},
{
"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 the hunt group's call forward number.\nThese numbers are associated with the location 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 or location administra"
},
{
"info": {
"name": "Switch Mode for Call Forwarding Settings for a Hunt Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/huntGroups/:huntGroupId/callForwarding/actions/switchMode/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "`Location` in which this `hunt group` exists."
},
{
"name": "huntGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvMzk1ODc4ZGEtZmZmZS00YTI2LWJlOTctMjdhZmZmOTgxYTIy",
"type": "path",
"description": "Switch operating mode to normal operations for this `hunt group`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Switch operating mode as per normal operations for the `hunt group` from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Switches the current operating mode of the `Hunt Group` to the mode as per normal operations.\n\nOperating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.\n\nSwitching operating mode for a `hunt group` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Features: Operating Modes",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Operating Modes",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/operatingModes",
"params": [
{
"name": "name",
"value": "Day",
"type": "query",
"description": "List `operating modes` whose name contains this string."
},
{
"name": "limitToLocationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "query",
"description": "Location query parameter to filter the `operating modes` from that location only."
},
{
"name": "limitToOrgLevelEnabled",
"value": "true",
"type": "query",
"description": "If true, only return `operating modes` defined at the organization level."
},
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of `operating modes` to return in a single page. `max` must be equal to, or greater than `1`, and equal to or less than `100`."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc",
"type": "query",
"description": "Sort the list of `operating modes` based on `name`, either asc, or desc."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve `operating modes` list from this organization."
}
]
},
"docs": "Retrieve `Operating Modes` list defined at location, or organization level. Use query parameters to filter the result set by location or level. The list returned is sorted in ascending order by operating mode name. Long result sets are split into [pages](/docs/basics#pagination).\n\n`Operating modes` help manage calls more efficiently by routing them based on predefined settings.\n\nRetrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:tel"
},
{
"info": {
"name": "Get Details for an Operating Mode",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Get the `operating mode` with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get the `operating mode` from this organization."
}
]
},
"docs": "Retrieve an `Operating Mode` by `Operating Mode ID`.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.\n\nRetrieving an `operating mode` requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify an Operating Mode",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Modify the `operating mode` with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify the `operating mode` from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the designated `Operating Mode's` configuration.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.\n\nModifying an `Operating Mode` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete an Operating Mode",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Delete the `operating mode` with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the `operating mode` from this organization."
}
]
},
"docs": "Delete the designated `Operating Mode`.\n\nDeleting an `Operating Mode` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create an Operating Mode",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/operatingModes/",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the `operating mode` for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create an `Operating Mode` at an organization, or a location level.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.\n\nCreating an `Operating Mode` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get details for an Operating Mode Holiday",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays/:holidayId",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Get the holiday from this `operating mode` matching ID."
},
{
"name": "holidayId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ",
"type": "path",
"description": "Get the `operating mode Holiday` with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get the `operating mode` from this organization."
}
]
},
"docs": "Retrieve an `Operating Mode Holiday` by ID.\n\nHolidays define a recurring schedule for the `Operating Modes`.\n\nRetrieving an `Operating Mode Holiday` requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify an Operating Mode Holiday",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays/:holidayId",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Modify the holiday from this `operating mode` matching ID."
},
{
"name": "holidayId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ",
"type": "path",
"description": "Modify the `Holiday` with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify the `operating mode` from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify the designated `Operating Mode Holiday's` configuration.\n\nModifying an `Operating Mode Holiday` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete an Operating Mode Holiday",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays/:holidayId",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Delete the holiday from this `operating mode` matching ID."
},
{
"name": "holidayId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTIwOQ",
"type": "path",
"description": "Delete the holiday with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the `operating mode` from this organization."
}
]
},
"docs": "Delete the designated `Operating Mode Holiday`.\n\nDeleting an `Operating Mode Holiday` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create an Operating Mode Holiday",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/operatingModes/:modeId/holidays",
"params": [
{
"name": "modeId",
"value": "Y2lzY29zcGFyazovL3VzL09QRVJBVElOR19NT0RFL2JiOTc1OTcxLTBjZWYtNDdhNi05Yzc5LTliZWFjY2IwYjg4Mg",
"type": "path",
"description": "Create the holiday for this `operating mode`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the `operating mode holiday` for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a holiday schedule event for the designated `Operating Mode`.\n\nHolidays define a recurring schedule for the `Operating Modes`. An `Operating Mode` can have a max of 150 holidays.\n\nCreating an `Operating Mode Holiday` requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve the List of Available Operating Modes in a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/operatingModes/availableOperatingModes",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "path",
"description": "Retrieve `operating modes` list from this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve `operating modes` list from this organization."
}
]
},
"docs": "Retrieve list of `Operating Modes` which are available to be assigned to a location level feature (`Auto Attendant`, `Call Queue`, or `Hunt Group`). Since each location and an org can have a max of 100 `Operating Modes` defined. The max number of `operating modes` that can be returned is 200.\n\n`Operating modes` can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc. for the `Auto Attendant`, `Call Queue`, and `Hunt Group` features.\n\nRetri"
},
{
"info": {
"name": "Get Operating Mode Call Forward Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/operatingModes/callForwarding/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."
},
{
"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 operating mode's call forward number.\n\nThese numbers are associated with the location 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 or location adminis"
}
]
},
{
"info": {
"name": "Features: Paging Group",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Paging Groups",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/paging",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List paging groups for this organization."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count. Default is 2000"
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects. Default is 0"
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Return only paging groups with matching location ID. Default is all locations"
},
{
"name": "name",
"value": "PagingGroup",
"type": "query",
"description": "Return only paging groups with the matching name."
},
{
"name": "phoneNumber",
"value": "+15558675309",
"type": "query",
"description": "Return only paging groups with matching primary phone number or extension."
}
]
},
"docs": "List all Paging Groups for the organization.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a new Paging Group",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/paging",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Create the paging group for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the paging group for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Paging Group for the given location.\n\nGroup Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nCreating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Paging Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/:pagingId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Retrieve settings for a paging group in this location."
},
{
"name": "pagingId",
"value": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
"type": "path",
"description": "Retrieve settings for the paging group with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve paging group settings from this organization."
}
]
},
"docs": "Retrieve Paging Group details.\n\nGroup Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nRetrieving paging group details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Paging Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/:pagingId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg",
"type": "path",
"description": "Update settings for a paging group in this location."
},
{
"name": "pagingId",
"value": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
"type": "path",
"description": "Update settings for the paging group with this identifier."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update paging group settings from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nUpdating a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Paging Group",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/:pagingId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete a paging group."
},
{
"name": "pagingId",
"value": "Y2lzY29zcGFyazovL3VzL1BBR0lOR19HUk9VUC9hSFpoWlROMk1HOHliMEEyTkRrME1USTVOeTVwYm5ReE1DNWlZMnhrTG5kbFltVjRMbU52YlE",
"type": "path",
"description": "Delete the paging group with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the paging group from this organization."
}
]
},
"docs": "Delete the designated Paging Group.\n\nGroup Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by\ndialing a number or extension assigned to a specific paging group. The Group Paging service makes a simultaneous call to all the assigned targets.\n\nDeleting a paging group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Paging Group Primary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/paging/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 paging group'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 token "
}
]
},
{
"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`."
}
]
},
{
"info": {
"name": "Features: Virtual Extensions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Virtual Extensions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualExtensions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
},
{
"name": "max",
"value": "10",
"type": "query",
"description": "Limit the number of virtual extensions returned to this maximum count. Default is 10."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching virtual extensions. Default is 0."
},
{
"name": "order",
"value": "ASC",
"type": "query",
"description": "Order the list of virtual extensions in ascending or descending order. Default is ascending."
},
{
"name": "extension",
"value": "5001",
"type": "query",
"description": "Filter the list of virtual extensions by extension number."
},
{
"name": "phoneNumber",
"value": "+17011558169",
"type": "query",
"description": "Filter the list of virtual extensions by phone number."
},
{
"name": "name",
"value": "John",
"type": "query",
"description": "Filter the list of virtual extensions by name. This can be either first name or last name."
},
{
"name": "locationName",
"value": "Test1",
"type": "query",
"description": "Filter the list of virtual extensions by location name.(Only one of the locationName, locationId, and OrgLevelOnly query parameters is allowed at the same time.)"
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "query",
"description": "Filter the list of virtual extensions by location ID."
},
{
"name": "orgLevelOnly",
"value": "true",
"type": "query",
"description": "Filter the list of virtual extensions by organization level. If orgLevelOnly is true, return only the organization level virtual extensions."
}
]
},
"docs": "Retrieve virtual extensions associated with a specific customer.\n\nThe GET Virtual Extensions API allows administrators to retrieve a list of virtual extensions configured within their organization. Virtual extensions enable users to dial extension numbers that route to external phone numbers, such as those of remote workers or frequently contacted clients.\nThis API returns key information including the extension, associated phone number (in E.164 format), display name, and the location to whic"
},
{
"info": {
"name": "Create a Virtual Extension",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/virtualExtensions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Virtual Extension for the given organization or location.\n\nYou can set up virtual extensions at the organization or location level. The organization level enables everyone across your organization to dial the same extension number to reach someone.\nYou can use the location level virtual extension like any other extension assigned to the specific location.\nUsers at the specific location can dial the extension. However, users at other locations can reach the virtual extension by dialing"
},
{
"info": {
"name": "Get a Virtual Extension",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualExtensions/:extensionId",
"params": [
{
"name": "extensionId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA",
"type": "path",
"description": "ID of the virtual extension."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieve Virtual Extension details for the given extension ID.\n\nVirtual extensions integrate remote workers on separate telephony systems into Webex Calling, enabling users to reach them via extension dialing.\nThis endpoint allows administrators to retrieve configuration details for a specific virtual extension, ensuring visibility into the mapping between extensions and external phone numbers.\n\nRetrieving a Virtual Extension requires a full or read-only administrator auth token with a scope of "
},
{
"info": {
"name": "Update a Virtual Extension",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/virtualExtensions/:extensionId",
"params": [
{
"name": "extensionId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA",
"type": "path",
"description": "ID of the virtual extension."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Virtual Extension details for the given extension ID.\n\nThis API updates the configuration of an existing virtual extension identified by its unique extension ID. Administrators can modify fields such as the extension, associated phone number (in E.164 format), display name, and location etc.\n\nUpdating a Virtual Extension requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`."
},
{
"info": {
"name": "Delete a Virtual Extension",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/virtualExtensions/:extensionId",
"params": [
{
"name": "extensionId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA",
"type": "path",
"description": "ID of the virtual extension."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Delete Virtual Extension using the extension ID.\n\nThis API permanently deletes a virtual extension from the organization. Once deleted, the extension will no longer route calls to the external phone number, and users won’t be able to reach it via the assigned extension.\n\nDeleting a Virtual Extension requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write` and `identity:contacts_rw`."
},
{
"info": {
"name": "Get Virtual extension settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualExtensions/settings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieve Virtual Extension settings for the given Org.\n\nThis API retrieves the virtual extension mode settings configured for a given organization. Virtual extensions can operate in two modes: STANDARD and ENHANCED. The selected mode determines how the system handles routing and signaling for virtual extensions.\nBy default, the virtual extensions that you create use the Standard mode. Another mode, enhanced signaling mode, is available to all customers, however, virtual extensions won't function"
},
{
"info": {
"name": "Modify Virtual Extension Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/virtualExtensions/settings",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Virtual Extension details for the given extension ID.\n\nThis endpoint updates the virtual extension settings for an organization. It is primarily used to configure the operating mode for virtual extensions.\nModes determine how virtual extensions are assigned or managed within the system.\n\nUpdating a Virtual Extension requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Validate an external phone number",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/virtualExtensions/actions/validateNumbers/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate external phone number for the given organization.\n\nThis API is designed to validate external phone numbers before they are assigned as virtual extensions for a customer.\nIt ensures that the provided numbers are properly formatted, eligible for use, and not already in use within the system.\nThis validation is typically part of a pre-check process during provisioning or number assignment workflows, helping administrators or systems prevent conflicts or errors related to number reuse or fo"
},
{
"info": {
"name": "Get a list of a Virtual Extension Range",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualExtensionRanges",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
},
{
"name": "max",
"value": "10",
"type": "query",
"description": "Maximum number of results to return."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "The starting index of the results to return."
},
{
"name": "order",
"value": "name",
"type": "query",
"description": "Sort the list of virtual extension ranges by name or prefix, either ASC or DSC. Default sort order is ASC."
},
{
"name": "name",
"value": "SalesVirtualExtensionRange",
"type": "query",
"description": "Filter the list of virtual extension ranges by name."
},
{
"name": "prefix",
"value": "+1234",
"type": "query",
"description": "Filter the list of virtual extension ranges by prefix."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4Mjg5NzIyLTFiODAtNDFiNy05Njc4LTBlNzdhZThjMTA5OA",
"type": "query",
"description": "Filter the list of virtual extension ranges by location ID. Only one of the `locationId` and `OrgLevelOnly` query parameters is allowed at the same time."
},
{
"name": "orgLevelOnly",
"value": "true",
"type": "query",
"description": "Filter the list of virtual extension ranges by organization level. If `orgLevelOnly` is true, return only the organization level virtual extension ranges."
}
]
},
"docs": "Retrieves the list of Virtual Extension Ranges.\n\nVirtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing. Using these ranges, you can define patterns that can be used to route calls at a location level or an organization level. You are allowed to define virtual extensions ranges in addition to individual virtual extensions.\nThis works in both Standard and Enhanced modes\n\nRetrieving a virtual extension range requires a full "
},
{
"info": {
"name": "Create a Virtual Extension Range",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/virtualExtensionRanges",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Virtual Extension Range for the given organization or location.\n\nVirtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing. Using these ranges, you can define patterns that can be used to route calls at a location level or an organization level. You are allowed to define virtual extensions ranges in addition to individual virtual extensions.\nThis works in both Standard and Enhanced modes\n\nVirtual extension range "
},
{
"info": {
"name": "Get details of a Virtual Extension Range",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/virtualExtensionRanges/:extensionRangeId",
"params": [
{
"name": "extensionRangeId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA",
"type": "path",
"description": "ID of the virtual extension range."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieve virtual extension range details for the given extension range ID.\n\nVirtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing. Using these ranges, you can define patterns that can be used to route calls at a location level or an organization level. You are allowed to define virtual extensions ranges in addition to individual virtual extensions.\nThis works in both Standard and Enhanced modes\n\nRetrieving a virtual exten"
},
{
"info": {
"name": "Delete a Virtual Extension Range",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/virtualExtensionRanges/:extensionRangeId",
"params": [
{
"name": "extensionRangeId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA`",
"type": "path",
"description": "ID of the virtual extension range."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Delete a virtual extension range for the given extension range ID.\n\nVirtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing. Using these ranges, you can define patterns that can be used to route calls at a location level or an organization level. You are allowed to define virtual extensions ranges in addition to individual virtual extensions.\nThis works in both Standard and Enhanced modes\n\nDeleting a virtual extension range"
},
{
"info": {
"name": "Modify Virtual Extension Range",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/virtualExtensionRanges/:extensionRangeId/",
"params": [
{
"name": "extensionRangeId",
"value": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfRVhURU5TSU9OLzZkNmYwNmVlLTdkNDEtNDQ4Yy05MjgwLWZkM2ZiMDhmOGUyMA`",
"type": "path",
"description": "ID of the virtual extension range."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify virtual extension range for the given extension range ID.\n\nVirtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing. Using these ranges, you can define patterns that can be used to route calls at a location level or an organization level. You are allowed to define virtual extensions ranges in addition to individual virtual extensions.\nThis works in both Standard and Enhanced modes\n\nModifying a virtual extension range "
},
{
"info": {
"name": "Validate the prefix and extension pattern for a Virtual Extension Range",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/virtualExtensionRanges/actions/validate/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate the prefix and extension pattern for a Virtual Extension Range.\n\nVirtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing. Using these ranges, you can define patterns that can be used to route calls at a location level or an organization level. You are allowed to define virtual extensions ranges in addition to individual virtual extensions.\nThis works in both Standard and Enhanced modes\n\nValidating a prefix and exte"
}
]
},
{
"info": {
"name": "Hot Desk",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Sessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/hotdesk/sessions",
"params": [
{
"name": "orgId",
"value": "Y2lzY29...",
"type": "query",
"description": "List sessions in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "personId",
"value": "YL34EmA...",
"type": "query",
"description": "List sessions for this person."
},
{
"name": "workspaceId",
"value": "YL34EmB...",
"type": "query",
"description": "List sessions for this workspace."
}
]
},
"docs": "List hot desk sessions.\n\nUse query parameters to filter the response.\nThe `orgId` parameter is for use by partner administrators acting on a managed organization.\nThe `personId` and `workspaceId` parameters are optional and are used to filter the response to only include sessions for a specific person or workspace.\nWhen used together they are used as an AND filter."
},
{
"info": {
"name": "Delete Session",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/hotdesk/sessions/:sessionId",
"params": [
{
"name": "sessionId",
"value": "Y2lzY29zcGFyazovL3VzL0hEU0VTU0lPTi9lZTY1NDQ5OC00OGU5LTQxMTItOWYxMi1lZmJiYTJkOTE4ZWV8MjAyNC0wNS0xMVQxMDowMDowMFo=",
"type": "path",
"description": "The unique identifier for the hot desk session."
}
]
},
"docs": "Delete a hot desk session."
}
]
},
{
"info": {
"name": "Location Call Settings: Call Handling",
"type": "folder"
},
"items": [
{
"info": {
"name": "Generate example password for Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/actions/generatePassword/invoke",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Location for which example password has to be generated."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the location belongs."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Generates an example password using the effective password settings for the location. If you don't specify anything in the `generate` field or don't provide a request body, then you will receive a SIP password by default.\n\nUsed while creating a trunk and shouldn't be used anywhere else.\n\nGenerating an example password requires a full or write-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Read the Internal Dialing configuration for a location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/internalDialing",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "location for which internal calling configuration is being requested"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List route identities for this organization."
}
]
},
"docs": "Get current configuration for routing unknown extensions to the Premises as internal calls\n\nIf some users in a location are registered to a PBX, retrieve the setting to route unknown extensions (digits that match the extension length) to the PBX.\n\nRetrieving the internal dialing configuration requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify the Internal Dialing configuration for a location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/internalDialing",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "path",
"description": "location for which internal calling configuration is being requested"
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List route identities for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify current configuration for routing unknown extensions to the premise as internal calls\n\nIf some users in a location are registered to a PBX, enable the setting to route unknown extensions (digits that match the extension length) to the PBX.\n\nEditing the internal dialing configuration requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Location Intercept",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/intercept",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve intercept details for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve intercept location details for a customer location."
}
]
},
"docs": "Retrieve intercept location details for a customer location.\n\nIntercept incoming or outgoing calls for persons in your organization. If this is enabled, calls are either routed to a designated number the person chooses, or to the person's voicemail.\n\nRetrieving intercept location details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Put Location Intercept",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/intercept",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Modifies the intercept details for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modifies the intercept location details for a customer location."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modifies the intercept location details for a customer location.\n\nIntercept incoming or outgoing calls for users in your organization. If this is enabled, calls are either routed to a designated number the user chooses, or to the user's voicemail.\n\nModifying the intercept location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Location Outgoing Permission",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve outgoing call settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve outgoing call settings for this organization."
}
]
},
"docs": "Retrieve the location's outgoing call settings.\n\nA location's outgoing call settings allow you to determine the types of calls the people/workspaces at the location are allowed to make, as well as configure the default calling permission for each call type at the location.\n\nRetrieving a location's outgoing call settings requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read."
},
{
"info": {
"name": "Update Location Outgoing Permission",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Update outgoing call settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update outgoing call settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the location's outgoing call settings.\n\nLocation's outgoing call settings allows you to determine the types of calls the people/workspaces at this location are allowed to make and configure the default calling permission for each call type at a location.\n\nUpdating a location's outgoing call settings requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write."
},
{
"info": {
"name": "Get Outgoing Permission Auto Transfer Number",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/autoTransferNumbers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Retrieve auto transfer number for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve auto transfer number for this organization."
}
]
},
"docs": "Get the transfer numbers for the outbound permission in a location.\n\nOutbound permissions can specify which transfer number an outbound call should transfer to via the `action` field.\n\nRetrieving an auto transfer number requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephony_config_read."
},
{
"info": {
"name": "Put Outgoing Permission Auto Transfer Number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/autoTransferNumbers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Updating auto transfer number for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Updating auto transfer number for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modifies the transfer numbers for the outbound permission in a location.\n\nOutbound permissions can specify which transfer number an outbound call should transfer to via the `action` field.\n\nUpdating auto transfer number requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Outgoing Permission Location Access Code",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve access codes details for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve access codes details for a customer location."
}
]
},
"docs": "Retrieve access codes details for a customer location.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nRetrieving access codes details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create Outgoing Permission a new access code for a customer location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Add new access code for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Add new access code for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a new access code for the given location for a customer.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nCreating an access code for the given location requires a full or user administrator or location administrator auth token with a scope of spark-admin:telephony_config_write."
},
{
"info": {
"name": "Delete Outgoing Permission Access Code Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Deletes the access code details for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Deletes the access code details for a customer location."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Deletes the access code details for a particular location for a customer.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nModifying the access code location details requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete all Outgoing Permission Access Code for a Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/accessCodes",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Deletes all the access codes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Deletes the access codes for a customer location."
}
]
},
"docs": "Deletes all the access codes for a particular location for a customer.\n\nUse Access Codes to bypass the set permissions for all persons/workspaces at this location.\n\nDeleting the access codes requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Get Outgoing Permission Digit Pattern for a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Retrieve the digit patterns for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve the digit patterns for this organization."
}
]
},
"docs": "Get the digit patterns for the outbound permission in a location.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nRetrieving digit patterns requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create Outgoing Permission a new Digit Pattern for a location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Add a new digit pattern for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Add a new digit pattern for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a new digit pattern for the given location for a customer.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nCreating a digit pattern requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete all Outgoing Permission Digit Patterns for a Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Delete the digit patterns for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the digit patterns for this organization."
}
]
},
"docs": "Deletes all the digit patterns for a particular location for a customer.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nDeleting the digit patterns requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Outgoing Permission Digit Pattern for a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Retrieve the digit pattern details for this location."
},
{
"name": "digitPatternId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"type": "path",
"description": "Retrieve the digit pattern with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve the digit pattern details for this organization."
}
]
},
"docs": "Get the digit pattern details.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nRetrieving digit pattern details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Outgoing Permission Digit Pattern for a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Update the digit pattern for this location."
},
{
"name": "digitPatternId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"type": "path",
"description": "Update the digit pattern with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the digit pattern for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated digit pattern.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nUpdating a digit pattern requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Outgoing Permission Digit Pattern for a Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Delete the digit pattern for this location."
},
{
"name": "digitPatternId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"type": "path",
"description": "Delete the digit pattern with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the digit pattern for this organization."
}
]
},
"docs": "Delete the designated digit pattern.\n\nUse Digit Patterns to bypass the set permissions for all persons/workspaces at this location.\n\nDeleting a digit pattern requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Location Call Settings: Schedules",
"type": "folder"
},
"items": [
{
"info": {
"name": "Read the List of Schedules",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Return the list of schedules for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List schedules for this organization."
},
{
"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": "name",
"value": "AUTOATTENDANT-BUSINESS-HOURS",
"type": "query",
"description": "Only return schedules with the matching name."
},
{
"name": "type",
"value": "businessHours",
"type": "query",
"description": "Type of the schedule."
}
]
},
"docs": "List all schedules for the given location of the organization.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create a Schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Create the schedule for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the schedule for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Schedule for the given location.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nCreating a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Retrieve schedule details in this location."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Retrieve the schedule with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve schedule details from this organization."
}
]
},
"docs": "Retrieve Schedule details.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nRetrieving schedule details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Schedule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this schedule exists."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of schedule."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Update schedule with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update schedule from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated schedule.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nUpdating a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The Schedule ID will change upon modification of the Schedule name."
},
{
"info": {
"name": "Delete a Schedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete a schedule."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of the schedule."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Delete the schedule with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the schedule from this organization."
}
]
},
"docs": "Delete the designated Schedule.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nDeleting a schedule requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Details for a Schedule Event",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events/:eventId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Retrieve schedule event details in this location."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of schedule."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Retrieve the schedule event with the matching schedule ID."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN3",
"type": "path",
"description": "Retrieve the schedule event with the matching schedule event ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve schedule event details from this organization."
}
]
},
"docs": "Retrieve Schedule Event details.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nRetrieving a schedule event's details requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update a Schedule Event",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events/:eventId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location in which this schedule event exists."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of schedule.\n\n+ `businessHours` - Business hours schedule type.\n\n+ `holidays` - Holidays schedule type."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Update schedule event with the matching schedule ID."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN5QkVZWGs",
"type": "path",
"description": "Update the schedule event with the matching schedule event ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update schedule from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the designated Schedule Event.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nUpdating a schedule event requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\n**NOTE**: The schedule event ID will change upon modification of the schedule event name."
},
{
"info": {
"name": "Delete a Schedule Event",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events/:eventId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Location from which to delete a schedule."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of schedule."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Delete the schedule with the matching ID."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFX0VWRU5UL1RtVjNJRmxsWVhJbmN5QkVZWGs",
"type": "path",
"description": "Delete the schedule event with the matching schedule event ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the schedule from this organization."
}
]
},
"docs": "Delete the designated Schedule Event.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nDeleting a schedule event requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create a Schedule Event",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/schedules/:type/:scheduleId/events",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Create the schedule for this location."
},
{
"name": "type",
"value": "businessHours",
"type": "path",
"description": "Type of schedule."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFJVDB4SlJFRlo",
"type": "path",
"description": "Create event for a given schedule ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create the schedule for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Event for the given location Schedule.\n\nA time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.\n\nCreating a schedule event requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
}
]
},
{
"info": {
"name": "Location Call Settings: Voicemail",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Location Voicemail",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemail",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve voicemail settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve voicemail settings for this organization."
}
]
},
"docs": "Retrieve voicemail settings for a specific location.\n\nLocation voicemail settings allows you to enable voicemail transcription for a specific location.\n\nRetrieving a location's voicemail settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Location Voicemail",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemail",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Update voicemail settings for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update voicemail settings for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the voicemail settings for a specific location.\n\nLocation voicemail settings allows you to enable voicemail transcription for a specific location.\n\nUpdating a location's voicemail settings requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get VoicePortal",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicePortal",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location to which the voice portal belongs."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the voice portal belongs."
}
]
},
"docs": "Retrieve Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant announcements.\n\nRetrieving voice portal information for an organization requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update VoicePortal",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicePortal",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location to which the voice portal belongs."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update voicemail rules for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Voice portal information for the location.\n\nVoice portals provide an interactive voice response (IVR)\nsystem so administrators can manage auto attendant anouncements.\n\nUpdating voice portal information for an organization and/or rules requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get VoicePortal Passcode Rule",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicePortal/passcodeRules",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0fetchcllrjjejgghbruudtlknjbcleukhihhgFUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve voice portal passcode rules for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve voice portal passcode rules for this organization."
}
]
},
"docs": "Retrieve the voice portal passcode rule for a location.\n\nVoice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant anouncements\n\nRetrieving the voice portal passcode rule requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "List VoicemailGroup",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/voicemailGroups",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization to which the voicemail group belongs."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "query",
"description": "Location to which the voicemail group belongs."
},
{
"name": "name",
"value": "voicemail",
"type": "query",
"description": "Search (Contains) based on voicemail group name"
},
{
"name": "phoneNumber",
"value": "+19828282867",
"type": "query",
"description": "Search (Contains) based on number or extension"
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of events in the response. The maximum value is `200`."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Offset from the first result that you want to fetch."
}
]
},
"docs": "List the voicemail group information for the organization.\n\nYou can create a shared voicemail box and inbound FAX box to\nassign to users or call routing features like an auto attendant, call queue, or hunt group.\n\nRetrieving a voicemail group for the organization requires a full read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Location Voicemail Group",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemailGroups/:voicemailGroupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Retrieve voicemail group details for this location."
},
{
"name": "voicemailGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1ZPSUNFTUFJTF9HUk9VUC9hN2RkNGQzOS00YTc4LTQ1MTYtOTU1Zi03ODEwZGJlMzc5Y2Y",
"type": "path",
"description": "Retrieve voicemail group details for this voicemail group ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve voicemail group details for a customer location."
}
]
},
"docs": "Retrieve voicemail group details for a location.\n\nManage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nRetrieving voicemail group details requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Location Voicemail Group",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemailGroups/:voicemailGroupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Modifies the voicemail group details for this location."
},
{
"name": "voicemailGroupId",
"value": "Y2lzY29zcGFyazovL3VzL1ZPSUNFTUFJTF9HUk9VUC9hN2RkNGQzOS00YTc4LTQ1MTYtOTU1Zi03ODEwZGJlMzc5Y2Y",
"type": "path",
"description": "Modifies the voicemail group details for this voicemail group ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modifies the voicemail group details for a customer location."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modifies the voicemail group location details for a particular location for a customer.\n\nManage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.\n\nModifying the voicemail group location details requires a full, user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Voicemail Group for a Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemailGroups/:voicemailGroupId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Location from which to delete a voicemail group."
},
{
"name": "voicemailGroupId",
"value": "Y2lzY29zcGFyazovL3VzL0hVTlRfR1JPVVAvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0",
"type": "path",
"description": "Delete the voicemail group with the matching ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Delete the voicemail group from this organization."
}
]
},
"docs": "Delete the designated voicemail group.\n\nDeleting a voicemail group requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create a new Voicemail Group for a Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemailGroups",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzMxMTYx",
"type": "path",
"description": "Create a new voice mail group for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create a new voice mail group for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new voicemail group for the given location for a customer.\n\nA voicemail group can be created for given location for a customer.\n\nCreating a voicemail group for the given location requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Voicemail Group Fax Message Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemailGroups/faxMessage/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 standard and service PSTN numbers that are available to be assigned as a voicemail group's FAX message 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 t"
},
{
"info": {
"name": "Get Voicemail Group Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicemailGroups/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 a voicemail group's 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 token with a "
},
{
"info": {
"name": "Get VoicePortal Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/voicePortal/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 location voice portal's 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 token"
}
]
},
{
"info": {
"name": "Locations",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Locations",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/locations",
"params": [
{
"name": "name",
"value": "Denver",
"type": "query",
"description": "List locations whose name contains this string (case-insensitive)."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
"type": "query",
"description": "List locations by ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List locations in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of location in the response."
}
]
},
"docs": "List locations for an organization.\n\n* Use query parameters to filter the result set by location name, ID, or organization.\n\n* Long result sets will be split into [pages](/docs/basics#pagination).\n\n* Searching and viewing locations in your organization requires an administrator or location administrator auth token with any of the following scopes: `spark-admin:locations_read`, `spark-admin:people_read` or `spark-admin:device_read`."
},
{
"info": {
"name": "Create a Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/locations",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create a location common attribute for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Location for a given organization. Only an admin in the organization can create a new Location.\n\n* Creating a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Partners may specify `orgId` query parameter to create location in managed organization.\n\n* The following body parameters are required to create a new location: \n * `name`\n * `timeZone`\n * `preferredLanguage`\n * `address`\n * `announcementLan"
},
{
"info": {
"name": "Get Location Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get location common attributes for this organization."
}
]
},
"docs": "Shows details for a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Use query parameter `orgId` to filter the result set by organization(optional).\n\n* Searching and viewing location in your organization requires an administrator or location administrator auth token with any of the following scopes:\n\n * `spark-admin:locations_read`\n * `spark-admin:people_read`\n * `spark-admin:device_read`"
},
{
"info": {
"name": "Update a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "Update location common attributes for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update location common attributes for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update details for a location, by ID.\n\n* Updating a location in your organization requires a full administrator or location administrator auth token with a scope of `spark-admin:locations_write`.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Partners may specify `orgId` query parameter to update location in managed organization.\n\n* **Important:** While the `name` field supports up to 256 characters, locations that are enabled for Webex Calling must have names with a max"
},
{
"info": {
"name": "Delete Location",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/locations/:locationId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Specify the organization for the location to be deleted."
}
]
},
"docs": "Delete a location, by ID.\n\n* Specify the location ID in the `locationId` parameter in the URI.\n\n* Deleting a location in your organization requires a full administrator auth token with a scope of `spark-admin:locations_write`.\n\n* NOTE: Disabling Webex Calling for a Webex Calling enabled location is required prior to deleting a location."
},
{
"info": {
"name": "List Location Floors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/locations/:locationId/floors",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "A unique identifier for the location."
}
]
},
"docs": "List location floors.\nRequires an administrator auth token with the `spark-admin:locations_read` scope."
},
{
"info": {
"name": "Create a Location Floor",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/locations/:locationId/floors",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "A unique identifier for the location."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new floor in the given location. The `displayName` parameter is optional, and omitting it will result in the creation of a floor without that value set.\nRequires an administrator auth token with the `spark-admin:locations_write` scope."
},
{
"info": {
"name": "Get Location Floor Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/locations/:locationId/floors/:floorId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2E4NjczZDIwLWM0M2EtNDQ5Ni1iYWIxLTNiMjhhZGJjMjViYQ",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "floorId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY",
"type": "path",
"description": "A unique identifier for the floor."
}
]
},
"docs": "Shows details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI.\nRequires an administrator auth token with the `spark-admin:locations_read` scope."
},
{
"info": {
"name": "Update a Location Floor",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/locations/:locationId/floors/:floorId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "floorId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY",
"type": "path",
"description": "A unique identifier for the floor."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates details for a floor, by ID. Specify the floor ID in the `floorId` parameter in the URI. Include all details for the floor returned by a previous call to [Get Location Floor Details](/docs/api/v1/locations/get-location-floor-details). Omitting the optional `displayName` field will result in that field no longer being defined for the floor.\nRequires an administrator auth token with the `spark-admin:locations_write` scope."
},
{
"info": {
"name": "Delete a Location Floor",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/locations/:locationId/floors/:floorId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
"type": "path",
"description": "A unique identifier for the location."
},
{
"name": "floorId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMl9hL1dPUktTUEFDRV9MT0NBVElPTl9GTE9PUi83NDhkZDNmMS1iYmE5LTQxMDItODk5NC00M2IyOTM2MzNlNjY",
"type": "path",
"description": "A unique identifier for the floor."
}
]
},
"docs": "Deletes a floor, by ID.\nRequires an administrator auth token with the `spark-admin:locations_write` scope."
}
]
},
{
"info": {
"name": "Numbers",
"type": "folder"
},
"items": [
{
"info": {
"name": "Add Phone Numbers to a location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/locations/:locationId/numbers",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzM2ZTFlM2Y1LWJhODEtNDRiNC05ZGQ1LWIyMmVlNGY1MDIyZA",
"type": "path",
"description": "LocationId to which numbers should be added."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a specified set of phone numbers to a location for an organization. Phone numbers must follow the E.164 format.\n\nEach location has a set of phone numbers that can be assigned to people, workspaces, or features. Active phone numbers are in service.\n\nAdding a phone number to a location requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`.\n\nPhone numbers included in the request that already exist in the location will simply be ignored.\n\n
\n\n\n\n
This API is only supported for non-integrated PSTN connection types "
},
{
"info": {
"name": "Validate phone numbers",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/actions/validateNumbers/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Validate the list of phone numbers in an organization. Each phone number's availability is indicated in the response.\n\nEach location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service.\n\nValidating a phone number in an organization requires a full administrator or location administrator auth toke"
},
{
"info": {
"name": "Get Phone Numbers for an Organization with Given Criteria",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/numbers",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List numbers for this organization."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"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",
"type": "query",
"description": "Search for this `phoneNumber`."
},
{
"name": "available",
"value": "true",
"type": "query",
"description": "Search among the available phone numbers. This parameter cannot be used along with `ownerType` parameter when set to `true`."
},
{
"name": "order",
"value": "lastName-asc",
"type": "query",
"description": "Sort the list of phone numbers based on the following:`lastName`,`dn`,`extension`. Sorted by number and extension in ascending order."
},
{
"name": "ownerName",
"value": "Mark",
"type": "query",
"description": "Return the list of phone numbers that are owned by the given `ownerName`. Maximum length is 255."
},
{
"name": "ownerId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80M2QzYjY4ZC04MjkwLTRmMzctOTM2NS03MmNhMTcxMzRiODM",
"type": "query",
"description": "Returns only the matched number/extension entries assigned to the feature with the specified UUID or `broadsoftId`."
},
{
"name": "ownerType",
"value": "PEOPLE",
"type": "query",
"description": "Returns the list of phone numbers of the given `ownerType`. Possible input values:"
},
{
"name": "extension",
"value": "000",
"type": "query",
"description": "Returns the list of phone numbers with the given extension."
},
{
"name": "numberType",
"value": "NUMBER",
"type": "query",
"description": "Returns the filtered list of phone numbers that contain a given type of number. `available` or `state` query parameters cannot be used when `numberType=EXTENSION`. Possible input values:"
},
{
"name": "phoneNumberType",
"value": "PRIMARY",
"type": "query",
"description": "Returns the filtered list of phone numbers of the given `phoneNumberType`. Response excludes any extensions without numbers. Possible input values:"
},
{
"name": "state",
"value": "ACTIVE",
"type": "query",
"description": "Returns the list of phone numbers with the matching state. Response excludes any extensions without numbers. Possible input values:"
},
{
"name": "details",
"value": "true",
"type": "query",
"description": "Returns the overall count of the phone numbers along with other details for a given organization."
},
{
"name": "tollFreeNumbers",
"value": "true",
"type": "query",
"description": "Returns the list of toll-free phone numbers."
},
{
"name": "restrictedNonGeoNumbers",
"value": "true",
"type": "query",
"description": "Returns the list of restricted non-geographical numbers."
},
{
"name": "includedTelephonyTypes",
"value": "PSTN_NUMBER",
"type": "query",
"description": "Returns the list of phone numbers that are of given `includedTelephonyTypes`. By default, if this query parameter is not provided, it will list both PSTN and Mobile Numbers. Possible input values are PSTN_NUMBER or MOBILE_NUMBER."
},
{
"name": "serviceNumber",
"value": "true",
"type": "query",
"description": "Returns the list of service phone numbers."
}
]
},
"docs": "List all the phone numbers for the given organization along with the status and owner (if any).\n\nNumbers can be standard, service, or mobile. Both standard and service numbers are PSTN numbers.\nService numbers are considered high-utilization or high-concurrency phone numbers and can be assigned to features like auto-attendants, call queues, and hunt groups.\nPhone numbers can be linked to a specific location, be active or inactive, and be assigned or unassigned.\nThe owner of a number is the perso"
},
{
"info": {
"name": "List Manage Numbers Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Retrieve list of Manage Number jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of jobs. Default is 0."
},
{
"name": "max",
"value": "2000",
"type": "query",
"description": "Limit the number of jobs returned to this maximum count. Default is 2000."
}
]
},
"docs": "Lists all Manage Numbers jobs for the given organization in order of most recent one to oldest one irrespective of its status.\n\nThe public API only supports initiating jobs which move numbers between locations.\n\nVia Control Hub they can initiate both the move and delete, so this listing can show both.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Initiate Number Jobs",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Starts the execution of an operation on a set of numbers. Supported operations are: `MOVE`, `NUMBER_USAGE_CHANGE`.\n\nUp to 1000 numbers can be given in `MOVE` operation type and `NUMBER_USAGE_CHANGE` operation type per request.\nIf another move number job request is initiated while a move job is in progress, the API call will receive a `409` HTTP status code.\n\nIn order to move a number the following is required:\n\n* The number must be unassigned.\n\n* Both locations must have the same PSTN Connection"
},
{
"info": {
"name": "Get Manage Numbers Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Retrieve job details for this `jobId`."
}
]
},
"docs": "Returns the status and other details of the job.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Pause the Manage Numbers Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId/actions/pause/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Pause the Manage Numbers job for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Pause the Manage Numbers job for this organization."
}
]
},
"docs": "Pause the running Manage Numbers Job. A paused job can be resumed.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Resume the Manage Numbers Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId/actions/resume/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Resume the Manage Numbers job for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Resume the Manage Numbers job for this organization."
}
]
},
"docs": "Resume the paused Manage Numbers Job. A paused job can be resumed.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Manage Numbers Job errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/numbers/manageNumbers/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc",
"type": "path",
"description": "Retrieve the error details for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"type": "query",
"description": "Retrieve list of jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the error offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
}
]
},
"docs": "Lists all error details of Manage Numbers job. This will not list any errors if `exitCode` is `COMPLETED`. If the status is `COMPLETED_WITH_ERRORS` then this lists the cause of failures.\n\nList of possible Errors:\n\n+ BATCH-1017021 - Failed to move because it is an inactive number.\n\n+ BATCH-1017022 - Failed to move because the source location and target location have different CCP providers.\n\n+ BATCH-1017023 - Failed because it is not an unassigned number.\n\n+ BATCH-1017024 - Failed because it is a"
}
]
},
{
"info": {
"name": "Partner Reports/Templates",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/reports",
"params": [
{
"name": "service",
"value": "Webex",
"type": "query",
"description": "List reports which use this service."
},
{
"name": "templateId",
"value": "5",
"type": "query",
"description": "List reports with this report template ID."
},
{
"name": "from",
"value": "2024-05-01",
"type": "query",
"description": "List reports that were created on or after this date."
},
{
"name": "to",
"value": "2024-05-05",
"type": "query",
"description": "List reports that were created before this date."
},
{
"name": "regionId",
"value": "US",
"type": "query",
"description": "Data in the report will be from organizations in this region, for example, US, CA, or EU."
},
{
"name": "onBehalfOfSubPartnerOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"type": "query",
"description": "The encoded organization ID for the sub partner."
}
]
},
"docs": "Lists all reports previously generated from a given region. Use query parameters to filter the response. The parameters are optional.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` scopes.\n\nCSV reports for Webex suite services are only supported for organizations based in one region per API request. Organizations based in a different region will require a separate request with region specified.Reports are usually provided in zip format. A content-header application/zip or application/octet-stream does indicate the zip format. There is usually no .zip file extension.
"
},
{
"info": {
"name": "Delete a Report",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/partner/reports/:reportId",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9SRVBPUlQvYWQwZDIwNTc1ZGEwNDVhNDhmYWQ0N2Q5NzRhYjQxZjI",
"type": "path",
"description": "The unique identifier for the report."
},
{
"name": "onBehalfOfSubPartnerOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"type": "query",
"description": "The encoded organization ID for the sub partner."
}
]
},
"docs": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_write` scope."
},
{
"info": {
"name": "List Report Templates",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/partner/reports/templates",
"params": [
{
"name": "onBehalfOfSubPartnerOrgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wZTE4MmUxNS05ZmNhLTQ0NzgtYmEzOC1jNGFiMmUyN2FlZDA=",
"type": "query",
"description": "The encoded organization ID for the sub partner."
}
]
},
"docs": "List report templates. Report templates are available for use with the Partner Reports API.\n\nTo access this endpoint, you must use an administrator token with `spark-admin:reports_read` and `identity:people_read` [scopes](/docs/integrations#scopes). The authenticated user must be a Partner full administrator or Partner read-only administrator of the organization."
}
]
},
{
"info": {
"name": "People",
"type": "folder"
},
"items": [
{
"info": {
"name": "List People",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people",
"params": [
{
"name": "email",
"value": "john.andersen@example.com",
"type": "query",
"description": "List people with this email address. For non-admin requests, either this or `displayName` are required. With the exception of partner admins and a managed org relationship, people lookup by email is only available for users in the same org."
},
{
"name": "displayName",
"value": "John Andersen",
"type": "query",
"description": "List people whose name starts with this string. For non-admin requests, either this or email are required."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "query",
"description": "List people by ID. Accepts up to 85 person IDs separated by commas. If this parameter is provided then presence information (such as the `lastActivity` or `status` properties) will not be included in the response."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List people in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "roles",
"value": "Y2lzY29zcGFyazovL3VzL1JPTEUvYXRsYXMtcG9ydGFsLnBhcnRuZXIuc2FsZXNhZG1pbg",
"type": "query",
"description": "List of roleIds separated by commas."
},
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzYzNzE1",
"type": "query",
"description": "List people present in this location."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of people in the response. If `callingData`=true, then `max` will not be more than 100. If `locationId` is specified then `max` will not be more than 50."
},
{
"name": "excludeStatus",
"value": "true",
"type": "query",
"description": "Omit people status/availability to enhance query performance."
}
]
},
"docs": "List people in your organization. For most users, either the `email` or `displayName` parameter is required. Admin users can omit these fields and list all users in their organization.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be returned for people within your organization or an organization you manage. Presence information will not be returned if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6w"
},
{
"info": {
"name": "Create a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people",
"params": [
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
},
{
"name": "minResponse",
"value": "true",
"type": "query",
"description": "Set to `true` to improve performance by omitting person details and returning only the ID in the response when successful. If unsuccessful the response will have optional error details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new user account for a given organization. Only an admin can create a new user account.\n\nAt least one of the following body parameters is required to create a new user: `displayName`, `firstName`, `lastName`.\n\nCurrently, users may have only one email address associated with their account. The `emails` parameter is an array, which accepts multiple values to allow for future expansion, but currently only one email address will be used for the new user.\n\nAdmin users can include `Webex call"
},
{
"info": {
"name": "Get Person Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
}
]
},
"docs": "Shows details for a person, by ID.\n\nResponse properties associated with a user's presence status, such as `status` or `lastActivity`, will only be displayed for people within your organization or an organization you manage. Presence information will not be shown if the authenticated user has [disabled status sharing](https://help.webex.com/nkzs6wl/).\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as `true`.\n\nSpecify the pe"
},
{
"info": {
"name": "Update a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
},
{
"name": "showAllTypes",
"value": "true",
"type": "query",
"description": "Include additional user data like `#attendee` role."
},
{
"name": "minResponse",
"value": "true",
"type": "query",
"description": "Set to `true` to improve performance by omitting person details in the response. If unsuccessful the response will have optional error details."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update details for a person, by ID.\n\nSpecify the person ID in the `personId` parameter in the URI. Only an admin can update a person details.\n\nInclude all details for the person. This action expects all user details to be present in the request. A common approach is to first [GET the person's details](/docs/api/v1/people/get-person-details), make changes, then PUT both the changed and unchanged values.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifyi"
},
{
"info": {
"name": "Delete a Person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mNWIzNjE4Ny1jOGRkLTQ3MjctOGIyZi1mOWM0NDdmMjkwNDY",
"type": "path",
"description": "A unique identifier for the person."
}
]
},
"docs": "Remove a person from the system.\n\n**Required Administrator Roles:**\n\nThe following administrators have permission to use this API:\n\n**Customer Organization:**\n- Full administrator\n- User administrator\n\n**Partner/External Access:**\n- External full administrator\n\n**Note:** External read-only administrators, provisioning administrators, and device administrators cannot delete users.\n\nSpecify the person ID in the `personId` parameter in the URI."
},
{
"info": {
"name": "Get My Own Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/me",
"params": [
{
"name": "callingData",
"value": "true",
"type": "query",
"description": "Include Webex Calling user details in the response."
}
]
},
"docs": "Get profile details for the authenticated user. This is the same as GET `/people/{personId}` using the Person ID associated with your Auth token.\n\nAdmin users can include `Webex Calling` (BroadCloud) user details in the response by specifying `callingData` parameter as true."
}
]
},
{
"info": {
"name": "PSTN",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve PSTN Connection Options for a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/pstn/locations/:locationId/connectionOptions",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Return the list of List PSTN location connection options for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List PSTN location connection options for this organization."
},
{
"name": "serviceTypes",
"value": "MOBILE_NUMBERS",
"type": "query",
"description": "Use the `serviceTypes` parameter to fetch connections for the following services\n* `MOBILE_NUMBERS`"
}
]
},
"docs": "Retrieve the list of PSTN connection options available for a location.\n\nPSTN location connection settings enables the admin to configure or change the PSTN provider for a location.\n\nRetrieving this list requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_pstn_read`."
},
{
"info": {
"name": "Retrieve PSTN Connection for a Location",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/pstn/locations/:locationId/connection",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Retrieve PSTN location connection details for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve PSTN location connection details for this organization."
}
]
},
"docs": "Retrieves the current configured PSTN connection details for a location.\n\nPSTN location connection settings enables the admin to configure or change the PSTN provider for a location.\n\nRetrieving the PSTN connection details for a location requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_pstn_read`."
},
{
"info": {
"name": "Setup PSTN Connection for a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/pstn/locations/:locationId/connection",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1",
"type": "path",
"description": "Setup PSTN location connection options for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Setup PSTN location connection for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set up or update the PSTN connection details for a location.\n\nPSTN location connection settings enables the admin to configure or change the PSTN provider for a location.\n\nSetting up PSTN connection on a location requires a full administrator auth token with scopes of `spark-admin:telephony_pstn_write` and `spark-admin:telephony_pstn_read`."
},
{
"info": {
"name": "Update the Emergency Address for a Phone Number",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/pstn/numbers/:phoneNumber/emergencyAddress",
"params": [
{
"name": "phoneNumber",
"value": "Y2lzY29zcGFyazovL3VzL1BIT05FX05VTUJFUi8rMTk4NzY1NDMyMTA",
"type": "path",
"description": "Update the emergency address for this phone number."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update the emergency address of phone number in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the emergency address for a phone number.\n\nEmergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.\n\nUpdating the emergency address for a phone number requires a full administrator auth token with scope of `spark-admin:telephony_pstn_write`."
},
{
"info": {
"name": "Emergency Address Lookup to Verify if Address is Valid",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/pstn/locations/:locationId/emergencyAddress/lookup",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwM2FmYjBhLTBiZWMtNGQ1Yy05Mjc4LTRmMDdhYWY4OTg4ZA",
"type": "path",
"description": "Emergency address lookup for this location."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Emergency address lookup for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Returns a suggested address. If the input address is valid and unchanged, no errors are returned. If the input address requires corrections, the response includes a suggested address along with error details.\n\nEmergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.\n\nEmergency address lookup to verify if address is valid requires a full administrator auth token with scope of `spark-admin:telephony_pstn_read`."
},
{
"info": {
"name": "Add an Emergency Address to a Location",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/pstn/locations/:locationId/emergencyAddress",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwM2FmYjBhLTBiZWMtNGQ1Yy05Mjc4LTRmMDdhYWY4OTg4ZA",
"type": "path",
"description": "Location to which the emergency address will be added."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Adding emergency address for a location in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adds a new emergency address to the specified location. On success, returns the unique identifier of the newly created emergency address.\n\nEmergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.\n\nAdding emergency address to a location requires a full administrator auth token with scope of `spark-admin:telephony_pstn_write`."
},
{
"info": {
"name": "Update the Emergency Address of a Location",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/pstn/locations/:locationId/emergencyAddresses/:addressId",
"params": [
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzAwM2FmYjBhLTBiZWMtNGQ1Yy05Mjc4LTRmMDdhYWY4OTg4ZA",
"type": "path",
"description": "Location for which the emergency address will be updated."
},
{
"name": "addressId",
"value": "Y2lzY29zcGFyazovL3VzL0VNRVJHRU5DWV9BRERSRVNTLzhiMjdlM2JiLWY5Y2EtNDkyYi05YWM5LWVkZGEzN2EwY2IzZA",
"type": "path",
"description": "Unique identifier for the emergency address that will be updated."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Updating the emergency address of a location in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the emergency address of the specified location.\n\nEmergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.\n\nUpdating the emergency address of a location requires a full administrator auth token with scope of `spark-admin:telephony_pstn_write`."
}
]
},
{
"info": {
"name": "Recording Report",
"type": "folder"
},
"items": [
{
"info": {
"name": "List of Recording Audit Report Summaries",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/accessSummary",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recording audit report summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for recording audit report summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 90 days and the interval between the current time and `from` cannot exceed 365 days."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording audit report summaries of that user. If a special value of `all` is set for `hostEmail`, the admin can list recording audit report summaries of all users on the target site, not of a single user."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists recording audit report summaries from. If not specified, the API lists summary audit report for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API."
}
]
},
"docs": "Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return.\n\nOnly recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.\n\nThe list returned is sorted in descending order by the date and time that the recordings were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the recording audit report summaries of th"
},
{
"info": {
"name": "Get Recording Audit Report Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/accessDetail",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "recordingId",
"value": "4f914b1dfe3c4d11a61730f18c0f5387",
"type": "query",
"description": "A unique identifier for the recording."
},
{
"name": "hostEmail",
"value": "john.andersen@example.com",
"type": "query",
"description": "Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes. If set, the admin may specify the email of a user in a site they manage and the API will return recording details of that user."
},
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of recording audit report details to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
}
]
},
"docs": "Retrieves details for a recording audit report with a specified recording ID.\n\nOnly recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined."
},
{
"info": {
"name": "List Meeting Archive Summaries",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/meetingArchiveSummaries",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of meeting archive summaries to return in a single page. `max` must be equal to or greater than `1` and equal to or less than `100`."
},
{
"name": "from",
"value": "2020-07-12T09:30:00+08:00",
"type": "query",
"description": "Starting date and time (inclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `from` cannot be after `to`. Please note that the interval between `to` and `from` cannot exceed 30 days."
},
{
"name": "to",
"value": "2020-07-31T09:30:00+08:00",
"type": "query",
"description": "Ending date and time (exclusive) for meeting archive summaries to return, in any [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) compliant format. `to` cannot be before `from`. Please note that the interval between `to` and `from` cannot exceed 30 days."
},
{
"name": "siteUrl",
"value": "example.webex.com",
"type": "query",
"description": "URL of the Webex site which the API lists meeting archive summaries from. If not specified, the API lists meeting archive summaries for recordings from the user's preferred site. All available Webex sites and the preferred site of the user can be retrieved by `Get Site List` API."
}
]
},
"docs": "Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return.\n\nMeeting archive summaries are only available to full administrators, not even the meeting host.\n\nThe list returned is sorted in descending order by the date and time that the archives were created.\n\nLong result sets are split into [pages](/docs/basics#pagination).\n\n* If `siteUrl` is specified, the meeting archive summaries of the specified site will be listed; otherwis"
},
{
"info": {
"name": "Get Meeting Archive Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/recordingReport/meetingArchives/:archiveId",
"headers": [
{
"name": "timezone",
"value": "UTC"
}
],
"params": [
{
"name": "archiveId",
"value": "7d7ea5f42b921eace05386ca24ad730e_R_1000634462",
"type": "path",
"description": "A unique identifier for the meeting archive summary."
}
]
},
"docs": "Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata.\n\nMeeting archive details are only available to full administrators, not even the meeting host.\n\n#### Request Header\n\n* `timezone`: [Time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) in conformance with the [IANA time zone database](https://www.iana.org/time-zones). The default is UTC if `timezone` is not defined."
}
]
},
{
"info": {
"name": "Reports",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Reports",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/reports",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"type": "query",
"description": "List reports by ID."
},
{
"name": "service",
"value": "Webex",
"type": "query",
"description": "List reports which use this service."
},
{
"name": "templateId",
"value": "5",
"type": "query",
"description": "List reports with this report template ID."
},
{
"name": "from",
"value": "2020-05-01",
"type": "query",
"description": "List reports that were created on or after this date."
},
{
"name": "to",
"value": "2020-05-05",
"type": "query",
"description": "List reports that were created before this date."
}
]
},
"docs": "Lists all reports. Use query parameters to filter the response. The parameters are optional. However, `from` and `to` parameters should be provided together.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the"
},
{
"info": {
"name": "Create a Report",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/reports",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new report. For each `templateId`, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide `siteUrl`. These validation rules can be retrieved via the [Report Templates API](/docs/api/v1/report-templates).\n\nThe 'templateId' parameter is a number. However, it is a limitation of developer.webex.com platform that it is passed as a string when you try to test the API from here.\n\nCSV reports for Webex suite service"
},
{
"info": {
"name": "Get Report Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/reports/:reportId",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"type": "path",
"description": "The unique identifier for the report."
}
]
},
"docs": "Shows details for a report, by report ID.\n\nSpecify the report ID in the `reportId` parameter in the URI.\n\n**Notes**:\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports.\n\nReports are usually provided in zip format. A Content-header `application/zip` or `application/octet-stream` does indicate the zip format. There is usually no .zip file extens"
},
{
"info": {
"name": "Delete a Report",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/reports/:reportId",
"params": [
{
"name": "reportId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9mYzhjMWFhMS00OTM5LTQ2NjEtODAwMy1hYWE0MzFmZWM0ZmE",
"type": "path",
"description": "The unique identifier for the report."
}
]
},
"docs": "Remove a report from the system.\n\nSpecify the report ID in the `reportId` parameter in the URI\n\nCSV reports for Webex suite services are only supported for organizations based in the North American region. Organizations based in a different region will return blank CSV files for any Teams reports."
}
]
},
{
"info": {
"name": "Reports: Detailed Call History",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Detailed Call History",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/cdr_feed",
"params": [
{
"name": "startTime",
"value": "2022-06-08T21:27:00.604Z",
"type": "query",
"description": "Time of the first report you wish to collect. (Report time is the time the call finished). **Note:** The specified time must be between 5 minutes ago and 48 hours ago, and formatted as `YYYY-MM-DDTHH:MM:SS.mmmZ`."
},
{
"name": "endTime",
"value": "2022-06-09T23:27:18.604Z",
"type": "query",
"description": "Time of the last report you wish to collect. (Report time is the time the call finished). **Note:** The specified time should be later than `startTime` but no later than 48 hours, and formatted as `YYYY-MM-DDTHH:MM:SS.mmmZ`."
},
{
"name": "locations",
"value": "Erlanger Urgent / Primary Care Main",
"type": "query",
"description": "Name of the location (as shown in Control Hub). Up to 10 comma-separated locations can be provided. Allows you to query reports by location."
},
{
"name": "max",
"value": "1000",
"type": "query",
"description": "Limit the maximum number of reports per page of the response. The range is 500 to 5000. Values below 500 are automatically adjusted up to 500, and values above 5000 are automatically adjusted down to 5000. When the API has more reports to return than the max value, the API response will be paginated. Follow the next link contained in the “Link” header within a response to request the next page of results. If there is no next link, all reports for the selected time range have been collected.\n\nFor instance, let's say the initial API request is\n\nhttps://analytics-calling.webexapis.com/v1/cdr_feed?endTime=2025-08-15T10:00:00.000Z&startTime=2025-08-15T08:00:00.000Z&max=5000\n\nThe link header in the response would look something like\n\n<;rel=\"next\">"
}
]
},
"docs": "Provides Webex Calling Detailed Call History data for your organization.\n\nResults can be filtered with the `startTime`, `endTime` and `locations` request parameters. The `startTime` and `endTime` parameters specify the start and end of the time period for the Detailed Call History reports you wish to collect. The API will return all reports that were created between `startTime` and `endTime`.\n\n
\nResponse entries may be added as more information is made available for the reports.\nValues "
},
{
"info": {
"name": "Get Live Stream Detailed Call History",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/cdr_stream",
"params": [
{
"name": "startTime",
"value": "2022-06-08T21:27:00.604Z",
"type": "query",
"description": "The start date-time of the first record you wish to collect in UTC time. It would be the earliest time at which the data was inserted into the Webex Calling cloud for the records you wish to collect. Format must be as `YYYY-MM-DDTHH:MM:SS.mmmZ`. `startTime` can't be older than 12 hours from your current UTC time. The window period between `startTime` and `endTime` must not exceed 2 hours in a single API request."
},
{
"name": "endTime",
"value": "2022-06-09T23:27:18.604Z",
"type": "query",
"description": "The end date-time of the last record you wish to collect in UTC time. It would be the latest time at which the data was inserted into the Webex Calling cloud for the records you wish to collect. Format must be as `YYYY-MM-DDTHH:MM:SS.mmmZ`. `endTime` must be 1 minute ago from your current UTC time and can’t be older than 12 hours. `endTime` must be greater than `startTime`. The window period between `startTime` and `endTime` must not exceed 2 hours in a single API request."
},
{
"name": "locations",
"value": "Erlanger Urgent / Primary Care Main",
"type": "query",
"description": "Name of the location (as shown in Control Hub). Up to 10 comma-separated locations can be provided. Allows you to query reports by location."
},
{
"name": "max",
"value": "1000",
"type": "query",
"description": "Limit the maximum number of reports per page of the response. The range is 500 to 5000. Values below 500 are automatically adjusted up to 500, and values above 5000 are automatically adjusted down to 5000. When the API has more reports to return than the max value, the API response will be paginated. Follow the next link contained in the “Link” header within a response to request the next page of results. If there is no next link, all reports for the selected time range have been collected.\n\nFor instance, let's say the initial API request is\n\nhttps://analytics-calling.webexapis.com/v1/cdr_stream?endTime=2025-08-15T10:00:00.000Z&startTime=2025-08-15T08:00:00.000Z&max=5000\n\nThe link header in the response would look something like\n\n<;rel=\"next\">"
}
]
},
"docs": "Provides Webex Calling Detailed Call History data for your organization.\n\nResults can be filtered with the `startTime`, `endTime` and `locations` request parameters. The `startTime` and `endTime` parameters specify the time window during which Detailed Call History data was inserted into the Webex Calling cloud. The API will return all reports whose insertion time into the Webex Calling cloud falls between `startTime` and `endTime`.\n\n
\nResponse entries may be added as more information i"
}
]
},
{
"info": {
"name": "User Call Settings (2/2)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve a person's Application Services Settings New",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/applications",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Gets mobile and PC applications settings for a user.\n\nApplication services let you determine the ringing behavior for calls made to people in certain scenarios. You can also specify which devices can download the Webex Calling app.\n\nRequires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "List Move Users Jobs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
"type": "query",
"description": "Retrieve list of Move Users jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of jobs. Default is 0."
},
{
"name": "max",
"value": "2000",
"type": "query",
"description": "Limit the number of jobs returned to this maximum count. Default is 2000."
}
]
},
"docs": "Lists all the Move Users jobs for the given organization in order of most recent job to oldest job irrespective of its status.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Validate or Initiate Move Users Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
"type": "query",
"description": "Create Move Users job for this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "This API allows the user to perform one of the following operations:\n\n* Setting the `validate` attribute to `true` validates the user move.\n\n* Setting the `validate` attribute to `false` performs the user move.\n\n
\n\nNotes:\n\n* A maximum of `100` users can be moved at a time.\n\n* Setting the `validate` attribute to `true` only allowed for calling user.\n\n* When a single non calling user is moved, it will be moved synchronously without creating any job.\n\n
\n\nErrors occurring during the initial "
},
{
"info": {
"name": "Get Move Users Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC8xMzFkOTg1ZC1iZThhLTQ3MjgtYjM2MC02MzBjNTAxNTEyNzE",
"type": "path",
"description": "Retrieve job details for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8wMjEyNGVlZi04YWY3LTQ4OWMtODA1Yi0zNjNjYzY0MDE4OTM",
"type": "query",
"description": "Retrieve job details for this organization."
}
]
},
"docs": "Returns the status and other details of the job.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Pause the Move Users Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId/actions/pause/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Pause the Move Users job for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Pause the Move Users job for this organization."
}
]
},
"docs": "Pause the running Move Users Job. A paused job can be resumed.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Resume the Move Users Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId/actions/resume/invoke",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC83ZWUyMjAzMS0xM2Q5LTRmYTctODQ0NS1lNDMzNjE3MmVjYmU",
"type": "path",
"description": "Resume the Move Users job for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi80YTViYjVhOC1hZDAwLTQ0ZGEtODg2NC0wYjExNTE0NDQyYzk",
"type": "query",
"description": "Resume the Move Users job for this organization."
}
]
},
"docs": "Resume the paused Move Users Job that is in paused status.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "List Move Users Job errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/jobs/person/moveLocation/:jobId/errors",
"params": [
{
"name": "jobId",
"value": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC84YTI0ZjM5NC1lMTdjLTRiMTYtOTU3Ni0zNzA3YjY5YmU3Mzc",
"type": "path",
"description": "Retrieve the error details for this `jobId`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85MTE1NDM1Ny1iZWQxLTQ1ZDUtYWE4Zi00ZTUwYzBkZWNmMzM",
"type": "query",
"description": "Retrieve list of jobs for this organization."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the error offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
}
]
},
"docs": "Lists all error details of Move Users job. This will not list any errors if `exitCode` is `COMPLETED`. If the status is `COMPLETED_WITH_ERRORS` then this lists the cause of failures.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Retrieve Music On Hold Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/musicOnHold",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the person'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 a person's music on hold settings requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Configure Music On Hold Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/musicOnHold",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person'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 person, music on hold setting must be enabled for this location.\n\nUpdating a person's music on hold settings requires a full or user administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve Access Codes for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
]
},
"docs": "Retrieve the person's access codes.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create Access Codes for a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create new Access codes for the person.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Modify Access Codes for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a person's access codes.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Delete Access Codes for a Person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/accessCodes",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
]
},
"docs": "Deletes all Access codes for the person.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Retrieve Transfer Numbers for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/autoTransferNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
]
},
"docs": "Retrieve the person's transfer numbers.\n\nWhen calling a specific call type, this person will be automatically transferred to another number. The person 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, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Transfer Numbers for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/autoTransferNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a person's transfer numbers.\n\nWhen calling a specific call type, this person will be automatically transferred to another number. The person 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 or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Retrieve Digit Patterns for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
]
},
"docs": "Retrieve the person's digit patterns.\n\nDigit patterns are used to bypass permissions.\n\nRetrieving digit patterns 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": "Create Digit Patterns for a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new digit pattern for the given person.\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 Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modifies whether this user 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 Person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
]
},
"docs": "Delete all digit patterns for a Person.\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 Digit Pattern Details for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 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 the API."
}
]
},
"docs": "Retrieve the digit pattern details for a person.\n\nDigit patterns are used to bypass permissions.\n\nRetrieving the digit pattern 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": "Modify a Digit Pattern for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a digit pattern for a Person.\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 Person",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 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 the API."
}
]
},
"docs": "Delete a digit pattern for a Person.\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": "Assign or Unassign numbers to a person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/numbers",
"params": [
{
"name": "personId",
"value": "'Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iNTcwZGY3ZC00MjBkLTQ4NGYtYWE5OS1kMzcxOGZjNDUxZDA='",
"type": "path",
"description": "Unique identitfier of the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization of the Route Group."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign or unassign alternate phone numbers to a person.\n\nEach location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service.\n\nAssigning or unassigning an alternate phone number to a person requires a full administrator or location administrator auth token with a scope of `spark-admin:telephony_con"
},
{
"info": {
"name": "Get Preferred Answer Endpoint",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/preferredAnswerEndpoint",
"params": [
{
"name": "personId",
"value": "Y2lzY29z...",
"type": "path",
"description": "A unique identifier for the person."
},
{
"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": "Get the person's preferred answer endpoint and the list of endpoints available for selection. The preferred answer endpoint is null if one has not been selected. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality. These endpoints can be used by the following Call Control API's that allow the person to specify an endpointId to use for the call:
\n\n+ [/v1/telephony/calls/dial](/docs/api/v1/call-controls/dial)
\n\n+ [/"
},
{
"info": {
"name": "Modify Preferred Answer Endpoint",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/preferredAnswerEndpoint",
"params": [
{
"name": "personId",
"value": "Y2lzY29z...",
"type": "path",
"description": "A unique identifier for the person."
},
{
"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": "Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the `preferredAnswerEndpointId` attribute must be set to null.
\nThis API requires `spark:telephony_config_write` or `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Search Shared-Line Appearance Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/:applicationId/availableMembers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "applicationId",
"value": "2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA",
"type": "path",
"description": "A unique identifier for the application."
},
{
"name": "max",
"value": "0",
"type": "query",
"description": "Number of records per page."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Page number."
},
{
"name": "location",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
"type": "query",
"description": "Location ID for the user."
},
{
"name": "name",
"value": "john",
"type": "query",
"description": "Search for users with names that match the query."
},
{
"name": "number",
"value": "1234567890",
"type": "query",
"description": "Search for users with numbers that match the query."
},
{
"name": "order",
"value": "fname",
"type": "query",
"description": "Sort by first name (`fname`) or last name (`lname`)."
},
{
"name": "extension",
"value": "1111",
"type": "query",
"description": "Search for users with extensions that match the query."
}
]
},
"docs": "Get members available for shared-line assignment to a Webex Calling Apps Desktop device.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope."
},
{
"info": {
"name": "Get Shared-Line Appearance Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/:applicationId/members",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "applicationId",
"value": "2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA",
"type": "path",
"description": "A unique identifier for the application."
}
]
},
"docs": "Get primary and secondary members assigned to a shared line on a Webex Calling Apps Desktop device.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope."
},
{
"info": {
"name": "Put Shared-Line Appearance Members",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/:applicationId/members",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "applicationId",
"value": "2lzY29zcGFyazovL3VzL0FQUExJQ0FUSU9OLzFmNWUwYWYzLTIwMjgtNDFkNS05OWI3LTVkNTQyMzI3Y2MwMA",
"type": "path",
"description": "A unique identifier for the application."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps Desktop device.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Modify a person's voicemail passcode",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/voicemail/passcode",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81NmRiMjRkMy03YTdhLTQwYTItOWFjOS1iMjMzMjc3OTIxTu+/vQ",
"type": "path",
"description": "Modify voicemail passcode for this person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify voicemail passcode for a person in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a person's voicemail passcode.\n\nModifying a person'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": "Get Message Summary",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/voiceMessages/summary"
},
"docs": "Get a summary of the voicemail messages for the user."
},
{
"info": {
"name": "List Messages",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/voiceMessages",
"params": [
{
"name": "lineOwnerId",
"value": "Y2lzY29z...",
"type": "query",
"description": "The ID of a user, workspace, or virtual line for which there is a secondary line on a device owned by the user invoking the API."
}
]
},
"docs": "Get the list of all voicemail messages for the user."
},
{
"info": {
"name": "Delete Message",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/voiceMessages/:messageId",
"params": [
{
"name": "messageId",
"value": "",
"type": "path",
"description": "The message identifer of the voicemail message to delete"
}
]
},
"docs": "Delete a specfic voicemail message for the user."
},
{
"info": {
"name": "Mark As Read",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/voiceMessages/markAsRead",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the voicemail message(s) as read for the user.\n\nIf the `messageId` is provided, then only mark that message as read. Otherwise, all messages for the user are marked as read."
},
{
"info": {
"name": "Mark As Unread",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/voiceMessages/markAsUnread",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the voicemail message(s) as unread for the user.\n\nIf the `messageId` is provided, then only mark that message as unread. Otherwise, all messages for the user are marked as unread."
},
{
"info": {
"name": "Retrieve Agent's List of Available Caller IDs",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/agent/availableCallerIds",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Get the list of call queues and hunt groups available for caller ID use by this person as an agent.\n\nThis API requires a full, user, or read-only administrator or location 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/people/:personId/agent/callerId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q",
"type": "path",
"description": "Unique identifier for the person."
}
]
},
"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 or location 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/people/:personId/agent/callerId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iYjZmNzYxOC0wNTUyLTRiYmUtYWVmYi02NThjZGU1Y2M3M2Q",
"type": "path",
"description": "Unique identifier for the person."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify Agent's Caller ID Information.\n\nEach Agent will be able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or Hunt Group's Caller ID or their own configured Caller ID\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Read Call Bridge Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/features/callBridge",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Call Bridge settings.\n\nThis API requires a full, user or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Call Bridge Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/features/callBridge",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Call Bridge settings.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Get Person Secondary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/secondary/availableNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's secondary phone number.\nThese numbers are associated with the location of the person 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 token with a scope "
},
{
"info": {
"name": "Get Person Fax Message Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/faxMessage/availableNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's FAX message number.\nThese numbers are associated with the location of the person 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 token with a scope of `"
},
{
"info": {
"name": "Get Person Call Forward Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/callForwarding/availableNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's call forward number.\nThese numbers are associated with the location of the person 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 or location ad"
},
{
"info": {
"name": "Get Person Primary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/primary/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."
},
{
"name": "licenseType",
"value": "Webex Calling Professional",
"type": "query",
"description": "Used to search numbers according to the person's `licenseType` to which the number will be assigned."
}
]
},
"docs": "List numbers that are available to be assigned as a person's primary phone number.\nBy default, this API returns standard and mobile numbers from all locations that are unassigned. The parameters `licenseType` and `locationId` must align with the person's settings to determine the appropriate number for assignment.\nFailure to provide these parameters may result in the unsuccessful assignment of the returned number.\n\nThe available numbers APIs help identify candidate numbers and their owning entit"
},
{
"info": {
"name": "Get Person ECBN Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/emergencyCallbackNumber/availableNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 are available to be assigned as a person's emergency callback number.\nThese numbers are associated with the location of the person 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 or location administrator aut"
},
{
"info": {
"name": "Get Person Call Intercept Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/callIntercept/availableNumbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's call intercept number.\nThese numbers are associated with the location 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 or location administrator "
},
{
"info": {
"name": "Retrieve a Person's MS Teams Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/settings/msTeams",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 since the default is the same organization as the token used to access the API."
}
]
},
"docs": "Not supported for Webex for Government (FedRAMP)
\n\nRetrieve a person's MS Teams settings.\n\nAt a person level, MS Teams settings allow access to retrieving the `HIDE WEBEX APP` and `PRESENCE SYNC` settings.\n\nTo retrieve a person's MS Teams settings requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Configure a Person's MS Teams Setting",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/settings/msTeams",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 since the default is the same organization as the token used to access the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Not supported for Webex for Government (FedRAMP)
\n\nConfigure a Person's MS Teams setting.\n\nMS Teams settings can be configured at the person level.\n\nRequires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Personal Assistant",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/features/personalAssistant",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Get Personal Assistant details for the organization."
}
]
},
"docs": "Retrieve Personal Assistant details for a specific user.\n\nPersonal Assistant is used to manage a user's incoming calls when they are away.\n\nRetrieving Personal Assistant details requires a full, user, or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Personal Assistant",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/features/personalAssistant",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Update Personal Assistant details for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update Personal Assistant details for a specific user.\n\nPersonal Assistant is used to manage a user's incoming calls when they are away.\n\nUpdating Personal Assistant details requires a full or user administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve the List of Available Features",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/modeManagement/availableFeatures",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI",
"type": "path",
"description": "A unique identifier for the user."
},
{
"name": "name",
"value": "Day",
"type": "query",
"description": "List features whose `name` contains this string."
},
{
"name": "phoneNumber",
"value": "+35391884653",
"type": "query",
"description": "List features whose phoneNumber contains this matching string."
},
{
"name": "extension",
"value": "1234",
"type": "query",
"description": "List features whose `extension` contains this matching string."
},
{
"name": "max",
"value": "",
"type": "query",
"description": "Maximum number of features to return in a single page."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "name-asc",
"type": "query",
"description": "Sort the list of features based on `name`, `phoneNumber`, or `extension`, either `asc`, or `desc`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve features list from this organization."
}
]
},
"docs": "Retrieve a list of feature identifiers that can be assigned to a user for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`.\n\nFeatures with mode-based call forwarding enabled can be assigned to a user for `Mode Management`.\n\nRetrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Retrieve the List of Features Assigned to a User for Mode Management",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/modeManagement/features",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI",
"type": "path",
"description": "A unique identifier for the user."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve features list from this organization."
}
]
},
"docs": "Retrieve a list of feature identifiers that are already assigned to a user for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`.\nA maximum of 50 features can be assigned to a user for `Mode Management`.\n\nFeatures with mode-based call forwarding enabled can be assigned to a user for `Mode Management`.\n\nRetrieving this list requires a full, read-only, or location administrator auth token with a scope of `spark-admin:telepho"
},
{
"info": {
"name": "Assign a List of Features to a User for Mode Management",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/modeManagement/features",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8yNWJiZjgzMS01YmU5LTRjMjUtYjRiMC05YjU5MmM4YTA4NmI",
"type": "path",
"description": "A unique identifier for the user."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Retrieve features list from this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Assign a user a list of feature identifiers for `Mode Management`. Feature identifiers reference feature instances like `Auto Attendants`, `Call Queues`, and `Hunt Groups`.\nA maximum of 50 features can be assigned to a user for `Mode Management`.\n\nUpdating mode management settings for a user requires a full, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get the User’s Selective Call Accept Criteria List",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Retrieve selective call accept criteria list for a user.\n\nWith the selective call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update User’s Selective Call Accept Criteria",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify selective call accept setting for a user.\n\nWith the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create a Criteria to the User’s Selective Call Accept Service",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a criteria to the user's selective call accept service.\n\nWith the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get a Criteria for the User’s Selective Call Accept Service",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Get the criteria details for the user's selective call accept service.\n\nWith the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Criteria From the User’s Selective Call Accept Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a criteria for the user's selective call accept service.\n\nWith the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Criteria From the User’s Selective Call Accept service",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveAccept/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Delete a criteria from the user's selective call accept criteria list.\n\nWith the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get the User’s Selective Call Rejection Criteria Listing",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Retrieve selective call rejection criteria for a user.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update User’s Selective Call Rejection Criteria List",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify selective call rejection setting for a user.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create a Criteria to the User’s Selective Call Rejection Service",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a criteria to the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get a Criteria for the User’s Selective Call Rejection Service",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Get a criteria for the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Criteria for the User’s Selective Call Rejection Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a criteria for the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Criteria From the User’s Selective Call Rejection Service",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveReject/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Delete a criteria from the user's selective call rejection service.\n\nWith the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get the User’s Selective Call Forwarding",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Retrieve selective call forwarding criteria for a user.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update User’s Selective Call Forwarding Criteria List",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify selective call forwarding setting for a user.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Create a Criteria to the User’s Selective Call Forwarding Service",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add a criteria to the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get a Criteria for the User’s Selective Call Forwarding Service",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Get the criteria details for the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Criteria for the User’s Selective Call Forwarding Service",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a criteria for the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Criteria From the User’s Selective Call Forwarding Service",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/selectiveForward/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS85OThhMThhYi1kZjY5LTQ5MWYtYmViZi03MzUxMGE3ODI5N2I",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL1oxNzI5NzA4NzUwMTY4MDI",
"type": "path",
"description": "Criteria ID."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization in which the user resides."
}
]
},
"docs": "Delete a criteria from the user's selective call forwarding service.\n\nWith the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.\n\nRequires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Search Shared-Line Appearance Members New",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/availableMembers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "order",
"value": "number-asc|number-desc",
"type": "query",
"description": "Order the Route Lists according to number, ascending or descending."
},
{
"name": "location",
"value": "Y2JkOTM3NzAtZTZhMy00NDhiLTliZGYtODZkYmFkMzkxOGMy",
"type": "query",
"description": "Location ID for the user."
},
{
"name": "name",
"value": "abcd",
"type": "query",
"description": "Search for users with names that match the query."
},
{
"name": "phoneNumber",
"value": "1234567890",
"type": "query",
"description": "Search for users with numbers that match the query."
},
{
"name": "extension",
"value": "8765",
"type": "query",
"description": "Search for users with extensions that match the query."
}
]
},
"docs": "Get members available for shared-line assignment to a Webex Calling Apps.\n\nLike most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope."
},
{
"info": {
"name": "Get Count of Shared-Line Appearance Members",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/availableMembers/count",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
},
{
"name": "locationId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2ViYTgzY2VjLThiMDUtNDMxNS1iNzJlLTQ1MTUyYTg1ZWE0Yw",
"type": "query",
"description": "Location ID for the person."
},
{
"name": "memberName",
"value": "john",
"type": "query",
"description": "Search for people with names that match the query."
},
{
"name": "phoneNumber",
"value": "1234567890",
"type": "query",
"description": "Search for people with numbers that match the query."
},
{
"name": "extension",
"value": "1111",
"type": "query",
"description": "Search for people with extensions that match the query."
}
]
},
"docs": "Get the count of members available for shared-line assignment to Webex Calling Apps.\n\nShared-line appearance allows multiple devices or applications to share a single line for call handling.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope."
},
{
"info": {
"name": "Get Shared-Line Appearance Members New",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/members",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
}
]
},
"docs": "Get primary and secondary members assigned to a shared line on a Webex Calling Apps.\n\nLike most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_read` scope."
},
{
"info": {
"name": "Put Shared-Line Appearance Members New",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/applications/members",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps.\n\nLike most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Get the user call captions settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/callCaptions",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieve the user's call captions settings.\n\n**NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full, user, read-only, or location administrator auth token with a scope of `spark-admin:te"
},
{
"info": {
"name": "Update the user call captions settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/callCaptions",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the user's call captions settings.\n\n**NOTE**: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.\n\nThe call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config"
},
{
"info": {
"name": "Get Person Executive Call Filtering Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the user."
}
]
},
"docs": "Retrieve the executive call filtering settings for the specified person.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`"
},
{
"info": {
"name": "Modify Person Executive Call Filtering Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the executive call filtering settings for the specified person.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Person Executive Call Filtering Criteria Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the user."
}
]
},
"docs": "Retrieve the executive call filtering criteria settings for the specified person.\n\nExecutive Call Filtering Criteria in Webex allows you to retrieve the detailed configuration for a specific filter rule. This includes schedule settings, phone number filters, and call routing preferences for executive call filtering.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Person Executive Call Filtering Criteria Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the executive call filtering settings for the specified person.\n\nExecutive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types. You can enable or disable call filtering and configure filter rules to manage incoming calls.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete Person Executive Call Filtering Criteria",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria/:id",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0",
"type": "path",
"description": "The `id` parameter specifies the unique identifier for the executive call filtering criteria. Example: `Y2lzY29zcGFyazovL3VzL0NSSVRFUklBL2RHVnpkRjltYVd4MFpYST0`."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the user."
}
]
},
"docs": "Delete a specific executive call filtering criteria configuration for the specified person.\n\nExecutive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Add Person Executive Call Filtering Criteria",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/callFiltering/criteria",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the user."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new executive call filtering criteria configuration for the specified person.\n\nExecutive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls. This API creates a new filter rule with the specified configuration, including schedule, phone numbers, and call routing preferences.\n\nThis API requires a full, user or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Person Executive Alert Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/alert",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
]
},
"docs": "Get executive alert settings for the specified person.\n\nExecutive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren't answered.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Person Executive Alert Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/alert",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive alert settings for the specified person.\n\nExecutive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation. You can configure settings such as sequential or simultaneous alerting, and specify what happens when calls aren't answered.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Person Executive Assigned Assistants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/assignedAssistants",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
]
},
"docs": "Get list of assigned executive assistants for the specified person.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Person Executive Assigned Assistants",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/assignedAssistants",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update assigned executive assistants for the specified person.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Person Executive Available Assistants",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/availableAssistants",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
},
{
"name": "max",
"value": "5",
"type": "query",
"description": "Limit the number of objects returned to this maximum count."
},
{
"name": "start",
"value": "2",
"type": "query",
"description": "Start at the zero-based offset in the list of matching objects."
},
{
"name": "name",
"value": "Mathew - Test",
"type": "query",
"description": "Only return people with the matching name (person's first and last name combination)."
},
{
"name": "phoneNumber",
"value": "9705550028",
"type": "query",
"description": "Only return people with the matching phone number or extension."
}
]
},
"docs": "Retrieves a list of people available for assignment as executive assistants to the specified person.\n\nAs an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Get Person Executive Assistant Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/assistant",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
]
},
"docs": "Get executive assistant settings for the specified person when person is configured as executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Person Executive Assistant Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/assistant",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive assistant settings for the specified person when person is configured as executive assistant.\n\nExecutive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.\nAssistants can also set the call forwarding destination, and join or leave an executive’s pool.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Person Executive Screening Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/screening",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
]
},
"docs": "Get executive screening settings for the specified person.\n\nExecutive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.\n\nThis API requires a full, user, read-only or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Person Executive Screening Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId/executive/screening",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8wZTQ5NjAzNC1lNTQ1LTRmMmEtODI4ZC03MjhjYjJlNjNlMWQ",
"type": "path",
"description": "A unique identifier for the person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID for the person."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update executive screening settings for the specified person.\n\nExecutive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences. You can enable or disable executive screening and configure alert types and locations for notifications.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Timezone and Announcement Language Settings of a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81Y2Y1NmJkMS1hMzU4LTQzYWQtODY5Ni0xM2E2NzliNGUyNGY",
"type": "path",
"description": "Retrieve timezone and announcement language settings of this person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID. If not specified, uses the organization from the OAuth token."
}
]
},
"docs": "Retrieve a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Update Timezone and Announcement Language Settings of a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/people/:personId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS81Y2Y1NmJkMS1hMzU4LTQzYWQtODY5Ni0xM2E2NzliNGUyNGY",
"type": "path",
"description": "Modify timezone and announcement language settings of this person."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID. If not specified, uses the organization from the OAuth token."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a person's timezone and announcement language settings.\n\nWebex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.\n\nThis API requires a full administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Get Country Calling Configuration",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/countries/:countryCode",
"params": [
{
"name": "countryCode",
"value": "US",
"type": "path",
"description": "The ISO country code to retrieve configuration for."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Organization ID. If not specified, uses the organization from the OAuth token."
}
]
},
"docs": "Retrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones.\n\nThis information helps administrators configure user settings with valid timezone and location data for a specific country.\n\nThis API requires a full or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
}
]
},
{
"info": {
"name": "User Call Settings (1/2)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Modify a person's Application Services Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/applications",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Application services let you determine the ringing behavior for calls made to users in certain scenarios. You can also specify which devices users can download the Webex Calling app on.\n\nThis API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope."
},
{
"info": {
"name": "Read Barge In Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/bargeIn",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their own settings."
},
{
"info": {
"name": "Configure Barge In Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/bargeIn",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person'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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their own settings."
},
{
"info": {
"name": "Read Forwarding Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/callForwarding",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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 person 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 not connected "
},
{
"info": {
"name": "Configure Call Forwarding Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/callForwarding",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person'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 person 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 not connected"
},
{
"info": {
"name": "Read Call Intercept Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/intercept",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 Person's Call Intercept settings.\n\nThe intercept feature gracefully takes a person'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 person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nThis API requires a full, user, or read-only administrator or location"
},
{
"info": {
"name": "Configure Call Intercept Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/intercept",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Call Intercept settings.\n\nThe intercept feature gracefully takes a person'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 person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nThis API requires a full or user administrator or location administ"
},
{
"info": {
"name": "Configure Call Intercept Greeting for a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people/:personId/features/intercept/actions/announcementUpload/invoke",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings."
},
{
"info": {
"name": "Read Call Recording Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/callRecording",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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 or location administrator auth token with the `spark-admin:people_read` scope.\n\nA person with a Webex Calling Standard license is eligible for the Call Reco"
},
{
"info": {
"name": "Configure Call Recording Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/callRecording",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person'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 or location administrator auth token with the `spark-admin:people_write` scope.\n\nA person with a Webex Calling Standard license is eligible for the Call Re"
},
{
"info": {
"name": "Read Call Waiting Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/callWaiting",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Call Waiting settings.\n\nWith this feature, a person 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\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Call Waiting Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/callWaiting",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Call Waiting settings.\n\nWith this feature, a person 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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Read Caller ID Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/callerId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Caller ID Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/callerId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Caller ID settings.\n\nCaller ID settings control how a person's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Read Person's Calling Behavior",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/callingBehavior",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the calling behavior and UC Manager Profile settings for the person which includes overall calling behavior and calling UC Manager Profile ID.\n\nWebex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person.\n\nAn organization has an organization-wide default Calling Behavior that may be overridden for individual persons.\n\nUC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Web"
},
{
"info": {
"name": "Configure a person's Calling Behavior",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/callingBehavior",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Modifies the calling behavior settings for the person which includes calling behavior and UC Manager Profile ID.\n\nWebex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person.\n\nAn organization has an organization-wide default Calling Behavior that may be overridden for individual persons.\n\nUC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex (Unified CM).\n\nThe UC Manager Profile"
},
{
"info": {
"name": "Read Do Not Disturb Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/doNotDisturb",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Do Not Disturb settings.\n\nWhen enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read` or a user auth token with `spark:people_read` scope can be used by a person to read their settings."
},
{
"info": {
"name": "Configure Do Not Disturb Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/doNotDisturb",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Do Not Disturb settings.\n\nWhen enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings."
},
{
"info": {
"name": "Retrieve Executive Assistant Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/executiveAssistant",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the executive assistant settings for the specified `personId`.\n\nPeople with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive's pool.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Modify Executive Assistant Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/executiveAssistant",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the executive assistant settings for the specified personId.\n\nPeople with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf. Executive assistants can set the call forward destination and join or leave an executive's pool.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Read Hoteling Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/hoteling",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's hoteling settings.\n\nAs an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Hoteling Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/hoteling",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's hoteling settings.\n\nAs an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Retrieve a person's Monitoring Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/monitoring",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the monitoring settings of the person, which shows specified people, places, virtual lines or call park extenions that are being monitored.\nMonitors the line status which indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Modify a person's Monitoring Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/monitoring",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Modifies the monitoring settings of the person.\nMonitors the line status of specified people, places, virtual lines or call park extension. The line status indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.\n\nThe number of monitored elements is limited to 50.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Read Incoming Permission Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/incomingPermission",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Incoming Permission settings.\n\nYou can change the incoming calling permissions for a person if you want them to be different from your organization's default.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Incoming Permission Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/incomingPermission",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Incoming Permission settings.\n\nYou can change the incoming calling permissions for a person if you want them to be different from your organization's default.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Retrieve a person's Outgoing Calling Permissions Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/outgoingPermission",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
]
},
"docs": "Retrieve a person'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 person if you want them to be different from your organization's default.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Modify a person's Outgoing Calling Permissions Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/outgoingPermission",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify a person'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 person if you want them to be different from your organization's default.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Get a List of Phone Numbers for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/numbers",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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."
},
{
"name": "preferE164Format",
"value": "true",
"type": "query",
"description": "Return phone numbers in E.164 format."
}
]
},
"docs": "Get a person's phone numbers including alternate numbers.\n\nA person can have one or more phone numbers and/or extensions via which they can be called.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_read` scope.\n\n
\n\nThe `preferE164Format` query parameter can be used to get phone numbers either in E.164 format or in their legacy format. The support for getting phone numbers in non-E.164 format in so"
},
{
"info": {
"name": "Get a person's Privacy Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/privacy",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Get a person's privacy settings for the specified person ID.\n\nThe privacy feature enables the person's line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:people_read."
},
{
"info": {
"name": "Configure a person's Privacy Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/privacy",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's privacy settings for the specified person ID.\n\nThe privacy feature enables the person's line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full or user administrator or location administrator auth token with the spark-admin:people_write scope."
},
{
"info": {
"name": "Read Push-to-Talk Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/pushToTalk",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Push-to-Talk Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/pushToTalk",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person'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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Read Receptionist Client Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/reception",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Receptionist Client settings.\n\nTo help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Configure Receptionist Client Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/reception",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Receptionist Client settings.\n\nTo help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "List of Schedules for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/schedules",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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."
},
{
"name": "start",
"value": "0",
"type": "query",
"description": "Specifies the offset from the first result that you want to fetch."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Specifies the maximum number of records that you want to fetch."
},
{
"name": "name",
"value": "dallas",
"type": "query",
"description": "Specifies the case insensitive substring to be matched against the schedule names. The maximum length is 40."
},
{
"name": "type",
"value": "businessHours",
"type": "query",
"description": "Specifies the schedule event type to be matched on the given type."
}
]
},
"docs": "List schedules for a person in an organization.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Create Schedule for a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people/:personId/features/schedules",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Create a new schedule for a person.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Get a Schedule Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"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 schedule by its schedule ID.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Update a Schedule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"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 schedule by its schedule ID.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Delete a Schedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"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": "Delete a schedule by its schedule ID.\n\nSchedules are used to support calling features and can be defined at the location or person level. `businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Fetch Event for a person's Schedule",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events/:eventId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow",
"type": "path",
"description": "Unique identifier for the event."
},
{
"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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full, user, or read-only administrator auth token with a scope of `spark-admin:people_read`."
},
{
"info": {
"name": "Update an Event for a person's Schedule",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events/:eventId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow",
"type": "path",
"description": "Unique identifier for the event."
},
{
"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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Delete an Event for a person's Schedule",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events/:eventId",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"name": "eventId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEVfRVZFTlQvUkdGNVgxTm9hV1ow",
"type": "path",
"description": "Unique identifier for the event."
},
{
"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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Add a New Event for Person's Schedule",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people/:personId/features/schedules/:scheduleType/:scheduleId/events",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"name": "scheduleType",
"value": "",
"type": "path",
"description": "Type of schedule, either `businessHours` or `holidays`."
},
{
"name": "scheduleId",
"value": "Y2lzY29zcGFyazovL3VzL1VTRVJfU0NIRURVTEUvUkdGc2JHRnpYMDltWm1salpWOUliM1Z5Y3c9PQ",
"type": "path",
"description": "Unique identifier for the schedule."
},
{
"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": "People can use shared location schedules or define personal schedules containing events.\n\n`businessHours` schedules allow you to apply specific call settings at different times of the day or week by defining one or more events. `holidays` schedules define exceptions to normal business hours by defining one or more events.\n\nThis API requires a full or user administrator auth token with the `spark-admin:people_write` scope."
},
{
"info": {
"name": "Read Voicemail Settings for a Person",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/people/:personId/features/voicemail",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person's Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full, user, or read-only administrator or location administrator auth token with a scope of `spark-admin"
},
{
"info": {
"name": "Configure Voicemail Settings for a Person",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/people/:personId/features/voicemail",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Configure a person's Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` sco"
},
{
"info": {
"name": "Configure Busy Voicemail Greeting for a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people/:personId/features/voicemail/actions/uploadBusyGreeting/invoke",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings."
},
{
"info": {
"name": "Configure No Answer Voicemail Greeting for a Person",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people/:personId/features/voicemail/actions/uploadNoAnswerGreeting/invoke",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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 person'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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope or a user auth token with `spark:people_write` scope can be used by a person to update their settings."
},
{
"info": {
"name": "Reset Voicemail PIN",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/people/:personId/features/voicemail/actions/resetPin/invoke",
"params": [
{
"name": "personId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the person."
},
{
"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": "Reset a voicemail PIN for a person.\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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:people_write` scope.\n\n**NOTE**: This API is expected to have an empty request body and Content-Type header should be set to `application/json`."
}
]
},
{
"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."
}
]
},
{
"info": {
"name": "Caller Reputation Provider",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Caller Reputation Provider Service Settings",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/serviceSettings/callerReputationProvider",
"params": [
{
"name": "organizationId",
"value": "",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieves the configuration and status of the caller reputation provider service for Webex Calling."
},
{
"info": {
"name": "Update Caller Reputation Provider Service Settings",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/serviceSettings/callerReputationProvider",
"params": [
{
"name": "organizationId",
"value": "",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the configuration of the caller reputation provider service for Webex Calling."
},
{
"info": {
"name": "Get Caller Reputation Provider Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/serviceSettings/callerReputationProvider/status",
"params": [
{
"name": "organizationId",
"value": "",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieves the current status of the caller reputation provider integration for Webex Calling."
},
{
"info": {
"name": "Unlock Caller Reputation Provider",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/serviceSettings/callerReputationProvider/actions/unlock/invoke",
"params": [
{
"name": "organizationId",
"value": "",
"type": "query",
"description": "Unique identifier for the organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Unlocks the caller reputation provider for Webex Calling."
},
{
"info": {
"name": "Get Caller Reputation Provider Providers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/serviceSettings/callerReputationProvider/providers",
"params": [
{
"name": "organizationId",
"value": "",
"type": "query",
"description": "Unique identifier for the organization."
}
]
},
"docs": "Retrieves the list of available caller reputation providers and their regions for Webex Calling."
}
]
},
{
"info": {
"name": "Workspace Call Settings (1/2)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve Call Forwarding Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/callForwarding",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Call Forwarding Settings for a Workspace.\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 person 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 not connect"
},
{
"info": {
"name": "Modify Call Forwarding Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/callForwarding",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 call forwarding settings for a Workspace.\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 person 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 not connected"
},
{
"info": {
"name": "Retrieve Call Waiting Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/callWaiting",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Call Waiting Settings for a Workspace.\n\nCall Waiting allows workspaces to handle multiple simultaneous calls. Workspaces with Call Waiting enabled can place a call on hold to answer or initiate another call.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings."
},
{
"info": {
"name": "Modify Call Waiting Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/callWaiting",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Call Waiting Settings for a Workspace.\n\nCall Waiting allows workspaces to handle multiple simultaneous calls. Workspaces with Call Waiting enabled can place a call on hold to answer or initiate another call.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Read Caller ID Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/callerId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings."
},
{
"info": {
"name": "Configure Caller ID Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/callerId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 workspace's Caller ID settings.\n\nCaller ID settings control how a workspace's information is displayed when making outgoing calls.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Retrieve Monitoring Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/monitoring",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Retrieves Monitoring settings for a Workspace.\n\nAllow workspaces to monitor the line status of specified agents, workspaces, or call park extensions. The line status indicates if a monitored agent or a workspace is on a call, or if a call has been parked on the monitored call park extension.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to "
},
{
"info": {
"name": "Modify Monitoring Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/monitoring",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Monitoring settings for a Workspace.\n\nAllow workspaces to monitor the line status of specified agents, workspaces, or call park extensions. The line status indicates if a monitored agent or a workspace is on a call, or if a call has been parked on the monitored call park extension.\n\nThe number of monitored elements is limited to 50.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `"
},
{
"info": {
"name": "List numbers associated with a specific workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/numbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "path",
"description": "List numbers for this workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Workspace is in this organization. Only admin users of another organization (such as partners) can use this parameter as the default is the same organization as the token used to access the API."
}
]
},
"docs": "List the PSTN phone numbers associated with a specific workspace, by ID, within the organization. Also shows the location and organization associated with the workspace.\n\nRetrieving this list requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read`."
},
{
"info": {
"name": "Retrieve Incoming Permission Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/incomingPermission",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Incoming Permission settings for a Workspace.\n\nIncoming permission settings allow modifying permissions for a workspace that can be different from the organization's default to manage different call types.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings."
},
{
"info": {
"name": "Modify Incoming Permission Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/incomingPermission",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Incoming Permission settings for a Workspace.\n\nIncoming permission settings allow modifying permissions for a workspace that can be different from the organization's default to manage different call types.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Retrieve Outgoing Permission Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Outgoing Permission settings for a Workspace.\n\nTurn on outgoing call settings for this workspace to override the calling settings from the location that are used by default.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings."
},
{
"info": {
"name": "Modify Outgoing Permission Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Outgoing Permission settings for a Place.\n\nTurn on outgoing call settings for this workspace to override the calling settings from the location that are used by default.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Retrieve Access Codes for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission/accessCodes",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Access codes for a Workspace.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings."
},
{
"info": {
"name": "Create Access Codes for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission/accessCodes",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 new Access codes for the given workspace.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Modify Access Codes for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission/accessCodes",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Access codes for a workspace.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Delete all Access Codes for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission/accessCodes",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 given workspace.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to update workspace settings."
},
{
"info": {
"name": "Read Call Intercept Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/intercept",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Retrieves Workspace's Call Intercept Settings\n\nThe intercept feature gracefully takes a workspace'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 workspace are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nThis API requires a full or read-only administrator or locatio"
},
{
"info": {
"name": "Configure Call Intercept Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/intercept",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Configures a Workspace's Call Intercept Settings\n\nThe intercept feature gracefully takes a workspace'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 person are intercepted. Also depending on the service configuration, outgoing calls are intercepted or rerouted to another location.\n\nThis API requires a full or read-only administrator or locatio"
},
{
"info": {
"name": "Retrieve Transfer Numbers Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission/autoTransferNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Transfer Numbers Settings for a Workspace.\n\nWhen calling a specific call type, this workspace will be automatically transferred to another number. The person 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 read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be "
},
{
"info": {
"name": "Modify Transfer Numbers Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId/features/outgoingPermission/autoTransferNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Transfer Numbers Settings for a place.\n\nWhen calling a specific call type, this workspace will be automatically transferred to another number. The person 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 or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with `spark:workspaces_write` scope can be used to up"
}
]
},
{
"info": {
"name": "Workspace Call Settings (2/2)",
"type": "folder"
},
"items": [
{
"info": {
"name": "Retrieve Music On Hold Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/musicOnHold",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 the API."
}
]
},
"docs": "Retrieve Music On Hold Settings for a Workspace.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nRetrieving a workspace's music on hold settings requires a full, device or read-only administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify Music On Hold Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/musicOnHold",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 the API."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify music on hold settings for a Workspace.\n\nMusic on hold is played when a caller is put on hold, or the call is parked.\n\nTo configure music on hold setting for a workspace, music on hold setting must be enabled for this location.\n\nThis API requires a full or device administrator or location administrator auth token with the `spark-admin:telephony_config_write` scope."
},
{
"info": {
"name": "Delete a Specific Access Code for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/accessCodes/:accessCode",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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."
},
{
"name": "accessCode",
"value": "1234",
"type": "path",
"description": "Access code for outgoing calls."
}
]
},
"docs": "Deletes a specific access code for the given workspace.\n\nAccess codes are used to bypass permissions.\n\nThis API requires a full, device or location administrator auth token with the scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve all Digit Patterns for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 all digit patterns for a Workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Create Digit Pattern for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 digit pattern for the given workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Modify the Digit Pattern Category Control Settings for the Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Modifies whether this workspace uses the specified digit patterns when placing outbound calls or not.\n\nUpdating the digit pattern category control settings requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete all Digit Patterns for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete all digit patterns for a Workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve a Digit Pattern details for the Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "digitPatternId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"type": "path",
"description": "Unique identifier for the digit pattern."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 designated digit pattern.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:telephony_config_read`."
},
{
"info": {
"name": "Modify a Digit Pattern for the Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "digitPatternId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"type": "path",
"description": "Unique identifier for the digit pattern."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 the designated digit pattern.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Delete a Digit Pattern for the Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/outgoingPermission/digitPatterns/:digitPatternId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzFkNjAzZTljLWJmM2QtNDA5OS05MGFiLTkyZWFlZWE3MjEzNw",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "digitPatternId",
"value": "Y2lzY29zcGFyazovL3VzL1NDSEVEVUxFL1FWVlVUMEZVVkVWT1JFRk9WQzFDVlZOSlRrVlRVeTFJVDFWU1V3",
"type": "path",
"description": "Unique identifier for the digit pattern."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete a digit pattern for a Workspace.\n\nDigit patterns are used to bypass permissions.\n\nThis API requires a full or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Upload Call Intercept Announcement file for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/intercept/actions/announcementUpload/invoke",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Create an announcement in this organization."
},
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
}
]
},
"docs": "Upload call intercept announcement file for a workspace.\n\nThe upload announcement feature for a call intercept is used to play custom announcements for a workspace.\n\nYour request will need to be a `multipart/form-data` request rather than JSON, using the `audio/wav` Content-Type.\n\nThis API requires a full, device or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve Call Recording Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/callRecordings",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 call recording settings for a workspace.\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, read-only, device or location administrator auth token with the `spark-admin:telephony_config_read` scope."
},
{
"info": {
"name": "Modify Call Recording Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/features/callRecordings",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 call forwarding settings for a workspace.\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\nThe vendor's terms of service have to be accepted to enable call recording. Vendor details along with the terms of service URL are shared when the vendor's terms of service are not accepted yet.\n\nThis API requires a full, device"
},
{
"info": {
"name": "Get Workspace Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/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 workspace's phone number.\nBy default, this API returns numbers from all locations that are unassigned. To select the suitable number for assignment, ensure the workspace'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 fu"
},
{
"info": {
"name": "Get Workspace ECBN Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/emergencyCallbackNumber/availableNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 are available to be assigned as a workspace's emergency callback number.\nThese numbers are associated with the location of the workspace 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 or location administrat"
},
{
"info": {
"name": "Get Workspace Call Forward Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callForwarding/availableNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 workspace's call forward number.\nThese numbers are associated with the location of the workspace 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 or locat"
},
{
"info": {
"name": "Get Workspace Call Intercept Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callIntercept/availableNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 workspace's call intercept number.\nThese numbers are associated with the location of the workspace 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 or loc"
},
{
"info": {
"name": "Retrieve Anonymous Call Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/anonymousCallReject",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Anonymous Call Settings for a Workspace.\n\nAnonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Modify Anonymous Call Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/anonymousCallReject",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Anonymous Call Settings for a Workspace.\n\nAnonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Retrieve Barge In Call Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/bargeIn",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Barge In Call Settings for a Workspace.\n\nBarge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed wo"
},
{
"info": {
"name": "Modify Barge In Call Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/bargeIn",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Barge In Call Settings for a Workspace.\n\nBarge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed worksp"
},
{
"info": {
"name": "Retrieve DoNotDisturb Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/doNotDisturb",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 DoNotDisturb Settings for a Workspace.\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 `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is available for professional and common area licensed workspaces."
},
{
"info": {
"name": "Modify DoNotDisturb Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/doNotDisturb",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 DoNotDisturb Settings for a Workspace.\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:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional and common area licensed workspaces."
},
{
"info": {
"name": "Retrieve Call Bridge Warning Tone Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callBridge",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Call Bridge Warning Tone Settings for a Workspace.\n\nCall Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with `spark:workspaces_read` scope can be used to read workspace settings.\n\n**NOTE**: This API is only available for profes"
},
{
"info": {
"name": "Modify Call Bridge Warning Tone Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callBridge",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Call Bridge Warning Tone Settings for a Workspace.\n\nCall Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Read Push-to-Talk Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/pushToTalk",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 Push-to-Talk settings for a workspace.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Configure Push-to-Talk Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/pushToTalk",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 Push-to-Talk settings for a workspace.\n\nPush-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Retrieve Privacy Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/privacy",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Privacy Settings for a Workspace.\n\nThe privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` scope to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Modify Privacy Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/privacy",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Privacy Settings for a Workspace.\n\nThe privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Read Voicemail Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 workspace Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:works"
},
{
"info": {
"name": "Configure Voicemail Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 workspace Voicemail settings.\n\nThe voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, `.wav`, format.\n\nOptionally, notifications can be sent to a mobile phone via text or email. These notifications will not include the voicemail files.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write"
},
{
"info": {
"name": "Modify Voicemail Passcode for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:placeId/voicemail/passcode",
"params": [
{
"name": "placeId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzU2ZGIyNGQzLTdhN2EtNDBhMi05YWM5LWIyMzMyNzc5MjFO77+9",
"type": "path",
"description": "Modify voicemail passcode for this workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "Modify voicemail passcode for a workspace in this organization."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Modify voicemail passcode for a workspace.\n\nModifying the voicemail passcode for a workspace requires a full administrator, device administrator or location administrator auth token with a scope of `spark-admin:telephony_config_write`."
},
{
"info": {
"name": "Retrieve Sequential Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings.\n\n**N"
},
{
"info": {
"name": "Modify Sequential Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**: This"
},
{
"info": {
"name": "Delete Sequential Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings.\n\n**NOT"
},
{
"info": {
"name": "Read Call Policy Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callPolicies",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 workspace Call Policies settings.\n\nThe call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.\n\nThis API requires a full or read-only administrator or location administrator auth token with a scope of `spark-admin:workspaces_read` scope can be used to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Configure Call Policy Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/callPolicies",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 workspace Call Policies settings.\n\nThe call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Configure Busy Voicemail Greeting for a Place",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail/actions/uploadBusyGreeting/invoke",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Configure a workspace'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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Configure No Answer Voicemail Greeting for a Place",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/voicemail/actions/uploadNoAnswerGreeting/invoke",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Configure a workspace'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\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Create Sequential Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing/criteria",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 sequential ring criteria for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\nThe sequential ring criteria specify settings such as schedule and incoming numbers for which to sequentially ring or not.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**: This"
},
{
"info": {
"name": "Retrieve Sequential Ring Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 sequential ring settings for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Modify Sequential Ring Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/sequentialRing",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 sequential ring settings for a workspace.\n\nThe sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Retrieve Simultaneous Ring Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Simultaneous Ring Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSchedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOT"
},
{
"info": {
"name": "Modify Simultaneous Ring Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Simultaneous Ring Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure the workspace phones of your choice to ring simultaneously.\nSchedules can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is o"
},
{
"info": {
"name": "Retrieve Simultaneous Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Simultaneous Ring Criteria Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_re"
},
{
"info": {
"name": "Modify Simultaneous Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Simultaneous Ring Criteria Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to"
},
{
"info": {
"name": "Delete Simultaneous Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete simultaneous ring criteria Settings for a workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to"
},
{
"info": {
"name": "Create Simultaneous Ring Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/simultaneousRing/criteria",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Simultaneous Ring Criteria Settings for a Workspace.\n\nThe Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.\nSimultaneous Ring Criteria (Schedules) can also be set up to ring these phones during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to"
},
{
"info": {
"name": "Retrieve Selective Reject Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Reject Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read w"
},
{
"info": {
"name": "Modify Selective Reject Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Reject Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update works"
},
{
"info": {
"name": "Retrieve Selective Reject Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Reject Criteria Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` "
},
{
"info": {
"name": "Modify Selective Reject Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Reject Criteria Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd"
},
{
"info": {
"name": "Delete Selective Reject Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete Selective Reject criteria Settings for a workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd"
},
{
"info": {
"name": "Create Selective Reject Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveReject/criteria",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Reject Criteria Settings for a Workspace.\n\nWith the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd"
},
{
"info": {
"name": "Assign or Unassign numbers associated with a specific workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/numbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Assign or unassign alternate phone numbers associated with a specific workspace.\n\nEach location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format for all countries, except for the United States, which can also follow the National format. Active phone numbers are in service.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` to update workspace settings.\n\n**NOTE**"
},
{
"info": {
"name": "Retrieve Selective Accept Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Accept Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for "
},
{
"info": {
"name": "Modify Selective Accept Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Accept Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available for prof"
},
{
"info": {
"name": "Retrieve Selective Accept Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Accept Criteria Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only avail"
},
{
"info": {
"name": "Modify Selective Accept Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Accept Criteria Settings for a Workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available "
},
{
"info": {
"name": "Delete Selective Accept Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete Selective Accept criteria Settings for a workspace.\n\nWith the Selective Accept feature, you can accept calls at specific times from specific callers.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspace settings.\n\n**NOTE**: This API is only available"
},
{
"info": {
"name": "Create Selective Accept Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveAccept/criteria",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Accept Criteria Settings for a Workspace.\n\nWith the Selective Accept feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upd"
},
{
"info": {
"name": "Retrieve Priority Alert Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Priority Alert Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Configure Priority Alert Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS8xMWEzZjk5MC1hNjg5LTQ3N2QtYmU2Yi03MTIwMDI1ZDhhYmI",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization in which the workspace 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 workspace Priority Alert Settings.\n\nThe priority alert feature enables administrator to configure priority alert settings for a professional workspace.\n\nThis API requires a full or user administrator or location administrator auth token with the `spark-admin:workspaces_write` scope that can be used to update workspace settings.\n\n**NOTE**: This API is only available for professional licensed workspaces."
},
{
"info": {
"name": "Retrieve Priority Alert Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Priority Alert Criteria Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read workspac"
},
{
"info": {
"name": "Modify Priority Alert Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Priority Alert Criteria Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspa"
},
{
"info": {
"name": "Delete Priority Alert Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete Priority Alert criteria Settings for a workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspa"
},
{
"info": {
"name": "Create Priority Alert Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/priorityAlert/criteria",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Priority Alert Criteria Settings for a Workspace.\n\nThe priority alert feature enables administrators to configure priority alert settings for a professional workspace.\nPriority Alert Criteria (Schedules) can also be set up to alert these phones during certain times of the day or days of the week.\n\nThis API requires a full, user, or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update workspa"
},
{
"info": {
"name": "Retrieve Selective Forward Settings for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Forward Call Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to read wo"
},
{
"info": {
"name": "Modify Selective Forward Settings for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Forward Call Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to update worksp"
},
{
"info": {
"name": "Retrieve Selective Forward Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Forward Criteria Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, read-only or location administrator auth token with a scope of `spark-admin:workspaces_read` or a user auth token with a scope of `spark:workspaces_read` to rea"
},
{
"info": {
"name": "Modify Selective Forward Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Forward Call Criteria Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upda"
},
{
"info": {
"name": "Delete Selective Forward Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria/:id",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "id",
"value": "Y2lzY29zcGFyazovL3VzL0NSSVRFUklBLzg2NTAxZDFlLTg1MWMtNDgwYi1hZmE2LTA5MTU4NzQ3NzdmZQ",
"type": "path",
"description": "Unique identifier for the criteria."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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": "Delete Selective Forward Call criteria Settings for a workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upda"
},
{
"info": {
"name": "Create Selective Forward Criteria for a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/selectiveForward/criteria",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "ID of the organization within which the workspace 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 Selective Forward Call Criteria Settings for a Workspace.\n\nWith the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.\nSchedules can also be set up for this feature during certain times of the day or days of the week.\n\nThis API requires a full, user or location administrator auth token with the `spark-admin:workspaces_write` scope or a user auth token with a scope of `spark:workspaces_write` to upda"
},
{
"info": {
"name": "Get Workspace Fax Message Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/faxMessage/availableNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 workspace's FAX message number.\nThese numbers are associated with the location of the workspace 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 token with a scop"
},
{
"info": {
"name": "Get Workspace Secondary Available Phone Numbers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/telephony/config/workspaces/:workspaceId/secondary/availableNumbers",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9QTEFDRS8xNzdmNTNlZC1hNzY2LTRkYTAtOGQ3OC03MjE0MjhjMmFjZTQ=",
"type": "path",
"description": "Unique identifier for the workspace."
},
{
"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 workspace's secondary number.\nThese numbers are associated with the location of the workspace 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 token with a scope "
}
]
},
{
"info": {
"name": "Workspaces",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Workspaces",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces",
"params": [
{
"name": "orgId",
"value": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"type": "query",
"description": "List workspaces in this organization. Only admin users of another organization (such as partners) may use this parameter."
},
{
"name": "locationId",
"value": "YL34GrT...",
"type": "query",
"description": "Location associated with the workspace. Values must originate from the /locations API and not the legacy /workspaceLocations API."
},
{
"name": "workspaceLocationId",
"value": "YL34GrT...",
"type": "query",
"description": "Location associated with the workspace. Both values from the /locations API and the legacy /workspaceLocations API are supported. This field is deprecated and integrations should prefer `locationId` going forward."
},
{
"name": "floorId",
"value": "Y2lzY29z...",
"type": "query",
"description": "Floor associated with the workspace."
},
{
"name": "displayName",
"value": "SFO-12 Capanina",
"type": "query",
"description": "List workspaces by display name."
},
{
"name": "capacity",
"value": "5",
"type": "query",
"description": "List workspaces with the given capacity. Must be -1 or higher. A value of -1 lists workspaces with no capacity set."
},
{
"name": "type",
"value": "focus",
"type": "query",
"description": "List workspaces by type."
},
{
"name": "start",
"value": "50",
"type": "query",
"description": "Offset. Default is 0."
},
{
"name": "max",
"value": "100",
"type": "query",
"description": "Limit the maximum number of workspaces in the response."
},
{
"name": "calling",
"value": "freeCalling",
"type": "query",
"description": "List workspaces by calling type."
},
{
"name": "supportedDevices",
"value": "collaborationDevices",
"type": "query",
"description": "List workspaces by supported devices."
},
{
"name": "calendar",
"value": "none",
"type": "query",
"description": "List workspaces by calendar type."
},
{
"name": "deviceHostedMeetingsEnabled",
"value": "true",
"type": "query",
"description": "List workspaces enabled for device hosted meetings."
},
{
"name": "devicePlatform",
"value": "cisco",
"type": "query",
"description": "List workspaces by device platform."
},
{
"name": "healthLevel",
"value": "error",
"type": "query",
"description": "List workspaces by health level."
},
{
"name": "includeDevices",
"value": "false",
"type": "query",
"description": "Flag identifying whether to include the devices associated with the workspace in the response."
},
{
"name": "includeCapabilities",
"value": "false",
"type": "query",
"description": "Flag identifying whether to include the workspace capabilities in the response."
},
{
"name": "plannedMaintenance",
"value": "off",
"type": "query",
"description": "List workspaces with given maintenance mode."
},
{
"name": "customAttribute",
"value": "myKey",
"type": "query",
"description": "List workspaces with given custom attribute key."
}
]
},
"docs": "List workspaces.\n\nUse query parameters to filter the response. The `orgId` parameter can only be used by admin users of another organization (such as partners). The `locationId`, `workspaceLocationId`, `indoorNavigation`, `floorId`, `capacity` and `type` fields will only be present for workspaces that have a value set for them. The special values `notSet` (for filtering on category) and `-1` (for filtering on capacity) can be used to filter for workspaces without a type and/or capacity."
},
{
"info": {
"name": "Create a Workspace",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/workspaces",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a workspace.\n\nThe `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type`, `notes` and `hotdeskingStatus` parameters are optional, and omitting them will result in the creation of a workspace without these values set, or set to their default. A `locationId` must be provided when the `floorId` is set. Calendar and calling can also be set for a new workspace. Omitting them will default to free calling and no calendaring. The `orgId` parameter can only be used "
},
{
"info": {
"name": "Get Workspace Details",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"type": "path",
"description": "A unique identifier for the workspace."
},
{
"name": "includeDevices",
"value": "false",
"type": "query",
"description": "Flag identifying whether to include the devices associated with the workspace in the response."
},
{
"name": "includeCapabilities",
"value": "false",
"type": "query",
"description": "Flag identifying whether to include the workspace capabilities in the response."
}
]
},
"docs": "Shows details for a workspace, by ID.\n\nThe `locationId`, `workspaceLocationId`, `floorId`, `indoorNavigation`, `capacity`, `type` and `notes` fields will only be present if they have been set for the workspace. Specify the workspace ID in the `workspaceId` parameter in the URI."
},
{
"info": {
"name": "Update a Workspace",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/workspaces/:workspaceId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"type": "path",
"description": "A unique identifier for the workspace."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates details for a workspace by ID.\n\nSpecify the workspace ID in the `workspaceId` parameter in the URI. Include all details for the workspace that are present in a [GET request for the workspace details](/docs/api/v1/workspaces/get-workspace-details). Not including the optional `capacity`, `type` or `notes` fields will result in the fields no longer being defined for the workspace. A `locationId` must be provided when the `floorId` is set. The `locationId`, `workspaceLocationId`, `floorId`, "
},
{
"info": {
"name": "Delete a Workspace",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/workspaces/:workspaceId",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"type": "path",
"description": "A unique identifier for the workspace."
}
]
},
"docs": "Deletes a workspace by ID.\n\nAlso deletes all devices associated with the workspace. Any deleted devices will need to be reactivated. Specify the workspace ID in the `workspaceId` parameter in the URI."
},
{
"info": {
"name": "Get Workspace Capabilities",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/workspaces/:workspaceId/capabilities",
"params": [
{
"name": "workspaceId",
"value": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"type": "path",
"description": "A unique identifier for the workspace."
}
]
},
"docs": "Shows the capabilities for a workspace by ID.\n\nReturns a set of capabilities, including whether or not the capability is supported by any device in the workspace, and if the capability is configured (enabled). For example for a specific capability like `occupancyDetection`, the API will return if the capability is supported and/or configured such that occupancy detection data will flow from the workspace (device) to the cloud. Specify the workspace ID in the `workspaceId` parameter in the URI."
}
]
}
],
"bundled": true
}