Overview
Platform Introduction Bots Integrations Widgets Guest Issuer
REST API
Getting Started Basics
Guides
Admin API Buttons and Cards Calling Compliance Devices Hybrid Services Meetings REST API Webhooks
API Reference
Admin Audit Events Attachment ActionsCall Controls
POST DialPOST AnswerPOST RejectPOST HangupPOST HoldPOST ResumePOST DivertPOST TransferPOST ParkPOST RetrieveGET List CallsGET Get Call DetailsGET List Call History
Device Configurations Devices Events Hybrid Clusters Hybrid Connectors Licenses Locations Meeting Invitees Meeting Preferences Meetings Memberships Messages Organizations People Places Recordings Resource Group Memberships Resource Groups Roles Rooms Team Memberships Teams Webhooks xAPI
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.

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.
  1. | 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. |
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"
  }
}