Calling user newMsgs method is GET action & must be Authenticated.

URL Example http://example.com/api/v1/newMsgs

Calling user Inbox method is GET action & must be Authenticated.

URL Example http://example.com/api/v1/inbox

To use pagination you will need to define MessagesPerPage & limit GET parameters

URL Example http://example.com/api/v1/inbox?limit=0&MessagesPerPage=5

Response is 2 Dimensional Array, first array for Messages info & second one for messages info

Info

Messages

Calling user Outbox method is GET action & must be Authenticated. Outbox is holding exactly the same function behavior as in Inbox.

URL Example http://example.com/api/v1/outbox http://example.com/api/v1/outbox?limit=0&MessagesPerPage=5

Calling readMsg method is GET action & must be Authenticated.

URL Example http://example.com/api/v1/readMsg?id=MsgID

The response return in multi array each first dimensional array is message and replies information, the main created message always on top and rest of replies messages are sorted by created_date ascending and is exactly have the same output property as Inbox.

The files array is only appear if attachment value is true and is may contain multi arrays for each files related to this message or reply. the only necessary parameter is attachment id which need to be passed Download Attachment API.

Files Array

Calling attachment method is GET action & must be Authenticated.

URL Example http://example.com/api/v1/attachment?id=AttachmentID

In first example you will need to pass the return into iframe if you need alternative better way you can use the other method as direct Link.

Alternative Method http://example.com/api/v1/download_attachment?id=AttachmentID&accessCode=YourAccessCode

This method does not required you to be authenticated but you will need to add your accessCode in GET Parameter to verify your credentials.

Calling deleteMsg method is GET action & must be Authenticated.

Single Message Delete Example http://example.com/api/v1/deleteMsg?id=MsgID

You can separate multi messages id by comma in order to delete multiply message in same action

URL Example http://example.com/api/v1/deleteMsg?id=MsgID1,MsgID2,MsgID3,MsgID4

Calling compose_message method is POST action & must be Authenticated. Because Composing new message may contain single or multi attachments so the form enctype should be multipart/form-data.

URL Form Action Example http://example.com/api/v1/compose_message

In this method we should use the following input parameters in the post form.

var form = new FormData();
form.append("toUserID", "250");
form.append("subject", "Another TEst");
form.append("message", "Message");
form.append("attachment[]", "mamaafrica.jpg");
 
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "http://example.com/api/v1/compose_message",
  "method": "POST",
  "headers": {
    "access-code": "YOUR_ACCESS_CODE"
  },
  "processData": false,
  "contentType": false,
  "mimeType": "multipart/form-data",
  "data": form
}
 
$.ajax(settings).done(function (response) {
  console.log(response);
});

Calling users_search method is GET action & must be Authenticated.

Example http://example.com/api/v1/users_search

If you using autocomplete ajax function you can always use User input to “q” parameter to get more accurate users. The search query parameter will always looking after User full_name

Example http://example.com/api/v1/users_search?q=Keyword

Default Response

Example: http://example.com/api/v1/users_search?showInText=1

showInText Response

jQuery Example

Include select2.js

<script type="text/javascript">
    $(document).ready(function() {
        $('#Sendto').select2({
            placeholder: "Search for User",
            allowClear: true,
            minimumInputLength: 0,
            multiple: false,
            ajax: {
                params: {headers: {"ACCESS-CODE": "UserAccessCode"}},
                url: "http://example.com/api/v1/users_search?showInText=1", //showIntext make it easy
                dataType: 'json',
                data: function(term, page) {
                    return {
                        q: term
                    };
                },
                results: function(data, page) {
                    return {
                        results: data
                    };
                }
            }
        });
    });
</script>

<input type="text" name="to_userid" id="Sendto" />