We are using Open Messaging and attempting to send an inbound structured open response message.

However, the API call to:

swift


CopyEdit


{{host}}/api/v2/conversations/messages/{{integrationId}}/inbound/open/message

is not working. We receive the following error:

json


CopyEdit


"message": "should have required property 'content', should have required property '.text', should match some schema in anyOf"

It seems to be complaining about a missing content or .text field, even though we are trying to send a structured message.

Additionally, when I check the documentation page for "Send an inbound structured open response message", it only shows "loading..." and the API details do not appear.

Can you please clarify:

• What is the correct API endpoint for sending a structured message via Open Messaging?

• What is the expected request body format (schema) for structured content?

https://developer.genesys.cloud/commdigital/digital/openmessaging/inboundStructuredResponseMessages#send-an-inbound-structured-open-response-message

Hi @Yuezhong Zhang

Sample request body that we can use for this conversation api. Api Explorer. and further documentation here. https://developer.genesys.cloud/commdigital/digital/openmessaging/

 body = {
            "channel": {
                "platform": "Open",
                "messageId": str(uuid.uuid4()),
                "to": {
                    "id": config["open_message_direct_messaging_id"]
                },
                "from": {
                    "id": request.user,
                    "idType": "Opaque"
                },
                "time": datetime.now(tzutc()).isoformat()
            },
            "type": "Text",
            "text": request.message
        }

swift
CopyEdit
{{host}}/api/v2/conversations/messages/{{integrationId}}/inbound/open/message

json
CopyEdit
"message": "should have required property 'content', should have required property '.text', should match some schema in anyOf"

Hi VD,

thank you for your reply, 

Thank you 

I tested it out based on your response,  we just need to sent a text message back. 

Not sure why this link  show different structure (for buttonResponse) https://developer.genesys.cloud/commdigital/digital/openmessaging/inboundStructuredResponseMessages#inbound-structured-response-message-with-a-button-response 

Hello,

The API endpoint which will be used to send an inbound structured open response message is:

POST /api/v2/conversations/messages/{integrationId}/inbound/open/structured/response

The endpoint is not public yet. This is why the documentation page is only showing "Loading...". It will display the API endpoint properly when it is publicly released.

I have reached out to the Product Manager to ask about this. Apparently the Public API took longer to be deployed and it is expected to be available next week.

I don't have the exact date. But once public, it will appear on the API Explorer (and in the documentation page).

Regards,

swift
CopyEdit
{{host}}/api/v2/conversations/messages/{{integrationId}}/inbound/open/message

json
CopyEdit
"message": "should have required property 'content', should have required property '.text', should match some schema in anyOf"