APIs
Getting StartedREST API BasicsComplianceWebhooksWebex APIs
Admin
Overview
Guides
Reference
Admin Audit EventsEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting QualitiesMembershipsOrganizationsPeopleRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesSpace ClassificationsWebex Calling Organization SettingsWebex Calling Person SettingsWorkspace LocationsWorkspace MetricsWorkspaces
Calling
Devices
imiconnect
Meetings
Messaging
Webex Assistant Skills
Full API Reference
Admin Audit EventsAttachment ActionsBroadWorks EnterprisesBroadWorks SubscribersCall ControlsDevice ConfigurationsDevicesEventsHistorical AnalyticsHybrid ClustersHybrid ConnectorsLicensesLocationsMeeting InviteesMeeting ParticipantsMeeting PreferencesMeeting QualitiesMeeting TranscriptsMeetingsMembershipsMessagesMessages with EditOrganizationsPeoplePlacesRecordingsReport TemplatesReportsResource Group MembershipsResource GroupsRolesRoom TabsRoomsSpace ClassificationsTeam MembershipsTeamsWebex Calling Organization SettingsWebex Calling Person SettingsWebhooksWorkspace LocationsWorkspace MetricsWorkspacesxAPI
API Changelog

Get available agents from Call Pickups

Retrieve available agents from call pickups for a given location.

Call Pickup enables a user(agent) to answer any ringing line within their pickup group.

Retrieving available agents from call pickups requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

GET/v1/telephony/config/locations/{locationId}/callPickups/availableUsers
URI Parameters
locationId
stringrequired

Return the available agents for this location.

Query Parameters
orgId
string

Return the available agents for this organization.

callPickupName
string

Only return available agents from call pickups with the matching name.

max
number

Limit the number of available agents returned to this maximum count.

start
number

Start at the zero-based offset in the list of matching available agents.

name
string

Only return available agents with the matching name.

phoneNumber
string

Only return available agents with the matching primary number.

order
string

Order the available agents according to the designated fields. Up to three vertical bar (|) separated sort order fields may be specified. Available sort fields: fname, lname, extension, number.

Response Properties
agents
array[GetPersonPlaceCallPickupObject]

Array of agents.

id
string

ID of person or workspace.

firstName
string

First name of person or workspace.

lastName
string

Last name of person or workspace.

displayName
string

Display name of person or workspace.

type
enum

Type of the person or workspace.

PEOPLE
string

Indicates that this object is a user.

PLACE
string

Indicates that this object is a place.

email
string

Email of the person or workspace.

numbers
array[GetUserNumberItemObject]

List of phone numbers of the person or workspace.

external
string

Phone number of person or workspace.

extension
string

Extension of person or workspace.

primary
boolean

Flag to indicate primary phone.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
410GoneThe requested resource is no longer available.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
423LockedThe 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.
428Precondition RequiredFile(s) cannot be scanned for malware and need to be force downloaded.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
504Gateway TimeoutAn upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.
GET
/v1/telephony/config/locations//callPickups/availableUsers{?orgId,callPickupName,max,start,name,phoneNumber,order}
Log in to try the API.
Header
Query Parameters
  • Return the available agents for this organization.
  • Only return available agents from call pickups with the matching name.
  • Limit the number of available agents returned to this maximum count.
  • Start at the zero-based offset in the list of matching available agents.
  • Only return available agents with the matching name.
  • Only return available agents with the matching primary number.
  • Order the available agents according to the designated fields. Up to three vertical bar (|) separated sort order fields may be specified. Available sort fields: fname, lname, extension, number.
https://webexapis.com/v1/telephony/config/locations/Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzEyMzQ1/callPickups/availableUsers?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&callPickupName=North%20Alaska-Pickup&max=5&start=0&name=John&phoneNumber=9075552334&order=lname%7Cfname%7Cnumber
200 / OK
{
    "agents": [
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MGY2MzYzMC1mZjlmLTExZWItODU5YS0xZjhiYjRjNzc1MWQ",
            "lastName": "Ronnie",
            "firstName": "Coleman",
            "displayName": "RColeman",
            "type": "PEOPLE",
            "email": "r.coleman@mailinator.com",
            "numbers": [
                {
                    "external": "+19075552334",
                    "extension": "8083",
                    "primary": "true"
                }
            ]
        },
        {
            "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFLzg0YjQ1OTIyLWZmOWYtMTFlYi1hNGI4LTMzNjI3YmVkNjdiNQ",
            "lastName": "Owen",
            "firstName": "Wilson",
            "displayName": "OWilson",
            "type": "PEOPLE",
            "email": "o.wilson@mailinator.com",
            "numbers": [
                {
                    "external": "+19075555859",
                    "extension": "8084",
                    "primary": "true"
                }
            ]
        }
    ]
}