DH Message Results Writeback API

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

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
leadMessageSent	String	Lead Message Sent	-
incomingMessage	String	Incoming Message	-
outgoingMessageId	String	Outgoing Message ID	4c700b54f524a5948253f24067cb9714
outgoingMessageSentDate	String	Outgoing Message Sent Date	11/07/2023
outgoingMessageSentTime	String	Outgoing Message Sent Time	08:32
outgoingMessage	String	Outgoing Message	-
personName	String	Person Name	-
personId	String	Person ID	82c7cb13947a4d0f8ad2b4398c32af12
mobileNumber	String	Mobile Number	5555558771
caregiverName	String	Caregiver Name	-
caregiverPhone	String	Caregiver Phone	5555558771
messageType	String	Message Type	Opt-In (UI)
recipientType	String	Recipient Type	PATIENT
campaignName	String	Campaign Name	-
campaignId	String	Campaign ID	82c7cb13947a4d0f8ad2b4398c32af12
broadcastName	String	Broadcast Name	-
broadcastId	String	Broadcast ID	82c7cb13947a4d0f8ad2b4398c32af12
carrier	String	Carrier	-
delivered	String	Delivered	true/false
messageStatus	String	Message Status	MESSAGE_REJECTED
messageSentBy	String	Message Sent By	-
personMisc1	String	Person Misc 1	-
personMisc2	String	Person Misc 2	-
personMisc3	String	Person Misc 3	-
personMisc4	String	Person Misc 4	-
personMisc5	String	Person Misc 5	-