Http

Estimated reading time: 2 minutes

The Http class can be used to make REST calls to a request endpoint and receive data asynchronously.

Constructor

Http()
The constructor initializes the Http class. It must be called before you perform any method calls.

Properties

To make an HTTP call you can set the following properties for an Http class object.

Http.url

Both http and https URL are supported. You can also pass authentication information in URL. For example, https://username:password@yourapiurl.com

Only connections to safe url endpoints are allowed. A list of urls considered safe is [available here]. If you wish to connect to an API endpoint which is on a domain not listed in our safe list, please file a support request by writing to support@mesibo.com. Also note that there is no option to connect to a proxy or redirecting your request.

Http.post

Raw post data. Provide that post data as per the format required for your API request.

Http.contentType

Content-Type header. You can request the resoponse to be of a particular type. For example, “application/json”.

Http.headers

Any custom headers you like to send, such as contain Authorisation header, etc

Http.userAgent

User Agent, default mesibo/x.x

Http.referrer

HTTP referer header

Http.origin

HTTP origin header

Http.cookie

Send HTTP Cookie Header

Http.encoding

HTTP content encoding header

Http.cacheControl

HTTP cache control header

Http.ondata

An event listener to be called when a response is received from the server.

The response to the request will be null if the request was unsuccessful. To check the error you can inspect the response status code using the property Http.respCode.

Http.response

HTTP Response data

Http.respType

Returns the type of the response, can be json, blob, text, xml, etc.

Http.respCode

Returns the status code of the response. For example, if your request is successful and the response is valid the response code is 200.

Methods

Http.send()

Make an HTTP request

Http.abort()

Abort an ongoing request

Example

mesibo.onmessage = function(p){
	var req = new Http();
	req.url = "https://example.com";
	req.post = {"t": "test"};	
	req.ondata = function(f){
		print(f.response);
                print('ondata called: ' + f.result + " " + f.respCode +  " " + f.respType);
	}
	req.send();
}

Usage notes

Global instantiation restriction

An object of the class Http cannot be instantiated in global context. Ensure that you are creating the instance inside a scoped area or function.

chatbot, script, scripting