deep linking

Send an SMS with a deep link to the ABHA App

Also known as: SMS Deep Link Notify. Requests ABDM to send an SMS to a patient's mobile number containing a deep link to download/open the ABHA App. Used when a patient is not yet on ABDM and the HIP wants to invite them to link their health records.

MandatoryMandatory for the Government Integartors / Private Integrators

Certification cases HIP_INIT_NOTIFY_HIECM, HIP_INTI_LINK_501, HIP_INTI_LINK_502, HIP_INTI_LINK_503, HIP_INTI_LINK_504, HIP_INTI_LINK_505, HIP_INTI_LINK_506

POST/hiecm/hip/v3/link/patient/links/sms/notify2

Authorizations

Authorizationbearer tokenRequired

Bearer token obtained from POST /hiecm/gateway/v3/sessions

Headers

REQUEST-IDstringRequired

A fresh UUID that you generate for this request. The callback that answers it carries the same value, so this is how you match an asynchronous reply to the call that caused it. Store it before you send the request, not after.

TIMESTAMPstringRequired

The current time in ISO 8601, UTC, with milliseconds and a Z suffix, from a synchronised clock. The sandbox rejects IST and accepts UTC.

X-CM-IDstringRequired

Which consent manager you are talking to. sbx on the sandbox and abdm in production. A dedicated error code exists for an invalid value here, which tells you how often it is wrong.

Body

requestIdstringRequired

Unique request ID (UUIDv4)

timestampstringRequired

notificationobjectRequired

notification.phoneNostringRequired

Patient mobile number with country code (e.g. 917812345678)

notification.hipobjectRequired

notification.hip.namestringRequired

notification.hip.idstringRequired

Responses

202

SMS notification queued

The callback never arrives

400

Bad request, invalid parameters or missing fields

Error codes for this module

401

Unauthorized, missing or invalid Bearer token

Everything returns 401

403

Forbidden. Returned as plain text ("Access Denied"), not JSON.

Error codes for this module

404

Resource not found

Error codes for this module

500

Internal server error.

Error codes for this module

Send an SMS with a deep link to the ABHA App

curl --request POST \
  --url https://dev.abdm.gov.in/api/hiecm/hip/v3/link/patient/links/sms/notify2 \
  --header 'Authorization: Bearer <ACCESS_TOKEN_FROM_SESSIONS_CALL>' \
  --header 'REQUEST-ID: 5f7a4a1e-59ba-4c0c-9e0c-8e6b3b6e2f11' \
  --header 'TIMESTAMP: 2022-10-06T15:10:00.587Z' \
  --header 'X-CM-ID: <X_CM_ID>' \
  --header 'Content-Type: application/json' \
  --data '{
  "requestId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "timestamp": "2024-01-10T12:00:00.000Z",
  "notification": {
    "phoneNo": "917812345678",
    "hip": {
      "name": "S Y Hospital",
      "id": "HIP_SERVICE_ID"
    }
  }
}'

SMS notification queued

Callbacks

After this call, ABDM posts The outcome of an SMS deep link notify call you made to /v3/patients/sms/on-notify. Open the callback.

Send an SMS with a deep link to the ABHA App

Authorizations

Headers

Body

Responses

Callbacks​

Callbacks