List Meetings of a Meeting Series API has been merged into the List Meetings API.
]]>Video Duration field in the Calling Media Quality report has occasionally been reported as higher than expected. We're addressing this discrepancy to make sure that the data accurately reflects the actual video duration during calls. This change will be applied to historical data, affecting records up to 13 months prior from when the change goes live and will be enacted starting 3/18.
The Video Duration field also exists in the Calling Engagement report, but this change won't affect this report as it's being obsoleted.
]]>errorCodes field returned by the Get a Trunk endpoint will be updated. This update is scheduled to take place in April 2025.
]]>enabledLiveStream and liveStream attributes when the meeting is created using Create a Meeting. When the meeting is started, the meeting host can start the live streaming by selecting the three dots, choosing Start live streaming and then Go live from the meeting client. The live streaming is started for the meeting without any ad-hoc configuration required. Live streaming can also be enabled for an existing meeting using Patch a Meeting or Update a Meeting with the enabledLiveStream and liveStream attributes.
]]>errorCodes field returned by the Get a Trunk endpoint will be updated. This update is scheduled to take place in February 2025.
]]>sharedLineIndex field will be mandatory when lineKeyType is SHARED_LINE for the following APIs: Modify Device Layout by Device ID, Create a Line Key Template, and Modify a Line Key Template.
]]>Previous Behavior: In the past, when a participant moved from the main session to a breakout session, and then to another breakout session, the API response aligned the breakout sessions under a single main session: • MSession • BrO1 • BrO2
New Behavior: With WSMP, each breakout session will now appear under the main session every time, as follows: • MSession • BrO1 • MSession • BrO2
This adjustment means the API response will include the main session for each breakout session entry, even if only one main session exists. As a result, you will need to utilize session identifiers to consolidate these repeated main session entries in your reporting systems.
Please update your systems accordingly to accommodate this change.
]]>X-Spark-Signature when a secret has been provided during webhook registration. The signature corresponds to the HMAC-SHA1 hash of the webhook payload. We now offer additional HMAC's namely HMAC-SHA256 and HMAC-SHA512. These can be found in the new header X-Webex-Signature.
]]>errorCodes field returned by the Get a Trunk endpoint will be changing on January 24, 2025. Please prepare your code to use these new values:
| Old Error Code | New Error Code |
|---|---|
E1001 |
F_TO_FQDN_DNS_FAILURE |
E1002 |
F_TO_CONN_TRANSPORT_ISSUE |
E1003 |
F_TO_CONN_CERT_INVALID_CA |
E1004 |
F_TO_CONN_CERT_EXPIRED |
E1005 |
F_TO_CONN_CERT_EXPIRED_CA |
E1006 |
F_TO_FQDN_FQDN_MISSING_CN_SAN |
E1007 |
E_TO_NO_RESPONSE |
E1008 |
F_FROM_CONN_CERT_INVALID_CERT |
E1009 |
F_FROM_CONN_CERT_DISTRUST_CA |
E1010 |
F_FROM_CONN_CERT_EXPIRED_CERT_CHAIN |
E1011 |
F_FROM_FAILED_SIP_OPTIONS |
E1012 |
E_FROM_SERVER_ERROR_UNAVAILABLE |
E1013 |
F_TO_CONN_CERT_REVOKED_CERT |
E1014 |
F_FROM_CONN_CERT_REVOKED_CERT |
E1015 |
F_FROM_CONN_CERT_EXPIRED |
E1016 |
F_FROM_CONN_CERT_ERROR |
E1017 |
F_TO_CONN_CERT_ERROR |
rooms/meetingInfo API may not return information after an organization was moved to the Webex Suite Meetings Platform. As explained, the reason is that in WSMP, there is only a loose concept of a space meeting. The meeting does not happen in the space but must be scheduled via the /meetings REST endpoints. The meetings REST endpoint also provides the SIP dial info for the meeting like in this example response. Please utilize this REST endpoint to avoid service disruption.
...
"siteUrl": "site4-example.webex.com",
"webLink": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
"registerLink": "https://cisco.webex.com/weblink/register/r55981368ee48e2a6f00b93231508c404",
"sipAddress": "123456789@site4-example.webex.com",
...
The /meetingInfo endpoint is now deprecated, and we may shut it down entirely on January 31, 2025, when most customers should be on WSMP.
]]>answerConfirmationEnabled has been renamed to answerConfirmationRequiredEnabled within the simultaneous ring settings of the Workspace API. This change applies to both the GET and MODIFY endpoints. During the transition period ( original change log published on 30th August 2024 ), both fields were accessible in the payload for GET and MODIFY operations. Please ensure that your implementations have been updated to reflect this change.
]]>All guest issuer apps must transition to using Service Apps for creating temporary identities to ensure continuity and take advantage of the enhanced features and support offered by Service Apps. ]]>
For detailed information, please refer to our API reference.
]]>answerConfirmationEnabled to answerConfirmationRequiredEnabled within the simultaneous ring settings for the Workspace API. This modification affects the GET and UPDATE endpoints. The change will take effect on October 11, 2024. Throughout the transition period, both fields will be accessible in the payload for GET and MODIFY operations.
]]>enabledAudioWatermark, enabledVisualWatermark, and visualWatermarkOpacity attributes. These attributes can also be returned when you Get a Meeting, List Meetings, or List Meetings of a Meeting Series.
]]>hasRegistration, hasRegistrants, and hasPostEventSurvey are returned in the Get a Meeting, List Meetings, and List Meetings of a Meeting Series APIs. The hasRegistration and hasRegistrants attributes only apply to ended meetings or webinar instances, while the hasPostEventSurvey attribute only applies to ended webinar instances.
]]>busyRedirect and businessContinuityRedirect have been added to the CREATE, UPDATE, and GET Hunt Group endpoints. Starting September 16, 2024, support for the businessContinuity object will be removed from the request and response payloads of these endpoints.
]]>locationId column in the USER level reconciliation reports of Wholesale Billing Reports. CUSTOMER level reconciliation reports with locationId will be available by September 1st, 2024.
]]>delegateEmails parameter. Additionally, users can add new delegate emails with the Insert Delegate Emails API and remove existing ones with the Delete Delegate Emails API.
]]>Location_ID, will be added to the Wholesale Billing Reports API, and this applies to both Customer and User report types.
]]>callingLineId and routingProfile fields will be removed from the Test Call Routing endpoint's response payload.
]]>status=purged parameter.
]]>cx_essentials has been added to Wholesale Provisioning. This package offers customer experience essentials with advanced group call management abilities on top of Webex calling. Click here to learn more. The feature toggle wholesale-cx-essentials is required for partner admins to provision wholesale customers and users with this new package type.
]]>invitePending and loginEnabled statuses and how they relate to the Control Hub view of users. We are going to normalize these fields in the following manner:
invitePending will be a read-only field that is set and unset by our Common Identity system depending on if the user accepted the invite email. User login is allowed only after invitePending has cleared (false).
loginEnabled can be set to allow or disallow users from logging in.
We will enforce this logic on or after June 10, 2024.
]]>breakoutSessionsAttended has been added to the List Meeting Participants, Query Meeting Participants with Email, and Get Meeting Participant Details APIs. It indicates the breakout sessions that a participant attended during a meeting, and it only applies to participants of ended meeting instances. A new parameter breakoutSessionId has been added to the List Meeting Participants API so that it can return participants who joined the specified breakout session. If the meetingId of an ended meeting instance is specified, the List Meeting Breakout Sessions can now return the breakout sessions which happened during that meeting instance.
]]>packages field, which accepts a list of packages. Cisco will be deprecating and removing the support for the existing package field in the Wholesale Subscriber Provisioning POST, PUT, GET, LIST and PreCheck APIs on the 10th May, 2024.
]]>createJoinLinkAsWebLink and createStartLinkAsWebLink, have been added to the Join a Meeting API which can be used to specify webLink as a joinLink or a startLink. Those are typically useful if mandatory user login is configured in Control Hub.
]]>packages field, which accepts a list of packages, as Cisco will eventually remove support for the existing package field in the Wholesale Subscriber Provisioning POST, PUT, GET, LIST and PreCheck APIs. Further information will be provided well in advance of a published removal date.
]]>monitoringAgent field that were not compatible with APIs like Get Person Details. Get a person's Privacy Settings API has been corrected to return Person, Virtual Line, and Workspace IDs fully compatible with other APIs.
]]>sendToVoiceMailEnabled response field to destinationVoiceMailEnabled.
To allow API clients to make this transition, for the next six weeks, we are adding thedestinationVoiceMailEnabled alongside the existing sendToVoiceMailEnabled field. On April 15, 2024 the sendToVoiceMailEnabled will be removed from the response.
hostDidJoin and attendeeDidJoin, are returned in the response of the following APIs: Get a Meeting, List Meetings, and List Meetings of a Meeting Series. Those new attributes only apply to meeting series in the inProgress state, scheduled meetings in the ready state, and meeting instances in the inProgress state, whether or not anyone has joined the meeting. Indicates that someone is waiting in the lobby and the host hasn't joined the meeting, if both attendeeDidJoin is true and hostDidJoin is false.
]]>pAccessNetworkInfo if the location's country is not Belgium, Germany, and France. Starting April 11, 2024, the API will respond with an error if pAccessNetworkInfo is modified for locations outside of Belgium, Germany, and France.
]]>description which details where the issue occurred. Since internal server errors are, by nature, unexpected, these detailed descriptions are often not useful as they reference internal service interactions beyond your control. We are now opting to return a generic description which says "An unexpected error occurred", and including an internalErrorCode in the response body to indicate the precise nature of the issue. This will help accelerate the resolution of support tickets, as an internalErrorCode is of more benefit when trying to resolve such issues. This change will take effect before the end of February.
]]>errorCode as integer in the errors array. This change aligns the APIs with current documentation. Please review and prepare any code using these APIs and parsing the errorCode for the change in type.
]]>Guest Issuer app type is deprecated and will be removed in the future.
]]>businessTexts a.k.a. SMS events in the events API . When a Webex Calling user sends or receives SMS messages, these will be logged in the API and can be retrieved by a Compliance Officer. This feature complements our recently released CDR events.
]]>TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA TLS_RSA_WITH_AES_128_GCM_SHA256 TLS_RSA_WITH_AES_128_CBC_SHA TLS_RSA_WITH_AES_256_GCM_SHA384 TLS_RSA_WITH_AES_256_CBC_SHA256 TLS_RSA_WITH_AES_256_CBC_SHA
]]>errorCode as a String in the errors array. From February 1 2024, these APIs will return the errorCode as an integer, which will align the APIs with current documentation. Please review and prepare any code using these APIs and parsing the errorCode for the change in type.
]]>meetings:* scopes can now be tied to specific sites in the organization. This selection is done by a full admin in Control Hub who authorizes the Service App for the required site(s). The admin can choose from any or all of the meetings sites in the organization. The service app can only act on the allowed sites.
As an example let's assume an organization with two sites A and B. An admin wants to use a meeting scheduling Service App, but wants to allow this Service App only for site A. The admin would during the authorization process select site A and the Service App will not be able to schedule meetings on site B.
]]>call_records.
]]>zipEnable=false. After January 31, 2024 this flag will be ignored and all reports will be provided in zip format only.
Please see also this help article.
]]>numberType field. The possible values for this field are DID, which is the default if not specified, and TOLLFREE. This functionality now properly validates that the location has a compatible PSTN connection type and ID set before adding numbers, and returns a HTTP 200 OK rather than HTTP 201 Created on success.
]]>PATCH.
As part of the change we removed some license strings that had no function. These are Webex Meetings Assistant(WAM) and Meeting - Webex Collaboration Meeting Rooms (CMR).
SessionID, and Final remote SessionID.
]]>agenda, recurrence, and trackingCodes attributes can now be specified as null so that those attributes become null and hidden from the response after the patch. For example, by patching recurrence as null, a recurring meeting can be changed to a non-recurring meeting. Note that you must use the the keyword null not the string "null".
]]>Not Found error when the given directoryId does not exist rather than HTTP 204 No Content.
]]>active. Please see here.
We apologize for this error on our side.
]]>autoAcceptRequest parameter has been added to the the request of the Update Meeting Registration Form API, and has also been added to the response of the Update Meeting Registration Form and Get registration form for a meeting APIs.
]]>| Offer code | Existing name | New name |
|---|---|---|
| MS | Messaging | Advance Messaging |
| CF | Meeting 25 party | Advanced Space Meetings |
| EE | Meeting - Webex Enterprise Edition | Webex Meetings Suite |
| MC | Meeting - Webex Meeting Center | Webex Meetings |
| SC | Meeting - Webex Support Center | Webex Support |
| TC | Meeting - Webex Training Center | Webex Training |
| EC | "Meeting - Webex Event Center | Webex Webinar |
| WXSFREE | Webex Free Meetings | Basic Meetings |
| CO | Calling | Webex Calling |
| SD | Room Systems | Webex Room Kit |
| EC250 | Webex Events 250 | Webex Webinar 250 |
| EC500 | Webex Events 500 | Webex Webinar 500 |
| EC1k | Webex Events 1000 | Webex Webinar 1000 |
| EC3k | Webex Events 3000 | Webex Webinar 3000 |
| EC5k | Webex Events 5000 | Webex Webinar 5000 |
| EC10k | Webex Events 10000 | Webex Webinar 10000 |
| EC25k | Webex Events 25000 | Webex Webinar 25000 |
| EC50k | Webex Events 50000 | Webex Webinar 50000 |
| EC100k | Webex Events 100000 | Webex Webinar 100000 |
| RTT | Webex Real-Time Translations | Real-Time Translations |
| FMS | Basic message | Basic Messaging |
| FTS | Call on Webex | Call on Webex (1:1 call, non-PSTN) |
| FTM | Basic meeting | Basic Space Meetings |
| UCPREM | On-Prem UCM Calling | Unified Communication Manager (UCM) |
| CVI | MS Teams Video | Webex Video Integration for Microsoft Teams |
| CJPPRM | CJP Premium | Contact Center Premium Agent3 |
Note: Due to some problems with the publishing system a publishing date of Sep 26, was shown between Sep 13-Sep 21. This article was published on Sep 13, 2023.
]]>hostEmail, and hostDisplayName are returned in the response of the List Recordings For an Admin or Compliance Officer API.
]]>DecoupleJBHWithRegistration is applied, the Join Before Host option can be enabled for meetings with registration. As a meeting host, cohost, attendee, guest, or guest issue user, you can retrieve the meeting start or join links using the Join a Meeting API. NOTE: If the meeting is webinar-enabled and includes the registration ID option, the registrationId parameter is required.
]]>enabledAudioWatermark that allows you to specify whether to turn on meeting audio watermarking. Only specific users can use the function. Please contact an administrator to enable the required feature toggle. Webex version 43.9.0 or higher is required.
]]>timeZone instead of timezone to adhere to Cisco's API standards and avoid customer confusion. This change will be effective Sep 21, 2023.
]]>endpointId attribute. You can choose to use the Modify Users Preferred Answer Endpoint API to specify the preferred answer endpoint for all subsequent calls or instead specify the endpointId for each call using the Call Control API option.
]]>startStopAnnouncementEnabled parameter and replace it with more granular control. The setting can now be configured for internal calls and pstn calls separately. The respective parameters are startStopAnnouncement.internalCallsEnabled and startStopAnnouncement.pstnCallsEnabled. You can use the new parameters immediately.
]]>numbers and mainNumber attributes in the following Wholesale APIs: Provision a Wholesale Customer, Update a Wholesale Customer, and Precheck a Wholesale Customer Provisioning will be deprecated in the near future.
]]>audioAnnouncementFiles array): Create a call queue, Get details for a call queue, Update a call queue, Read the list of call queue announcement files, Get details for an auto attendant, Create an auto attendant, Update an auto attendant, Get music on hold, Update music on hold, Get details for a call queue forced forward service, Update a call queue forced forward service, Get details for a call queue holiday service, Update a call queue holiday service, Get details for a call queue night service, Update a call queue night service, Get details for a call queue stranded calls, and Update a call queue stranded calls service.
]]>h1,h2,h3,ul,ol,u,i,b and links href.
]]>meetings resource in the webhooks guide and the meetings API.
If you are interested in calling webhooks please see the telephony_calls resource in the webhooks guide and the calling API.
If you are interested in Webex Calling records, please see the Webex Calling CDR API
]]>