Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Create Contact, SMS Template and Send SMS
// Initiate the Openscreen node SDK and include the project ID that you recieved using the Openscreen dashboard
const { Openscreen } = require("@openscreen/sdk");
const os = new Openscreen().config({key: process.env.OS_API_KEY, secret: process.env.OS_API_SECRET});
// Obtain projectId from the Openscreen Dashboard
const projectId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
// Capture scanId from the QR code scan
const scanId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';
async function main(){
// Create a new contact
const contact = await os.project(projectId).contacts().create({
consent: {
url: "",
consentType: 'SMS',
// Obtain contactId from the response
const { contactId } = contact;
// Create an SMS template
const smsTemplate = await os.project(projectId).smsTemplates().create({
smsTemplateName = "Position",
body: "You are now at position 5, please make your way to the {{}} now.",
// Send SMS to contact
const sendSMS = await os.scan(scanId).sms().send({
contactId: contactId,
smsTemplateName: "Position",
main().catch((err) => {
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment