Get Details for a Call Pickup
Retrieve Call Pickup details.
Call Pickup enables a user(agent) to answer any ringing line within their pickup group.
Retrieving call pickup details requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
NOTE: The Call Pickup ID will change upon modification of the Call Pickup name.
URI Parameters
Retrieve settings for a call pickup in this location.
Retrieve settings for a call pickup with the matching ID.
Query Parameters
Retrieve call pickup settings from this organization.
Response Properties
A unique identifier for the call pickup.
Unique name for the call pickup. The maximum length is 80.
People, including workspaces, that are eligible to receive calls.
ID of person or workspace.
First name of person or workspace.
Last name of person or workspace.
Display name of person or workspace.
Type of the person or workspace.
Indicates that this object is a user.
Indicates that this object is a place.
Email of the person or workspace.
List of phone numbers of the person or workspace.
Phone number of person or workspace.
Extension of person or workspace.
Flag to indicate primary phone.
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. |
| 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. |
Header
Query Parameters
- Retrieve call pickup settings from this organization.
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
"name": "South Alaska-Group",
"agents": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE2NmE",
"firstName": "John",
"lastName": "Brown",
"displayName": "johnBrown",
"type": "PEOPLE",
"email": "john.brown@gmail.com",
"numbers": [
{
"external": "+19075552859"
"extension":"8080"
"primary": "true"
}
]
},
{
"id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ",
"firstName": "Christian",
"lastName": "Smith",
"displayName": "ChristianS",
"type": "PEOPLE",
"email": "christians@gmail.com",
"numbers": [
{
"external": "+19075553859"
"extension":"8081"
"primary": "true"
}
]
}
]
}