API Reference

Send a message to a Conversation

post
https://project-api.zapehr.com/v1/messaging/conversation//message

Send a message to a Conversation. Conversations allow you to build multi-channel bi-directional messaging workflows. For example, you might create a Conversation where a provider messages with a patient through a web app, and the patient receives and responds to messages via SMS on their phone.

Access Policy Requirements:
Action: Messaging:ConversationSendMessage
Access Policy Resource: Messaging:Conversation

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

ID of the Conversation from the https://extensions.fhir.oystehr.com/encounter-virtual-service-pre-release extension if on FHIR R4B, or from Encounter.virtual-service if on FHIR R5.

Body Params
string
required

The message to send to the Conversation. Must be no more than 1600 characters.

attributes
object

A string metadata field you can use to store any data you wish. This data can be retrieved by all Conversation participants. The string value must contain structurally valid JSON if specified.

Responses
204

Message was sent to the Conversation successfully.

Updated about 1 year ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago