Features: Call Pickup - Get Details for a Call Pickup

Get Details for a Call Pickup

Retrieve the designated 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 or location 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.

GET/v1/telephony/config/locations/{locationId}/callPickups/{callPickupId}

URI Parameters

locationId

stringrequired

Retrieve settings for a call pickup in this location.

callPickupId

stringrequired

Retrieve settings for a call pickup with the matching ID.

Query Parameters

orgId

string

Retrieve call pickup settings from this organization.

Response Properties

string

A unique identifier for the call pickup.

name

string

Unique name for the call pickup. The maximum length is 80.

notificationType

enum

Type of the notification when an incoming call is unanswered. The call pickup group notifies all of its members. Default: NONE.

NONE

string

Notification is not sent to any member of the call pickup group.

AUDIO_ONLY

string

When the notificationDelayTimerSeconds number of seconds has elapsed, play an audio notification for each call pickup group member.

VISUAL_ONLY

string

When the notificationDelayTimerSeconds number of seconds has elapsed, provide a visual notification to every call pickup group member.

AUDIO_AND_VISUAL

string

When the notificationDelayTimerSeconds number of seconds has elapsed, provide an audio and visual notification to every call pickup group member.

notificationDelayTimerSeconds

number

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.

agents

array[GetPersonPlaceVirtualLineCallPickupObject]

People, workspaces and virtual lines that are eligible to receive calls.

string

ID of a person, workspace or virtual line.

firstName

string

First name of a person, workspace or virtual line.

lastName

string

Last name of a person, workspace or virtual line.

displayName

string

Display name of a person, workspace or virtual line.

type

enum

Type of the person, workspace or virtual line.

PEOPLE

string

Indicates that this object is a user.

PLACE

string

Indicates that this object is a place.

VIRTUAL_LINE

string

Indicates that this object is a virtual line.

string

Email of a person, workspace or virtual line.

phoneNumber

array[GetUserNumberItemObject]

List of phone numbers of a person, workspace or virtual line.

external

string

Phone number of a person or workspace.

extension

string

Extension of a person or workspace.

routingPrefix

string

Routing prefix of location.

esn

string

Routing prefix + extension of a person or workspace.

primary

boolean

Flag to indicate a 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.
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.

GET

/v1/telephony/config/locations//callPickups/{?orgId}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

orgId
string
Retrieve call pickup settings from this organization.

https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzhmZjMwMjg5LWVhMzMtNDc1Ny1iMTBmLWQ2MWIyNzFhMDVlZg/callPickups/Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE

200 / OK

{
    "id": "Y2lzY29zcGFyazovL3VzL0NBTExfUElDS1VQL1kyRnNiRkJwWTJ0MWNEST0",
    "name": "South Alaska-Group",
    "notificationType": "AUDIO_ONLY",
    "notificationDelayTimerSeconds": 20,
    "agents": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS80NDVkMzMzMC1mNjE3LTExZWItOWQyZS01NzViODE3ZGE2NmE",
            "firstName": "John",
            "lastName": "Brown",
            "displayName": "johnBrown",
            "type": "PEOPLE",
            "email": "john.brown@example.com",
            "numbers": [
                {
                    "external": "+19075552859",
                    "extension":"8080",
                    "routingPrefix": "1234",
                    "esn": "12348080",
                    "primary": "true"
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ",
            "firstName": "Christian",
            "lastName": "Smith",
            "displayName": "ChristianS",
            "type": "PEOPLE",
            "email": "christians@example.com",
            "numbers": [
                {
                    "external": "+19075553859",
                    "extension":"8081",
                    "routingPrefix": "1234",
                    "esn": "12348080",
                    "primary": "true"
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1ZJUlRVQUxfTElORS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc3OGg=",
            "firstName": "Alice",
            "lastName": "Smith",
            "displayName": "AliceSmith",
            "type": "VIRTUAL_LINE",
            "numbers": [
                {
                    "external": "+19075552859",
                    "extension":"8083",
                    "routingPrefix": "1234",
                    "esn": "12348080",
                    "primary": "true"
                }
            ]
        }

    ]
}