Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Messages

Send Message

Send a text or image message to the guest. <br><br>This endpoint is not idempotent and does not return a message ID. If a request times out, the outcome is unknown — Hostex cannot determine whether the channel has already delivered the message, and this uncertainty cannot be resolved on our side, so no idempotency guarantee is offered. If you receive an error, retry as appropriate — in our experience, a guest receiving a duplicate message is better than a guest receiving no message at all.

post/conversations/{conversation_id}

Path parameters

conversation_idstring required

The id of the conversation.

Request body

messagestring

The text content of the message. Max length depends on the limit of different channels.

jpeg_base64string

The base64 encoded string of the JPEG image.

Response

The request has been successfully submitted.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}