# Changelog #### 26.04 | April 4, 2025 * No changes to the API #### 26.03 | March 7, 2025 * No changes to the API #### 26.02 | February 7, 2025 * The **Update room member's attributes** API was added to allow Symphony Messaging users to be promoted to / demoted from the room owner role. All room members are now identified as owners. #### 26.01 | January 10, 2025 * No changes to the API #### 25.12 | December 6, 2025 * No changes to the API #### 25.11 | November 1, 2025 * No changes to the API #### 25.10 | October 4, 2025 * No changes to the API #### 25.09 | September 6, 2025 * No changes to the API #### 25.08 | August 2, 2025 * No changes to the API #### 25.07 | July 5, 2025 * No changes to the API #### 25.06 | June 7, 2025 * Calling the **Get an advisor's entitlement** API after entitling a Symphony Messaging user to WhatsApp Direct with a specific phone number now sets the user’s status to `PRE-ENTITLED` if a Meta identity has not yet been created for the phone number, or `ENTITLED` if the Meta identity was already created for the Symphony Messaging user. * For Symphony Messaging users entitled for SMS Direct and WhatsApp Direct, the **Add entitlement** customer API now includes new fields - `status` and `phone` - in the 201 response. #### 25.05 | May 10, 2025 * The **List entitlements** and **Get an advisor's entitlement** APIs have been updated to include users pre-entitled for WhatsApp Direct. * The **List contact's advisors** API has been updated to return pre-entitlement information in the response. #### 25.04 | April 12, 2025 * The **List entitlements** API has been updated to return details for pre-entitled users for WhatsApp Direct, whereas calling the API with pre-entitled users previously returned a 404 NOT FOUND error. * The **Bulk update advisor's federation group** API has been updated to include users who are pre-entitled for WhatsApp Direct. * The **Pre-entitle an advisor to a phone number** and **Remove an advisor pre-entitlement** APIs have been deprecated. #### 25.03.2 | March 29, 2025 * The **Get an advisor's entitlement** API now returns user entitlement details, including for users who are `PRE_ENTITLED` on WhatsApp Direct. This means that a 200 status code will be returned for users who are `PRE_ENTITLED` on WhatsApp Direct, instead of the previously returned 404 code. * The **List entitled advisors** API now returns two additional fields for entitlements: `ENTITLED` or `PRE_ENTITLED` for all external networks, and `Phone.provider` (with possible values `UMONY` or `CUSTOMER_SUPPLIED`) for SMS Direct and WhatsApp Direct. * The **Add entitlement** API was updated to include setting Federation groups for individual users. #### 25.03 | March 15, 2025 * The **Add entitlement** API does not return a 409 error when a user who is already entitled to WhatsApp gets entitled to WhatsApp Direct with the same permissions. * The **Add entitlement** API now throws a 400 error when a user is entitled with a custom number (provided by the customer and not by Symphony) and with a set of permissions specified in the request, since the management of permissions is not yet supported for such a case. #### 25.02 | February 15, 2025 * No changes to the API #### 25.01 | January 18, 2025 * Calling the **Create room** API after adding a new contact with the permission `createRoom: false` via API now creates an unique SMS Direct room and adds the contact to the room. #### 24.12 | December 7, 2024 * A new API endpoint, **Get advisor's phone number details**, retrieves information regarding the phone number itself and any Direct channels on which the number can be used; it shows whether the number is AVAILABLE (not yet entitled, or entitlement was removed) or ACTIVE (currently used). #### 24.11 | November 9, 2024 * No changes to the API #### 24.10 | September 30, 2024 * We added the `listPermissions` query parameter to the **List entitled advisors** API. When set to `true`, the permissions object listing Symphony Messaging users’ permissions is added to the response for each advisor. When not specified, the API answer is the same as before. * Deleting a Symphony Messaging user’s entitlement to WhatsApp Direct via the **Remove entitlement** API also removes the user’s pre-entitlement and places the phone number allocated to the user in a `RELEASED` state. * We added the WhatsApp Direct `empStatus` to the **Get phone number details** and **Get phone number address** API response, in order to retrieve the Meta status for WhatsApp Direct phone numbers. The API now returns a 200 response and displays the Meta status of a phone number, such as `CONNECTED`, `DISCONNECTED`, `PENDING` or `UNKNOWN`. #### 24.09 | September 14 2024 * A new Voice Direct permission, `enable:voice-calls`, was added to place and receive phone calls for virtual numbers. * The following new fields have been added to the **Get phone number information API**: `assignedTo`, `externalNetworks`, `productCode`, `product`. * v2 of the **Unblock phone numbers** API, which includes the `phoneNumbers` list in the request body instead of the query parameters, was added. #### 24.08 | August 17 2024 * New fields have been added to the **List an advisor's contacts** API for SMS & Voice Direct, to reflect the contact’s opted in/out status (relevant for US/Canada-based contacts): the `consent` field showing `OPTED-IN`, `OPTED-OUT` or `PENDING`, and the `status` field showing either `CONFIRMED` or `INCOMPLETE`. * The error message returned by the **Add room member API** when no more Business API / WhatsApp phone numbers are available to create a conversation with a WhatsApp contact was updated to describe the issue more explicitly and provide instructions for solving the error. * The **Get phone number information** API now returns a `symphony-user-not-found-problem` 400; error 404 `advisor-not-found` is no longer returned. #### 24.07 | July 20 2024 * SMS & Voice Direct only: A new API endpoint, **Update a phone number**, was added. It allows Symphony Messaging admins to unassign a SMS & Voice Direct phone number from a Symphony user, putting it on hold, and to reassign it to another Symphony user. * The **Get phone number information** API response now includes the `assignedTo` attribute which contains the Symphony Messaging identifier, the first and the last name of the Symphony Messaging user to whom a phone number is assigned. #### 24.06 | June 22 2024 * A new object, `phoneNumberBlockedBy`, was added to the **List Contacts** API to return information related to a blocked contact, such as the ID of the Symphony Messaging user who blocked the phone number, the blocking reason, the date and the comment. #### 24.05 | June 1 2024 * An optional query parameter, `phoneBlocked`, was added to the **List contacts** API with three possible values: `all`, `true`, `false`. It allows filtering all, only available or only blocked contacts' phone numbers. * A new API endpoint, **Get phone number details**, was added. This endpoint lists all the phone numbers registered for a tenant. * A new API endpoint, **Get information on a phone number provided by Symphony**, was added. It lists phone number details and status. * A new API, **Get contact**, has been created to retrieve the Federated contact’s status for a given Federation Group. #### 24.04 | May 4 2024 * The `phoneNumberBlockedBy` list of objects was added to the **List an advisor's contacts** API response, for WhatsApp Direct and SMS & Voice Direct contacts whose phone numbers have been blocked by a Symphony user. This object contains the blocking details (corresponding to any of these four attributes: `advisorSymphonyId`, `reason`, `comment`, and `requestDate`). #### 24.03 | April 13 2024 * The following APIs have been added: **Block phone numbers** (WhatsApp-Direct and SMS-Direct Second Number only), **Update room activity**. * When a Symphony user blocks a contact, a new list of objects, `phoneNumberBlockedBy`, including the specific details as attributes (`advisorSymphonyId`, `reason`, `comment`, `requestDate`), is now added to the **List an advisor's contacts** endpoint. * New error responses have been added to the **Add entitlement** API. #### 24.02 | 23 March 2024 * New error messages were added to the **Add entitlement** API. * A new attribute, `isColleague`, was added to the **List contact** API response. * A new field, `moveToDefault`, was added to the **Set federation group of a room** API response. #### 24.01 | 20 January 2024 * The **Remove permission** API was implemented for WhatsApp-Direct. * Error 403 was added to the **Add a contact and/or advisors to a contact** API for SMS-Direct. * The `advisorSymphonyId` query parameter was added to the **List contacts** API. #### 23.11 | 25 November 2023 * The **Remove an advisor pre-entitlement** API was added for WhatsApp-Direct. * The description of the API **Pre-entitle an advisor to a phone number** for WhatsApp-Direct was updated. #### 23.10 | 14 October 2023 * The following APIs have been updated to include WhatsApp-Direct: **Pre-entitle an advisor to a phone number**, **List permissions**, **List advisor's permissions**. * The **List EMP permissions** API was added for SMS-Direct. #### 23.09 | 16 September 2023 * The following APIs have been updated to include WhatsApp-Direct: **Add a contact and/or advisors to a contact**, **List or search for contacts**, **List an advisor's contacts**. #### 23.08 | 9 August 2023 * For SMS-Direct, new status codes have been added to phone numbers to distinguish pre-allocated phone numbers; the logic for provisioning/assigning phone numbers was updated to prevent random allocation of phone numbers that have been identified as pre-allocated. #### 23.07 | 29 Jul 2023 * The following APIs have been added: **Get phone number info**, **Get phone number address**, **Update phone number address** and **Remove phone number address**. * For LINE, `empChannelConnector` is not required when LINE channel automatic selection is enabled at the company or federation group level. * The PENDING CONFIRMATION, UNAVAILABLE and CONFIRMED contact statuses were added to the WhatsApp API response. See the **Contact status** page for more information. * The `enable:voice-calls` permission was added for SMS-Direct. It is required to make and receive phone calls from and to virtual numbers. See the **Permissions** table for more information. #### 23.06 | 24 Jun 2023 * The `subNetwork` parameter is now mandatory in the **Add entitlement** API for SMS-DIRECT. * Two new error responses have been added to the **Add entitlement** flow for SMS-DIRECT: `wrong-subnetwork-for-phone-number` (returned if the wrong subnetwork is selected for a phone number) and `subnetwork-is-required` (returned if no network is selected for a phone number). #### 23.05 | 3 Jun 2023 * No changes to the API #### 23.04 | 29 Apr 2023 * For SMS, LINE, WHATSAPP and WECHAT, the `companyName` and `emailAddress` parameters are mandatory. For SMS-DIRECT only, `companyName` and `emailAddress` are **not** mandatory. * The definition of the **Resend a new invitation API** was updated to include information about resetting the LINE one-time-password. * Only for the LINE external network, the `emp-channel-connector` is returned in the **Add room member** and **List room members** responses. #### 23.03 | 1 Apr 2023 * The **List EMP connectors available for one or multiple contacts** API endpoint was added. * The **Copy contact** API endpoint was added. #### 23.02 | 25 Feb 2023 * The `edit:contact-email` permission was added. It allows users to edit a contact email via the **Contacts** tab or the **Admin** tab. See the **Permissions** table for more information. * The definition of the `edit:contact` permission was updated to include the possibility to edit the contact's email address if the user has the `edit:contact-email` permission.