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

Announcements
1

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