Skip to main content

Receive the patients SMS on notify

Hosted by the HIP/HIU, not by ABDM. ABDM calls this endpoint at the callback URL registered for your bridge, so the path below is relative to that URL.

POST/api/v3/patients/sms/on-notify

This API endpoint is a call back API for /api/hiecm/hip/v3/link/patient/links/sms/notify2

<br><br/> <ol> <li>If the SMS trigger is successful, pass the successful message </li> <li>If the SMS trigger is unsuccessful, pass the error message with the error code and message </li> </ol>

Authorizations

Authorizationbearer tokenRequired

Headers

REQUEST-IDstringRequired

Unique UUID for track the end to end request transaction

TIMESTAMPstringRequired

Actual time of the request was initiated, ISO 8601 represents date and time by starting with the year, followed by the month, the day, the hour, the minutes, seconds and milliseconds

X-HIP-IDstringRequired

Identifier of the health information provider to which the request was intended

Body

acknowledgementobjectRequired
acknowledgement.statusstringRequired

One of SUCCESSERRORED

errorobject

The error code and message, if any occurred.

error.codestringRequired

ABDM-1024 - Dependent service unavailable. May be returned either bare (ABDM-1024) or with a trailing ": " separator (ABDM-1024: ); match on the code itself and tolerate the separator.

error.messagestringRequired
responseobjectRequired
response.requestIdstringRequired

The requestId that was passed

Responses

200

OK

400

Bad Request

Error codes for this module

401

Unauthorized

Everything returns 401

403

Forbidden

Error codes for this module

404

server cannot find the requested resource

Error codes for this module

500

Internal Server Error

Error codes for this module

Where this fits​

hiecm-m2.yaml declares this callback at module level and names no call against it. Which call produces it is not documented, so this page does not say.