Message List

Brief description:

  • Retrieve and paginate messages between users via API – fetch chat history, sort by date, and load conversations in batches.

Endpoint

Method:

  • POST / GET

Parameter:

Parameter name Required Type Explain
api_key_token Yes string Your API key
guid Yes integer A UserID for messages will be listed (UserA)
to Yes integer A UserID with user is messaging (UserB)
markallread No integer 1 if you wanted to mark all messages viewed to UserA (not UserB) else leave it 0
offset No integer -
Example Response 
{
    "merchant": "Open Source Social Network",
    "url": "http:\/\/www.mywebsite.com\/",
    "time_token": 1569337647,
    "payload": {
        "list": [
            {
                "data": {},
                "id": "30",
                "message_from": {
                    "guid": "1",
                    "fullname": "System Administrator",
                    "username": "administrator",
                    "icon": {
                        "small": "http:\/\/www.mywebsite.com\/avatar\/administrator\/small\/ddfbc9f412fca49cd89c8592b6500269.jpeg"
                    }
                },
                "message_to": {
                    "guid": "27",
                    "fullname": "Meagan McLaughlin",
                    "username": "zKutch",
                    "icon": {
                        "small": "http:\/\/www.mywebsite.com\/avatar\/zKutch\/small\/8715c874616ebf0391af044f974b554e.jpeg"
                    }
                },
                "message": "Some Message",
                "viewed": "1",
                "is_deleted": "1"
                "time": "1569063785"
            },
            {
                "data": {},
                "id": "31",
                "message_from": {
                    "guid": "27",
                    "fullname": "Meagan McLaughlin",
                    "username": "zKutch",
                    "icon": {
                        "small": "http:\/\/www.mywebsite.com\/avatar\/zKutch\/small\/8715c874616ebf0391af044f974b554e.jpeg"
                    }
                },
                "message_to": {
                    "guid": "1",
                    "fullname": "System Administrator",
                    "username": "administrator",
                    "icon": {
                        "small": "http:\/\/www.mywebsite.com\/avatar\/administrator\/small\/ddfbc9f412fca49cd89c8592b6500269.jpeg"
                    }
                },
                "message": "Hi There",
                "viewed": "1",
                "time": "1569068396"
            },
        ],
        "withuser": {
            "guid": "27",
            "fullname": "Meagan McLaughlin",
            "username": "zKutch",
            "icon": {
                "small": "http:\/\/www.mywebsite.com\/avatar\/zKutch\/small\/8715c874616ebf0391af044f974b554e.jpeg"
            }
        },
        "count": "39",
        "offset": false
    },
    "code": "100",
    "message": "Request successfully executed"
}

Return payload parameter description

Parameter name Explain
list Contains all messages or it will contain false
is_deleted Existing only if message is deleted, value 1
count total messages
offset current pagination number

Services View All