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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

count

integer

required

The number of items in the result

string | null

required

The endpoint to query the next page of the result

string | null

required

The endpoint to query the previous page of the result

template_messages

array [object {6}]

read-onlyrequired

>= 0 items<= 1000 items

string

required

status

enum<string>

required

Allowed values:

sentdeliveredfailedread

liquid_values

object

read-onlyrequired

An object containing key/value pairs of variables used as part of the template message.

Example:
{"invoice": "₹1,000"}

event

object | null

required

The event that created the Template message

broadcast

object | null

required

The Broadcast the Template message belongs to

contact

object

required

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,
            "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
            }
        }
    ]
}