🗨️Messages

We help you manage messages with your customers safely.

Room List

GET /messages/:appId

Retrieve the list of conversation rooms with your customers.

Headers

Key	Value
Content-Type	application/json
Authorization	Bearer <token>

Query Params

Key	Description	Required
page	Current page. Default: 1.
limit	Data size per page. Default: 10. Max: 50.

Path Variables

Key	Description	Required
:appId	Application ID

Response

200

{
    "statusCode": 200,
    "code": "OK",
    "message": "The request has been successfully processed.",
    "data": [
        {
            "id": "83facc8c-11c5-11ef-8e7a-00155d34f1bf",
            "phone": 6280000000000,
            "tag": "John Doe",
            "is_blocked": false,
            "lastest": {
                "id": "5ce3b98d-eb49-43d1-85d8-8749bd5a47a2",
                "type": "text",
                "text": {
                    "body": "Lorem ipsum dolor sit amet"
                },
                "attachment": null,
                "status": "sent",
                "is_me": false,
                "received_at": "2024-05-14T15:36:03.000+07:00"
            }
        },
        // ...
    ],
    "meta": {
        "total": 2,
        "limit": 10,
        "current_page": 1,
        "first_page": 1,
        "previous_page": null,
        "next_page": null,
        "last_page": 1
    }
}

400

403

404

Message List

GET /messages/:appId/:roomId

Retrieve the list of messages from the conversation, sorted from newest to oldest.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Query Params

Key	Description	Required
page	Current page. Default: 1.
limit	Data size per page. Default: 10. Max: 50.

Path Variables

Key	Description	Required
:appId	Application ID
:roomId	Conversation ID

Response

200

{
    "statusCode": 200,
    "code": "OK",
    "message": "The request has been successfully processed.",
    "data": [
        {
            "id": "5ce3b98d-eb49-43d1-85d8-8749bd5a47a2",
            "type": "text",
            "text": {
                "body": "Lorem ipsum dolor sit amet"
            },
            "attachment": null,
            "status": "sent",
            "is_me": false,
            "received_at": "2024-05-14T15:36:03.000+07:00"
        },
        // ...
    ],
    "meta": {
        "total": 8,
        "limit": 10,
        "current_page": 1,
        "first_page": 1,
        "previous_page": null,
        "next_page": null,
        "last_page": 1
    }
}

400

403

404