{ "opencollection": "1.0.0", "info": { "name": "Webex Admin Address Book Features: Call Queue API", "version": "1.0.0" }, "items": [ { "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`." } ] } ], "bundled": true }