Send metadata outbound using open messaging API

hi all, we use the open messaging API with a customer to interact with their chat platform. We have the POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages to insert message into the chat as part of our agent desktop customization. The message insertion works well, however, we would like to send special data (like instructions to the other side to do something) which shouldnt go as normal text. It looks like there is no simple way to insert metadata like we can do with the inbound direction.
Something like that works inbound:
{
"textBody": "my message",
"metadata": {
"customAttributes" : {
"requires_attention": "true",
"custom_attachment_url": https://your-storage.com/attachment/xyz.pdf
}
}
}
I can insert the metadata part for outbound but it is not added to the message when sent to the remote webhook, only the textBody is delivered. Is there a way to send some special customized data (not in textBody) to the other side using this or a different API. The data has to be delivered to the webhook of the remote side.
i thought of using canned responses but it sounds like extra trouble just to send something special outside textbody.
Zsolt

Hello,

POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages does not have any metadata body attribute.

Metadata is only supported with Inbound Open Text Messages (from server/external to Genesys Cloud): POST /api/v2/conversations/messages/{integrationId}/inbound/open/message

The outbound messages received on the webhook do not contain/do not support metadata.

Regards,

That is what I saw too, inbound metadata works well but it is weird that we cant send special events and metadata from Genesys to the remote end.

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.