import_messages

To import messages from a file, use the exchange/import_messages command.

Copied!
svc=exchange/import_messages&params={"itemId":<long>,
				     "eventHash":<text>}

This request can’t be executed simultaneously with any request from this chapter and the following requests:

Parameters

The required parameter is marked with an asterisk (*).

Name

Description

itemId*

Item ID.

eventHash

Event name, which will be generated after messages are imported.

dontMarkImportedIf this parameter is set to 1, imported messages will not be marked as imported but as blackbox; the registration time may differ from the message time. If this parameter is missing or set to a value other than 1, messages will be marked as imported.

Loading a file

To load a file, use a POST request with multiple contents (multipart/form-data). For example:

Copied!
Request URL: https://hst-api.wialon.com/wialon/ajax.html?svc=exchange/import_messages&sid=8157df114c0e601f0f31091c3c2ac53d
Request Method: POST
Connection: keep-alive
Content-Length: 2744
Cache-Control: no-cache
Content-Type: multipart/form-data; boundary=----WebKitFormBoundarylvunQiir9AesO8qB
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
Accept-Charset: windows-1251,utf-8;q=0.7,*;q=0.3
Accept-Encoding: gzip,deflate,sdch
Accept-Language: ru,en-US;q=0.8,en;q=0.6

------WebKitFormBoundarylvunQiir9AesO8qB
Content-Disposition: form-data; name="params"

{"itemId":898446,"eventHash":"jUploadForm1372773585167"}
------WebKitFormBoundarylvunQiir9AesO8qB
Content-Disposition: form-data; name="eventHash"

jUploadForm1372773585167
------WebKitFormBoundarylvunQiir9AesO8qB
Content-Disposition: form-data; name="messages_filter_import_file"; filename="4100.zip"
Content-Type: application/zip


------WebKitFormBoundarylvunQiir9AesO8qB--

Response

If the request is completed successfully, an empty response is returned.

Copied!
{ }	

To make sure that the messages have been imported, you can execute the …/requests/avl_evts command.

Copied!
{
	"tm": <uint>,	/* current server time (UTC) */
	"events": [{
		"i": -1,
		"d": {			/* data */
		"hash": <text>,		/* upload complete */
		"msgCount": <text>	/* number of imported messages */
        }]
}

If the request is not completed, an error code is returned.

Error codes

CodeDescription
1Invalid or obsolete request SID.
4No file attached.
6Internal error.
7

One of the following errors:

  • failed to fetch the user,
  • unit not found,
  • failed to fetch the unit with the required access right (ADF_ACL_AVL_UNIT_IMPORT_MSGS).
Download PDF file
Download Word document

See also