Overview
Bots Integrations Widgets Guest Issuer
REST API
Getting Started Basics
API Reference
Admin Audit Events Attachment Actions BroadWorks Enterprises BroadWorks SubscribersCall Controls
POST DialPOST AnswerPOST RejectPOST HangupPOST HoldPOST ResumePOST DivertPOST TransferPOST ParkPOST RetrievePOST Start RecordingPOST Stop RecordingPOST Pause RecordingPOST Resume RecordingGET List CallsGET Get Call DetailsGET List Call History
Device Configurations Devices Events Historical Analytics Hybrid Clusters Hybrid Connectors Licenses Locations Meeting Invitees Meeting Participants Meeting Preferences Meeting Qualities Meeting Transcripts Meetings Memberships Messages Organizations People Places Recordings Report Templates Reports Resource Group Memberships Resource Groups Roles Room Tabs Rooms Space Classifications Team Memberships Teams Webex Calling Organization Settings Webex Calling Person Settings Webhooks Workspace Locations Workspace Metrics Workspaces xAPI
Guides
Admin API Buttons and Cards Calling Compliance Devices Hybrid Services Meetings REST API Meeting Resource Guide Webhooks Webex for BroadWorks
API Changelog
SDKs
iOS Android Browser Node.js Java Community

Park

Park a connected call. The number field in the response can be used as the destination for the retrieve command to retrieve the parked call.

POST/v1/telephony/calls/park
Body Parameters
callId
stringrequired

The call identifier of the call to park.

destination
string

Identifes where the call is to be parked. If not provided, the call is parked against the parking user. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, *73, tel:+12223334444, user@company.domain, sip:user@company.domain

isGroupPark
boolean

If set to true, the call is parked against an automatically selected member of the user's call park group and the destination parameter is ignored.

Response Properties
parkedAgainst
Party Information

The details of where the call has been parked.

name
string

The party's name. Only present when the name is available and privacy is not enabled.

number
string

The party's number. Only present when the number is available and privacy is not enabled. The number can be digits or a URI. Some examples for number include: 1234, 2223334444, +12223334444, *73, user@company.domain

personId
string

The party's person ID. Only present when the person ID is available and privacy is not enabled.

placeId
string

The party's place ID. Only present when the place ID is available and privacy is not enabled.

privacyEnabled
boolean

Indicates whether privacy is enabled for the name, number and personId/placeId.

callType
Call Type Enum

The call type for the party.

location
string
organization
string
external
string
emergency
string
repair
string
other
string
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.
POST
/v1/telephony/calls/park
Log in to try the API.
Header
Body
  • The call identifier of the call to park.
  • Identifes where the call is to be parked. If not provided, the call is parked against the parking user. The destination can be digits or a URI. Some examples for destination include: 1234, 2223334444, +12223334444, *73, tel:+12223334444, user@company.domain, sip:user@company.domain
  • If set to true, the call is parked against an automatically selected member of the user's call park group and the destination parameter is ignored.
{
  "callId": "Y2lzY29zcGFyazovL3VzL0NBTEwvQkNMRC9jYWxsaGFsZi00ODg6MA",
  "destination": "1000",
  "isGroupPark": false
}
200 / OK
{
  "parkedAgainst": {
    "name": "John Smith",
    "number": "+12223334444",
    "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9hMTlkODJhMi00ZTY5LTU5YWEtOWYyZi1iY2E2MzEwMTNhNjg=",
    "placeId": "Y2lzY29zcGFyazovL3VzL1BMQUNFL2ExOWQ4MmEyLTRlNjktNTlhYS05ZjJmLWJjYTYzMTAxM2E2OA==",
    "privacyEnabled": false,
    "callType": "location"
  }
}