Difference between revisions of "Bot Playground/Built-in Functions/http.get"

From SmartBots Developers Docs
Jump to: navigation, search
(Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Retrieves data from a HTTP source.</onlyinclude> <syntaxhighlight lang="javascript"> http.get(url, query) .then(function(respon...")
 
Line 22: Line 22:
 
{{API Variable Group|Output}}
 
{{API Variable Group|Output}}
 
{{API Return promise}}
 
{{API Return promise}}
−
{{API Variable|response}} The response object (body, serverCode, headers)
+
{{API Variable|statusCode}} (on success) The HTTP status code
−
 
+
{{API Variable|headers}} (on success) The array with HTTP headers
 +
{{API Variable|body}} (on success) The string body of the reply
 
{{API Variables Table End}}
 
{{API Variables Table End}}
  
Line 29: Line 30:
  
 
This function makes an HTTP GET request to the specified URL. The query string may be added to the URL ('''example.com/?param1=1&param2=2''') or passes as a '''query''' object ('''{ param1: 1, param2: 2 }''').
 
This function makes an HTTP GET request to the specified URL. The query string may be added to the URL ('''example.com/?param1=1&param2=2''') or passes as a '''query''' object ('''{ param1: 1, param2: 2 }''').
 +
 +
=== Limitations ===
 +
 +
The length of the body is limited to 4096 bytes.
  
 
=== Example ===
 
=== Example ===

Revision as of 14:02, 14 July 2018

Retrieves data from a HTTP source. 

http.get(url, query)
	.then(function(response) {
		...
	})
	.catch(function(err) {
		...
	});

Reference

This command accepts the following parameters:

Variable Required Description


Input:
url yes the URL to retrieve
query optional (object) the optional URL query string params


Output:
Function returns a Promise with the following data:
success bool true if command completed successfully
error string error string if command has failed
statusCode (on success) The HTTP status code
headers (on success) The array with HTTP headers
body (on success) The string body of the reply

Comments

This function makes an HTTP GET request to the specified URL. The query string may be added to the URL (example.com/?param1=1&param2=2) or passes as a query object ({ param1: 1, param2: 2 }).

Limitations

The length of the body is limited to 4096 bytes.

Example

console.log("Doing http request");

http.get("https://mysmartbots.com")
	.then(function(response) {
		console.log("http result:", response.body);
	})
	.catch(function(err) {
		console.log("error doing http:", err);
	});
Retrieved from "https://www.mysmartbots.com/dev/docs/index.php?title=Bot_Playground/Built-in_Functions/http.get&oldid=1522"