v1

latestOpenAPI 3.0.02026-07-14307078.8 KB

Gateway

API for HIP to send SMS notifications to patients

API to send SMS notifications to patient with custom deeplink.

post/v0.5/patients/sms/notify

Headers

Authorizationstring required

Access token which was issued after successful login with gateway auth server, which will be sent by gateway to authenticate itself with API bridge.

X-CM-IDstring required

Suffix of the consent manager to which the request was intended.

Request body

requestIdstring uuid required

a nonce, unique for each HTTP request

timestampstring date-time required

Date time format in UTC, includes miliseconds YYYY-MM-DDThh:mm:ss.vZ

Example request

{
  "notification": {
    "careContextInfo": "X-Ray on 22nd Dec",
    "deeplinkUrl": "https://link.to.health.records/ (Optional)",
    "hip": {
      "id": "HIP_001",
      "name": "Max Healthcare (Optional)"
    },
    "phoneNo": "+91-9999999999",
    "receiverName": "Ramesh Singh (Optional)"
  },
  "requestId": "5f7a535d-a3fd-416b-b069-c97d021fbacd"
}

Response

accepted