Genesys Cloud - Developer Announcements!

 View Only

Sign Up

Back to discussions
Expand all | Collapse all

Deprecation of (textBody, media, stickers) fields from REST endpoint ("Get conversation message", "Get messages in batch", "Get message", "Send message") response

  • 1.  Deprecation of (textBody, media, stickers) fields from REST endpoint ("Get conversation message", "Get messages in batch", "Get message", "Send message") response

    Posted 04-18-2025 09:58

    Description

    An API change is being made to following REST endpoint response contract.

    • GET get conversation message

    • GET get message

    • POST Get messages in batch

    • POST send message

    The following fields are being deprecated and will be removed.

    • textBody

    • media

    • stickers

    Change Category

    API

    Change Context

    textBody, media and stickers fields are legacy fields for returning the sent/received text, media, and sticker to the public API consumers. But Public API consumers can find the same information by looking into normalizedMessage ("The message into the normalized format") field.

    For example,

    • textBody = normalizedMessage.text
    • media\[0].url = normalizedMessage.content\[0].attachment.url
    • media\[0].mediaType = normalizedMessage.content\[0].attachment.mime
    • media\[0].name = normalizedMessage.content\[0].attachment.filename
    • media\[0].id = normalizedMessage.content\[0].attachment.id
    • media\[0].contentLengthBytes = normalizedMessage.content\[0].attachment.contentSizeBytes
    • stickers\[0].url = normalizedMessage.content\[0].attachment.url
    • stickers\[0].id = normalizedMessage.content\[0].attachment.id

    Change Impact

    Customer needs to call mentioned APIs with queryParam useNormalizedMessage=true to switch to new way(normalized message) for getting text, media and sticker information of the message otherwise, they will get Null Pointer Exception after removing these fields.

    Date of Change

    18 Apr 2025

    Impacted APIs

    GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
    GET /api/v2/conversations/messages/{messageId}/details
    POST /api/v2/conversations/messages/{conversationId}/messages/bulk
    POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages



  • 2.  RE: Deprecation of (textBody, media, stickers) fields from REST endpoint ("Get conversation message", "Get messages in batch", "Get message", "Send message") response

    Posted 06-24-2025 12:44

    Hello team, good morning. I would like to confirm whether the endpoint GET /api/v2/conversations/messages/{messageId}/details will remain functional without the query parameter (useNormalizedMessage) once the fields are officially removed (I have checked that textBody is still present). I'm currently using it only to retrieve the conversationId, so at first glance, it appears that no changes are needed on my end. Could you please confirm if that assumption is correct?
    Thank you in advance.
    Best regards.



    ------------------------------
    Pablo Lozano
    ------------------------------

    Original Message


  • 3.  RE: Deprecation of (textBody, media, stickers) fields from REST endpoint ("Get conversation message", "Get messages in batch", "Get message", "Send message") response

    Posted 09-02-2025 15:46

    HI @Pablo Lozano sorry it took so long to reply here. If you are only using that endpoint to retrieve the conversationId from the response, then nothing should really change for you at all here. It would be best practice to go ahead and start using useNormalizedMessage=true param anyway though. As this guarantees you will be up to date and not be surprised by any changes that would come.



    ------------------------------
    Greg Boston
    Senior Software Engineer, Test
    ------------------------------

    Original Message


Related Content