Poll template messages status

Poll the delivery status of the template messages sent from the account, ordered by the last time they were updated.

Template messages can be filtered by the Broadcast that they belong to, as well as the time since they were last updated, which defaults to 24 hours ago.

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "count": 3,
    "next": "https://app.trypeach.io/api/v1/template_messages?page=2&per=3",
    "prev": null,
    "template_messages": [
        {
            "id": "cmsg_1234abcd",
            "status": "sent",
            "liquid_values": {
                "cta_1": "Foo",
                "account_name": "John Doe"
            },
            "event": {
                "id": "evt_1234abcd",
                "status": "processed",
                "event_url": "https://app.trypeach.io/api/v1/events/evt_1234abcd"
            },
            "broadcast": null,
            "message_events": [
                {
                    "event_type": "sent",
                    "created_at": "2025-05-28T10:11:29.744Z"
                },
                {
                    "event_type": "delivered",
                    "created_at": "2025-05-28T10:11:31.466Z"
                },
                {
                    "event_type": "read",
                    "created_at": "2025-05-28T10:12:16.529Z"
                }
            ],
            "contact": {
                "id": 1,
                "account_id": 1,
                "name": "John Doe",
                "phone_number": "+919988776655",
                "first_name": "John",
                "last_name": "Doe",
                "country_code": "91",
                "language": "en"
            }
        },
        {
            "id": "cmsg_2345bcde",
            "status": "sent",
            "liquid_values": {
                "cta_1": null,
                "account_name": "Jane Doe"
            },
            "event": null,
            "broadcast": {
                "id": "cmp_12345abcd",
                "name": "Instant Broadcast via API",
                "broadcast_url": "https://app.trypeach.io/api/v1/events/evt_8wn0RK4qrxVvUJLpyNxebJgZ"
            },
            "contact": {
                "id": 2,
                "account_id": 1,
                "name": "Jane Doe",
                "phone_number": "+918877665544",
                "first_name": "Jane",
                "last_name": "Doe",
                "country_code": "91",
                "language": null
            }
        }
    ]
}