Create a Call Pickup
Create new Call Pickups for the given location.
Call Pickup enables a user (agent) to answer any ringing line within their pickup group.
Creating a call pickup requires a full administrator or location administrator auth token with a scope of spark-admin:telephony_config_write.
NOTE: The Call Pickup ID will change upon modification of the Call Pickup name.
URI Parameters
Create the call pickup for this location.
Query Parameters
Create the call pickup for this organization.
Body Parameters
Unique name for the call pickup. The maximum length is 80.
Type of the notification when an incoming call is unanswered. The call pickup group notifies all of its members. Default: NONE.
Notification is not sent to any member of the call pickup group.
When the notificationDelayTimerSeconds number of seconds has elapsed, play an audio notification for each call pickup group member.
When the notificationDelayTimerSeconds number of seconds has elapsed, provide a visual notification to every call pickup group member.
When the notificationDelayTimerSeconds number of seconds has elapsed, provide an audio and visual notification to every call pickup group member.
After the number of seconds given by the notificationDelayTimerSeconds has elapsed, notify every member of the call pickup group when an incoming call goes unanswered. The notificationType field specifies the notification method. Default: 6.
An Array of ID strings of people, workspaces and virtual lines that are added to call pickup.
Response Properties
ID of the newly created call pickup.
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. |
Header
Query Parameters
- Create the call pickup for this organization.
Body
- Unique name for the call pickup. The maximum length is 80.
- Type of the notification when an incoming call is unanswered. The call pickup group notifies all of its members. Default: NONE.
- After the number of seconds given by the `notificationDelayTimerSeconds` has elapsed, notify every member of the call pickup group when an incoming call goes unanswered. The `notificationType` field specifies the notification method. Default: 6.
- An Array of ID strings of people, workspaces and virtual lines that are added to call pickup.
{
"name": "South Alaska-Group",
"notificationType": "AUDIO_ONLY",
"notificationDelayTimerSeconds": 20,
"agents": [
"Y2lzY29zcGFyazovL3VzL1BFT1BMRS80YTc2ZmVmNC1mZjlmLTExZWItYWYwZC00M2YwZjY1NTdjYWI",
"Y2lzY29zcGFyazovL3VzL1BMQUNFLzU1YjUyZThhLWZmOWYtMTFlYi05ZjRhLTAzZDY1NzdhYzg1Yg",
"Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS85ODFlNTQ0Yy0xOGI0LTQ2MzItYmFkZi1iYWMwZjFkOGJkYWY="]
}
{
"id": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0"
}