Chilkat Online Tools

Node.js / Plivo REST API / Upload Media

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";

    var req = new chilkat.HttpRequest();
    req.HttpVerb = "POST";
    req.Path = "/v1/Account/<auth_id>/Media/";
    req.ContentType = "multipart/form-data";
    success = req.AddFileForUpload2("file"," path to file","application/octet-stream");

    req.AddHeader("Expect","100-continue");

    // resp: HttpResponse
    var resp = http.SynchronousRequest("api.plivo.com",443,true,req);
    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'
	--form 'file=@"/path/to/file"'
https://api.plivo.com/v1/Account/<auth_id>/Media/

Postman Collection Item JSON

{
  "name": "Upload Media",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "file",
          "type": "file",
          "src": "/Users/mohammedhuzaif/Downloads/image.png"
        }
      ]
    },
    "url": {
      "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Media/",
      "protocol": "https",
      "host": [
        "api",
        "plivo",
        "com"
      ],
      "path": [
        "v1",
        "Account",
        "{{auth_id}}",
        "Media",
        ""
      ]
    },
    "description": "This API lets you upload media files which can be used to send MMS. Plivo supports up to a total of 10 attachments in an upload API/SDK call with a maximum of 2MB per attachment. \nMore information can be found [here](https://www.plivo.com/docs/sms/api/media#upload-media)\n\n| Arguments   | Description | Required/Conditional/Optional     |\n| :---        |    :----:   |          ---: |\n| file      | This argument allows you to attach one or more(max 10) files as attachments in the body of the request.| Required |"
  },
  "response": [
    {
      "name": "Upload Media",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "file",
              "type": "file",
              "src": "/Users/mohammedhuzaif/Downloads/image.png"
            }
          ]
        },
        "url": {
          "raw": "https://api.plivo.com/v1/Account/{{auth_id}}/Media/",
          "protocol": "https",
          "host": [
            "api",
            "plivo",
            "com"
          ],
          "path": [
            "v1",
            "Account",
            "{{auth_id}}",
            "Media",
            ""
          ]
        }
      },
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
      ],
      "cookie": [
      ],
      "body": "{\n    \"api_id\": \"<api_id>\",\n    \"objects\": [\n        {\n            \"content_type\": \"image/jpeg\",\n            \"file_name\": \"sample_file1.jpg\",\n            \"media_id\": \"<media_id>\",\n            \"size\": 85277,\n            \"status\": \"success\",\n            \"status_code\": 201,\n            \"upload_time\": \"2020-02-17T07:16:09.153289Z\",\n            \"media_url\": \"https://media.plivo.com/Account/<auth_id>/Media/<media_id>\"\n        },\n        {\n            \"content_type\": \"image/png\",\n            \"file_name\": \"sample_file2.png\",\n            \"media_id\": \"<media_id>\",\n            \"size\": 16709,\n            \"status\": \"success\",\n            \"status_code\": 201,\n            \"upload_time\": \"2020-02-18T11:21:55.972100055Z\",\n            \"media_url\": \"https://media.plivo.com/Account/<auth_id>/Media/<media_id>\"\n        }\n    ]\n}"
    }
  ]
}