这份文档还在翻译中,预期年底前完成。欢迎您提供宝贵的意见及建议。

Send an SMS message

Sending an SMS message with the Messages API can be done with one API call, authenticated using a JWT.

In the example code below you will need to replace the following variables with actual values:

Key Description
FROM_NUMBER The phone number you are sending the message from.
TO_NUMBER The phone number you are sending the message to.

NOTE: Don't use a leading + or 00 when entering a phone number, start with the country code, for example 447700900000.

Example

Write the code

Add the following to send-sms.sh:

curl -X POST https://api.nexmo.com/v0.1/messages \
  -H 'Authorization: Bearer '$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "from": { "type": "sms", "number": "$FROM_NUMBER" },
    "to": { "type": "sms", "number": "$TO_NUMBER" },
    "message": {
      "content": {
        "type": "text",
        "text": "This is an SMS sent from the Messages API"
      }
    }
  }'

View full source

Run your code

Save this file to your machine and run it:

bash send-sms.sh

Prerequisites

npm install @vonage/server-sdk@beta

Write the code

Add the following to send-sms.js:

const Vonage = require('@vonage/server-sdk')

const vonage = new Vonage({
  apiKey: VONAGE_API_KEY,
  apiSecret: VONAGE_API_SECRET,
  applicationId: VONAGE_APPLICATION_ID,
  privateKey: VONAGE_APPLICATION_PRIVATE_KEY_PATH
})

vonage.channel.send(
  { "type": "sms", "number": TO_NUMBER },
  { "type": "sms", "number": FROM_NUMBER },
  {
    "content": {
      "type": "text",
      "text": "This is an SMS text message sent using the Messages API"
    }
  },
  (err, data) => {
    if (err) {
      console.error(err);
    } else {
      console.log(data.message_uuid);
    }
  }
);

View full source

Run your code

Save this file to your machine and run it:

node send-sms.js

This will send an SMS message to the destination number you specified.

TIP: If testing using Curl you will need a JWT. You can see how to create one in the documentation on creating a JWT.


Sending an SMS message

The Messages API provides the ability to send messages to various channels, including Facebook Messenger, SMS, WhatsApp and Viber. This task looks at using the Messages API to send an SMS message.



Steps