Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Deprecation of /replace and /consult APIs

  • 1.  Deprecation of /replace and /consult APIs

    Posted 3 hours ago

    Summary

    The following APIs are deprecated and will only be removed if there is zero usage.

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace
    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult

    Deprecation : Effective Immediately

    Removal : Currently there is no plan to remove them as the removal is subject to zero usage

    Effective Date

    Friday, March 27, 2026

    Details

    We have introduced new transfer APIs with their own granular permissions. These APIs, along with their permissions, have already been released and are accessible for third-party transfer tools.

    New Blind Transfer APIs

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent

    Required Permission: blindTransfer OR blindTransferAgent

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue

    Required Permission: blindTransfer OR blindTransferQueue

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/contact/external

    Required Permission: blindTransfer OR blindTransferExternalContact

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/transfer

    Required Permission: blindTransfer

    New Consult Transfer (Voice Only) APIs

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent

    Required Permission: consultTransfer OR consultTransferAgent

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue

    Required Permission: consultTransfer OR consultTransferQueue

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/contact/external

    consultTransfer OR consultTransferExternalContact

    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/voice/consult

    Required Permission: consultTransfer

    For more details, please see these previous public announcements:

    https://community.genesys.com/discussion/decompose-transfer-permissions#bm7bedaf33-7189-4164-b60c-94ac1d3ae4d7

    https://community.genesys.com/discussion/deprecation-of-replaceexternal-and-consultexternal-apis#bmf94250cd-d114-4820-9c86-5475b6118a3e

    Customer Impact

    Genesys Cloud UI, CRM integrations, and other Genesys Cloud products have already migrated to the new endpoints.

    So far, the customer shouldn’t worry - the deprecated transfer APIs are still there and work perfectly, and no plan to remove them, but we do encourage they start using the new APIs which enable the administrators to configure transfer capabilities within the system. They will be able to configure whether users can perform blind or consult transfers to any other user, queue, or external contact.

    Impacted Resources

    • POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace
    • POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult

    Issue References

    SERVOPS-64401

    CS-4860

    Contacts

    @Carlo Dimonti  

    Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.



Related Content