Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
http.BasicAuth = true;
http.Login = "{{auth_id}}";
http.Password = "password";
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "src": "+14152225555",
// "dst": "+14152345678",
// "text": "Hello, this is a sample text",
// "type": "sms",
// "url": "https://foo.com/sms status",
// "method": "POST",
// "log": "true",
// "trackable": false
// }
var json = new chilkat.JsonObject();
json.UpdateString("src","+14152225555");
json.UpdateString("dst","+14152345678");
json.UpdateString("text","Hello, this is a sample text");
json.UpdateString("type","sms");
json.UpdateString("url","https://foo.com/sms status");
json.UpdateString("method","POST");
json.UpdateString("log","true");
json.UpdateBool("trackable",false);
// resp: HttpResponse
var resp = http.PostJson3("https://api.plivo.com/v1/Account/<auth_id>/Message/","application/json",json);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
console.log(resp.StatusCode);
console.log(resp.BodyStr);
}
chilkatExample();
Curl Command
curl -X POST
-u '{{auth_id}}:password'
-d '{
"src": "+14152225555",
"dst": "+14152345678",
"text": "Hello, this is a sample text",
"type": "sms",
"url": "https://foo.com/sms status",
"method": "POST",
"log": "true",
"trackable": false
}'
https://api.plivo.com/v1/Account/<auth_id>/Message/
Postman Collection Item JSON
{
"name": "Send SMS",
"request": {
"auth": {
"type": "basic",
"basic": [
{
"key": "username",
"value": "MAMJRHMWU3MJA4YMU5NJ",
"type": "string"
},
{
"key": "password",
"value": "ODYwZmMyNGMwZTJlYjE3Y2E0MWY4ZWJiMTVhZDY0",
"type": "string"
}
]
},
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"src\": \"+14152225555\",\n \"dst\": \"+14152345678\",\n \"text\": \"Hello, this is a sample text\",\n \"type\": \"sms\",\n \"url\": \"https://foo.com/sms status\",\n \"method\": \"POST\",\n \"log\": \"true\",\n \"trackable\": false\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Message/",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{{auth_id}}",
"Message",
""
]
},
"description": "Send Message or MMS, below is the list of arguments that can be passed in this API request, more information can be found [here](https://www.plivo.com/docs/sms/api/message#send-a-message)\n\n| Arguments | Description | Required/Conditional/Optional |\n| :--- | :----: | ---: |\n| src | Set this parameter to the sender ID you wish to use. This could a phone number, shortcode or alphanumeric string.| Conditional |\n| dst | Set this parameter to the phone number to which the message is to be delivered. | Required |\n| text | Set this parameter to the content of the text message. | Required |\n| type | Set this parameter either as \"sms\" for SMS messages or as \"mms\" for MMS messages. Defaults to sms. | Optional |\n| media_urls | A comma separated list of URL encoded hyperlinks to the images or gifs to be included in the MMS message. This is a required field if the message type is mms. | Conditional |\n| url | Set this parameter to the fully qualified URL to which status update callbacks for the message should be sent | Optional |\n| method | The HTTP method to be used when calling the url defined above. Defaults to POST when not specified. Note that only GET and POST are presently supported. | Optional |\n| log | If set to false, the text and media content of this message will not be logged on Plivo infrastructure, and the dst value will be masked (e.g., +141XXXXX528) | Optional |\n| trackable | Set this parameter to true for messages that have a trackable user action, for example, entering a 2FA verification code. Setting this parameter to true implies that you intend to update Plivo upon successful delivery of the message using the Conversion Feedback API. Read our guide on Providing Conversion Feedback for trackable SMS messages for details. This parameter defaults to false when no specified. | Optional |"
},
"response": [
{
"name": "Send SMS - Success",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"src\": \"14152225555\",\n \"dst\": \"14152223333\", // for multiple destination use - \"dst\": \"14152223333<\"14152224444\"\n \"text\": \"Hello, this is a sample text\",\n \"type\": \"sms\",\n \"url\": \"http://foo.com/sms_status/\",\n \"method\": \"POST\",\n \"log\": \"true\",\n \"trackable\": \"false\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Message/",
"protocol": "https",
"host": [
"api",
"plivo",
"com"
],
"path": [
"v1",
"Account",
"{{auth_id}}",
"Message",
""
]
}
},
"code": 202,
"_postman_previewlanguage": "json",
"header": [
],
"cookie": [
],
"body": "{\n \"message\": \"message(s) queued\",\n \"message_uuid\": [\n \"db3ce55a-7f1d-11e1-8ea7-1231380bc196\"\n ],\n \"api_id\": \"db342550-7f1d-11e1-8ea7-1231380bc196\"\n}"
}
]
}
