Docs Menu
Docs Home
/
MongoDB Atlas
/
Atlas App Services
/
Reference
/
Third-Party Services [Deprecated]
/
Twilio

twilio.send()

On this page

  • Definition
  • Usage
  • Example
  • Parameters
  • Return Value
  • Rule Templates
  • Users Can Send Only Messages from a Specific Phone Number
  • Users Can Only Send Messages to a Limited Set of Phone Numbers
  • Users Can Only Send Messages to Themselves

Definition

twilio.send()

Sends an SMS text message with Twilio.

Usage

Note

To send or receive messages via the Twilio API for WhatsApp, prepend the to or from numbers with whatsapp:.

to: "whatsapp:+15558675309",
from: "whatsapp:+15551234567",

Example

exports = function() {
    const twilio = context.services.get("myTwilio");
    twilio.send({
        to: "+15558675309",
        from: "+15551234567",
        body: "Hello from App Services!"
    });
};

Parameters

Parameter
Type
Description
args
document

A document of the following form:

{
    "to": <string>,   // recipient phone #
    "from": <string>, // sender phone #
    "body": <string>  // message
}
args.to
string
The recipient's phone number in E.164 Format.
args.from
string
A phone number associated with your Twilio account in E.164 Format.
args.body
string
The message to send.

Return Value

The twilio.send() action does not return a value.

Rule Templates

Users Can Send Only Messages from a Specific Phone Number

{
  "%%args.from": "+15551234"
}

Users Can Only Send Messages to a Limited Set of Phone Numbers

{
  "%%args.to": {
    "$in": [
      "+15551234",
      "+18675309"
    ]
  }
}

Users Can Only Send Messages to Themselves

{
  "%%true": {
    "%function": {
      "name": "isCurrentUsersPhoneNumber",
      "arguments": [
        "%%args.to"
      ]
    }
  }
}

Note

This template calls an example function named isCurrentUsersPhoneNumber that does the following:

  1. Accepts the phone number provided in the to argument

  2. Queries MongoDB for a user document that matches the current user's id

  3. Compares the provided phone number to the number listed in the user document

  4. Returns the boolean result of the comparison

exports = function(toPhone) {
  const mdb = context.services.get('mongodb-atlas');
  const users = mdb.db('demo').collection('users');
  const user = users.findOne({ _id: context.user.id });
  return user.phoneNumber === toPhone;
}

Back

Twilio

Next

AWS