Modify Screen Pop configuration for a Call Queue in a Location
Screen pop lets agents view customer-related info in a pop-up window. This API allows you to modify the screen pop configuration for a call queue in a location.
PUT/v1/telephony/config/locations/{locationId}/queues/{queueId}/cxEssentials/screenPop?orgId={orgId}
URI Parameters
locationId
string
The location ID where the call queue resides.
queueId
string
The call queue ID for which screen pop configuration is modified.
orgId
string
The organization ID of the customer or partner's organization.
Body Parameters
enabled
boolean
Enable/disable screen pop.
screenPopUrl
string
The screen pop URL that integrates Webex calls with other business apps like CRM, ticketing tools, and order entry systems.
desktopLabel
string
A label for the screen pop configuration.
queryParams
QueryParamsObject
The additional user-defined key-value pairs that must be sent to the agent.
example_param_1
string
An example key-value pair that will be sent to the agent.
example_param_2
string
Another example key-value pair that will be sent to the agent.
example_param_3
string
Another example key-value pair that will be sent to the agent.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
PUT
/v1/telephony/config/locations//queues//cxEssentials/screenPop?={orgId}
Log in to try the API.
Header
Body
- Enable/disable screen pop.
- The screen pop URL that integrates Webex calls with other business apps like CRM, ticketing tools, and order entry systems.
- A label for the screen pop configuration.
- The additional user-defined key-value pairs that must be sent to the agent.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzVlZmI5MTFhLThmNmUtNGU2Ny1iOTZkLWNkM2VmNmRhNDE2OA/queues/Y2lzY29zcGFyazovL3VzL0NBTExfUVVFVUUvYUhaaFpUTjJNRzh5YjBBMk5EazBNVEk1Tnk1cGJuUXhNQzVpWTJ4a0xuZGxZbVY0TG1OdmJRPT0/cxEssentials/screenPop?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE
{
"enabled": true,
"screenPopUrl": "http://localhost:8086/screenpop",
"desktopLabel": "example screen pop",
"queryParams": {
"example-parameter-1": "example-value-1",
"example-parameter-2": "example-value-2"
}
}
204 / No Content