twilio/location

The twilio/location content type allows you to send a location pin and an optional label, which you can use to enhance delivery notifications or provide location information to recipients.

(information)

Info

You can send location templates during an active 24-hour session with the recipient. You can't use them to initiate a business-initiated session.

Location templates aren't supported for approval on WhatsApp and can't be submitted for approval.

Supported channels

Message preview

Map with red location pin labeled 'Time to Board @ SFO', timestamp 10:02.

Data parameters

Parameter	Type	Required	Variable support	Description
`longitude`	Number	Yes	No	The longitude value of the location pin to send. Value must be between -180.0 and +180.0.
`latitude`	Number	Yes	No	The latitude value of the location pin to send. Value must be between -90.0 and +90.0.
`label`	String	No	Yes	Label to be displayed to the recipient alongside the location pin.

Code examples and responses

Create a location template

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID at twilio.com/console
5// Provision API Keys at twilio.com/console/runtime/api-keys
6// and set the environment variables. See http://twil.io/secure
7// For local testing, you can use your Account SID and Auth token
8const accountSid = process.env.TWILIO_ACCOUNT_SID;
9const apiKey = process.env.TWILIO_API_KEY;
10const apiSecret = process.env.TWILIO_API_SECRET;
11const client = twilio(apiKey, apiSecret, { accountSid: accountSid });
12
13async function createContent() {
14  const content = await client.content.v1.contents.create({
15    friendly_name: "owl_air_location",
16    language: "en",
17    types: {
18      "twilio/text": {
19        body: "Owl Air: Time to board, SFO is located at San Francisco International Airport, P.O. Box 8097, San Francisco, CA 94128 ",
20      },
21      "twilio/location": {
22        latitude: 37.62159755922449,
23        longitude: -122.37888566473057,
24        label: "Time to Board @ SFO",
25      },
26    },
27  });
28
29  console.log(content.dateCreated);
30}
31
32createContent();

Response

1{
2  "sid": "HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "owl_air_location",
5  "language": "en",
6  "variables": {
7    "name": "foo"
8  },
9  "types": {
10    "twilio/text": {
11      "body": "Owl Air: Time to board, SFO is located at San Francisco International Airport, P.O. Box 8097, San Francisco, CA 94128 "
12    },
13    "twilio/location": {
14      "latitude": 37.62159755922449,
15      "longitude": -122.37888566473057,
16      "label": "Time to Board @ SFO"
17    }
18  },
19  "url": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
20  "date_created": "2015-07-30T19:00:00Z",
21  "date_updated": "2015-07-30T19:00:00Z",
22  "links": {
23    "approval_create": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests/whatsapp",
24    "approval_fetch": "https://content.twilio.com/v1/Content/HXaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ApprovalRequests"
25  }
26}