Send a user an SMS

Send an SMS to any phone number. Oystehr's Transactional SMS feature makes it easy to send a text message to your Users with a single API call. You can use this feature to send appointment reminders, prescription refill reminders, discharge information, and more.

Access Policy Requirements:
Action: Messaging:SendTransactionalSMS
Access Policy Resource: Messaging:TransactionalSMS
Action: FHIR:Create
Access Policy Resource: FHIR:Communication
Action: FHIR:Update
Access Policy Resource: FHIR:Communication

You also need Read access for the resource to which you are sending a message. For example:
Action: FHIR:Read
Access Policy Resource: FHIR:Patient

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A reference to a FHIR Patient, RelatedPerson, or Practitioner resource in the format: Patient/some-uuid, RelatedPerson/some-uuid, or Practitioner/some-uuid.

string
required

The message to send. Messages over 160 characters will be split into multiple SMS messages.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json