Humtog API

# Message

# Get Message

# Resource URL

https://humtog.com/api/messages

# Resource Method

GET

# Params

Name Required Type Description
contact_id Yes integer Id of the user

# Example Response

{
     "data": [
        {
            "id": 5,
            "user_id": 1,
            "created_at": "2020-05-21 14:50:30",
            "read_at": "2020-05-22 12:06:19",
            "content": {
                "text": "TextMessage"
            },
            "author": {
                "id": 1,
                "username": "userName",
                "name": "fullName",
                "bio": null,
                "avatar": "/imgs/default-avatar.png",
                ...
            }
        },
        ...
    ]
}

# Create Message

# Resource URL

https://humtog.com/api/messages

# Resource Method

POST

# Params

Name Required Type Description
body Yes string Text of the message
user_id Yes integer Id of the user

# Example Response

{
     "data": [
        {
            "id": 5,
            "user_id": 1,
            "created_at": "2020-05-21 14:50:30",
            "read_at": "2020-05-22 12:06:19",
            "content": {
                "text": "TextMessage"
            },
            "author": {
                "id": 1,
                "username": "userName",
                "name": "fullName",
                "bio": null,
                "avatar": "/imgs/default-avatar.png",
                ...
            }
        },
        ...
    ]
}

# Mark Message as Read

# Resource URL

https://humtog.com/api/messages/:message_id/read

# Resource Method

POST

# Example Response

{
     "message": "Message marked as read successfully."
}

# Delete Message

# Resource URL

https://humtog.com/api/messages/:message_id

# Resource Method

DELETE

# Example Response

{
     "message": "message deleted successfully."
}

# Delete all Message

# Resource URL

https://humtog.com/api/messages

# Resource Method

DELETE

# Example Response

{
     "message": "{numberOfMessages} messages were deleted."
}

← Announcement →