DH Message Results Writeback API
DH Message Results
Writeback API
Introduction
The Dialog Health Message Results Writeback API allows external systems to retrieve detailed information about outbound and inbound SMS communications sent through Dialog Health. This API is designed to support seamless integration with third-party platforms, enabling real-time visibility into message delivery outcomes, patient/staff engagement, and campaign performance.
Each API response provides a comprehensive snapshot of a message interaction, including:
- Message metadata (e.g., message ID, type, status, timestamps)
- Recipient details (e.g., patient name, mobile number, identifiers)
- Campaign and broadcast context
- Delivery status and carrier information
- Person misc fields (e.g., personmisc1–personmisc5)
This writeback functionality is ideal for healthcare organizations and partners who need to synchronize engagement data with EHRs, CRMs, or analytics platforms to drive follow-up actions, reporting, or compliance tracking.
Access
· HTTP Basic Authentication basic
Endpoints
https://[dialoghealth-server]/dialoghealth-writeback-api/
ApiController
responses
GET
/api/responses/{consoleCode}/{startTimestamp}/{endTimestamp}
Parameters
Path Parameters
Name | Description | Required | Pattern |
consoleCode | A unique set of letters and numbers automatically assigned to each console upon creating | X | SIDJUL8079 |
startTimestamp | Start timestamp in MM/dd/yyyy HH:mm:ss format. Note that the time range cannot exceed 1 week. | X | MM/dd/yyyy HH:mm:ss |
endTimestamp | End timestamp in MM/dd/yyyy HH:mm:ss format. Note that the time range cannot exceed 1 week. | X | MM/dd/yyyy HH:mm:ss |
All date/time data is accepted and returned in Coordinated Universal Time (UTC).
Return Type
ApiResponse
Content Type
· application/json
Responses
Code | Message | Datatype |
200 | - | ApiResponse |
400 | - | ErrorResponse |
Samples
Sample curl command to send request
$ curl --location --request PUT 'https://[dialoghealth-server]/dialoghealth-writeback-api/api/responses/WEBMAG6745/2023-11-05 00:00:00/2023-11-08 23:59:50' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic {credentials}' \--data ''
Sample response body (json)
{ "requestId": "e92cc082-5afa-4b9f-b685-48cbe016645b", "response": [ { "leadMessageSent": null, "incomingMessage": null, "outgoingMessageId": "4c700b54f524a5948253f24067cb9714", "outgoingMessageSentDate": "11/07/2023", "outgoingMessageSentTime": "08:32","outgoingMessage": "DH Web Form Test: You have been unsubscribed and will receive no further texts from us. Reply Text WBOPTIN if you would like to rejoin.",
"personName": " 12am", "personId": "82c7cb13947a4d0f8ad2b4398c32af12", "mobileNumber": "5555558771", "caregiverName": null, "caregiverPhone": null, "messageType": "Opt-Out", "recipientType": "PATIENT", "campaignName": null, "campaignId": null, "broadcastName": null, "broadcastId": null, "carrier": "Unknown", "delivered": "false", "messageStatus": "MESSAGE_REJECTED", "messageSentBy": "System", "personMisc1": "PMisc111", "personMisc2": "PMisc222", "personMisc3": "PMisc333", "personMisc4": "PMisc444", "personMisc5": "PMisc555" }, { "leadMessageSent": null, "incomingMessage": null, "outgoingMessageId": "4b002f5643a227dc3c3bb533b3df7542", "outgoingMessageSentDate": "11/07/2023", "outgoingMessageSentTime": "08:34", "outgoingMessage": "API", "personName": "API 12am", "personId": "Qyujyuj", "mobileNumber": "5555559865", "caregiverName": null, "caregiverPhone": null, "messageType": "Opt-In (UI)", "recipientType": "PATIENT", "campaignName": null, "campaignId": null, "broadcastName": null, "broadcastId": null, "carrier": "C Spire Wireless", "delivered": "false", "messageStatus": "MESSAGE_REJECTED", "messageSentBy": "System", "personMisc1": "misc1", "personMisc2": "PMisc222", "personMisc3": "PMisc333", "personMisc4": "PMisc444", "personMisc5": "PMisc555" }, { "leadMessageSent": null, "incomingMessage": null, "outgoingMessageId": "9d7f3d83fbb798ac8180d08508f5f185", "outgoingMessageSentDate": "11/07/2023", "outgoingMessageSentTime": "08:40", "outgoingMessage": "bbcgb", "personName": "API 12am", "personId": "Qyujyuj", "mobileNumber": "5555559865", "caregiverName": null, "caregiverPhone": null, "messageType": "Post optin message sent", "recipientType": "PATIENT", "campaignName": "Post Opt-In Campaign", "campaignId": null, "broadcastName": "dshdg", "broadcastId": null, "carrier": "C Spire Wireless", "delivered": "false", "messageStatus": "MESSAGE_REJECTED", "messageSentBy": "System", "personMisc1": "misc1", "personMisc2": "PMisc222", "personMisc3": "PMisc333", "personMisc4": "PMisc444", "personMisc5": "PMisc555" }, { "leadMessageSent": null, "incomingMessage": null, "outgoingMessageId": "56add711b6b544c832a1835edb3f0836", "outgoingMessageSentDate": "11/08/2023", "outgoingMessageSentTime": "02:51","outgoingMessage": "DH Web Form Test: You have been unsubscribed and will receive no further texts from us. Reply Text WBOPTIN if you would like to rejoin.",
"personName": "lang3 xxx3", "personId": "01jh306500662", "mobileNumber": "5555551010", "caregiverName": null, "caregiverPhone": null, "messageType": "Opt-Out", "recipientType": "PATIENT", "campaignName": null, "campaignId": null, "broadcastName": null, "broadcastId": null, "carrier": "Unknown", "delivered": "false", "messageStatus": "MESSAGE_REJECTED", "messageSentBy": "System", "personMisc1": "Provider", "personMisc2": "test misc2 second test 3", "personMisc3": null, "personMisc4": null, "personMisc5": null }, { "leadMessageSent": null, "incomingMessage": null, "outgoingMessageId": "3f30274265e5d6127c6348a6e5b7d38a", "outgoingMessageSentDate": "11/08/2023", "outgoingMessageSentTime": "12:01", "outgoingMessage": "bcxbxc API misc1 misc1", "personName": "API 12am", "personId": "Qyujyuj", "mobileNumber": "5555559865", "caregiverName": null, "caregiverPhone": null, "messageType": "Post optin message sent", "recipientType": "PATIENT", "campaignName": "Post Opt-In Campaign", "campaignId": null, "broadcastName": "test", "broadcastId": null, "carrier": "C Spire Wireless", "delivered": "false", "messageStatus": "MESSAGE_REJECTED", "messageSentBy": "System", "personMisc1": "misc1", "personMisc2": "PMisc222", "personMisc3": "PMisc333", "personMisc4": "PMisc444", "personMisc5": "PMisc555" }, { "leadMessageSent": null, "incomingMessage": null, "outgoingMessageId": "4db67247e6c5aae10eefb0f2b182e738", "outgoingMessageSentDate": "11/07/2023", "outgoingMessageSentTime": "08:37", "outgoingMessage": "An SMS message", "personName": "Sean Roy", "personId": "5108236932", "mobileNumber": "5108236932", "caregiverName": null, "caregiverPhone": null, "messageType": "API Message", "recipientType": "PATIENT", "campaignName": null, "campaignId": null, "broadcastName": null, "broadcastId": null, "carrier": "Verizon Wireless", "delivered": "false", "messageStatus": "INVALID_PHONE", "messageSentBy": "System", "personMisc1": "Midwest", "personMisc2": "Yes", "personMisc3": "", "personMisc4": "", "personMisc5": "" } ]}
Models
ApiResponse
Field Name | Type | Description | Format |
requestId | String | Unique identifier of the request | - |
response | List<Response> | Response list | - |
ErrorResponse
Field Name | Type | Description | Format |
message | String | Error response message | - |
Response
Field Name | Type | Description | Format | |
| String | Lead Message Sent | - | |
| String | Incoming Message | - | |
| String | Outgoing Message ID |
| |
| String | Outgoing Message Sent Date |
| |
| String | Outgoing Message Sent Time |
| |
| String | Outgoing Message | - | |
| String | Person Name | - | |
| String | Person ID |
| |
| String | Mobile Number |
| |
| String | Caregiver Name | - | |
| String | Caregiver Phone |
| |
| String | Message Type |
| |
| String | Recipient Type |
| |
| String | Campaign Name | - | |
| String | Campaign ID |
| |
| String | Broadcast Name | - | |
| String | Broadcast ID |
| |
| String | Carrier | - | |
| String | Delivered |
| |
| String | Message Status |
| |
| String | Message Sent By | - | |
| String | Person Misc 1 | - | |
| String | Person Misc 2 | - | |
| String | Person Misc 3 | - | |
| String | Person Misc 4 | - | |
| String | Person Misc 5 | - |
Related Articles
DH Persons-Events-Subscription Status Rest API
Description API allows importing of person and event data immediately to the Dialog Health platform as well as the ability to manage subscription status. Please note: API use is restricted to 250 requests per hour. Access HTTP Basic Authentication ...DH Patient & Visit SOAP API Specifications
Endpoints http://[dialoghealth-server]/dialoghealth-source-api/soap/DataShare http://[dialoghealth-server]/dh-integration/soap/DataShare Target namespace: https://www.dialoghealth.com/ DataShareSoapBinding getReturnCodeStr POST /GetReturnCodeStr ...DH Trigger SMS API
Introduction Trigger is a message to one particular person which can be set up for a client and sent on demand as API call. The trigger works only for known patients/employees, who are already registered in Dialog Health database. Triggers can be ...DH Patient and Appointment REST XML API
Access HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dh-integration/rest/ Import Patients' data POST /import/protocall/authbase/{CONSOLE-CODE} Content Type application/xml; charset=utf-8 Parameters Request Body - XML ...DH Send SMS API
Access HTTP Basic Authentication basic Endpoints https://[dialoghealth-server]/dialoghealth-simplepay-api/ Silent opt-in and message delivery submit POST /submit/{console-code} Parameters Path Parameter Name Description Required Pattern ...