DH Trigger SMS API

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 used in different ways.

  • Use a trigger as a confirmation that phone number you gave in clinic is actually your phone number

  • Somebody is doing an online form (outside our system) and our client needs to trigger a message with their unique ID (Misc1). Once the form is filled in, their API calls to DH with the patient’s ID, we send text with this ID (Misc1) to the patient.

“NotificationTriggerID” and “patientID” are needed to run the trigger message.

Access

  • HTTP Basic Authentication basic

Endpoints

http://[dialoghealth-server]//dh-integration/rest/

Trigger

Trigger notification

POST /triggernotification/{console-code}

Parameters
Path Parameter

Name

Description

Required

Pattern

{console-code}

A unique set of letters and numbers automatically assigned to each console upon creating

X

SIDJUL8079

Body Parameter

Name

Description

Required

Pattern

TriggernotificationRequest

TriggernotificationRequest

X

-

Return Type

TriggernotificationResponse

Content Type

  • application/json

Responses

Code

Message

Datatype

200

-

TriggernotificationResponse

400

-

TriggernotificationResponse

Samples
Sample curl command to send request
1$ curl --location --request POST 'https://{dialoghealth-server}/dh­integration/rest/triggernotification/WEBMAG6745' \ 2--header 'Content-Type: application/json' \ 3--header 'Accept: application/json' \ 4--header 'Authorization: Basic {credentials}' \ 5--data-raw '{ 6 "notificationTriggerId": "VF4G8R7O", 7 "patientId": "732d85650117415aa0b4d3858c937916" 8}'
Sample request body (json)
1{ 2 "notificationTriggerId": "VF4G8R7O", 3 "patientId": "732d85650117415aa0b4d3858c937916" 4}
Sample response body (json)
1{ 2 "message": "Patient requires optin" 3}

Models

TriggernotificationRequest

Field Name

Required

Type

Description

Format

notificationTriggerId

X

String

Unique identifier of notification trigger

-

patientId

X

String

Unique identifier of a patient

-

TriggernotificationResponse

Field Name

Type

Description

Format

message

String

API response message

-


    • 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 ...

    • Introduction to Data Integrations - Patients

      About Dialog Health's PROTOCALL™ and Our Use of Data PROTOCALL™ is a cloud-based Patient + Caregiver Engagement Platform which leverages the mobile phone to improve outcomes. Dialog Health’s mobile messaging enables two-way communication between your ...

    • 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 ...

    • 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 Message Results Writeback API

      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 ...