Message Send

Brief description:

  • Send message to user with attachment option.

Endpoint

Method:

  • POST / GET

Parameter:

Parameter name Required Type Explain
api_key_token Yes string Your API key
from Yes integer A UserID from where message will be sent
to Yes integer A UserID who receives the message
message Yes string A msesage text

Example Response

{
    "merchant": "Open Source Social Network",
    "url": "http:\/\/www.mywebsite.com\/",
    "time_token": 1569337165,
    "payload": {
        "id": "46",
        "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": "test message",
        "viewed": "0",
        "time": "1569337165"
    },
    "code": "100",
    "message": "Request successfully executed"
}

Return payload parameter description

Parameter name Explain
message contains actual message text

Remarks

Code Explain
201 OssnMessages component not found
106 Message text can not be blank
106 Either to or from is blank
103 Either user not found
200 Message send failed

Services View All