MessagingReport

object

rangerequired: ReportRange
totalsrequired: object
totals.queuedrequired: integer
totals.sentrequired: integer
totals.deliveredrequired: integer
totals.readrequired: integer
totals.failedrequired: integer
totals.repliedrequired: integer
totals.cost_paiserequired: Paise
Money in paise (₹1 = 100), an exact integer.
totals.delivered_pctrequired: number or null
Percent with one decimal (0–100); null without a base.
totals.read_pctrequired: number or null
Percent with one decimal (0–100); null without a base.
totals.replied_pctrequired: number or null
Percent with one decimal (0–100); null without a base.
by_channelrequired: array of object
by_channel[].channelrequired: string
by_channel[].queuedrequired: integer
by_channel[].sentrequired: integer
by_channel[].deliveredrequired: integer
by_channel[].readrequired: integer
by_channel[].failedrequired: integer
by_channel[].repliedrequired: integer
by_channel[].cost_paiserequired: Paise
Money in paise (₹1 = 100), an exact integer.
by_templaterequired: array of object
by_template[].template_idrequired: Id or null
Opaque record id.
by_template[].namerequired: string
by_template[].channelrequired: string
by_template[].categoryrequired: string or null
by_template[].queuedrequired: integer
by_template[].sentrequired: integer
by_template[].deliveredrequired: integer
by_template[].readrequired: integer
by_template[].failedrequired: integer
by_template[].repliedrequired: integer
by_template[].cost_paiserequired: Paise
Money in paise (₹1 = 100), an exact integer.
opt_outsrequired: object or null
Consent withdrawals in the range; company-wide scope only.
opt_outs.totalrequired: integer
opt_outs.by_channelrequired: array of object
opt_outs.by_channel[].channelrequired: string
opt_outs.by_channel[].countrequired: integer

Example

{
  "range": {
    "from": "2026-10-06T05:30:00.000Z",
    "to": "2026-10-06T05:30:00.000Z",
    "from_day": "2026-10-06",
    "to_day": "2026-10-06",
    "days": 0
  },
  "totals": {
    "queued": 0,
    "sent": 0,
    "delivered": 0,
    "read": 0,
    "failed": 0,
    "replied": 0,
    "cost_paise": 850000000,
    "delivered_pct": 0,
    "read_pct": 0,
    "replied_pct": 0
  },
  "by_channel": [
    {
      "channel": "string",
      "queued": 0,
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0,
      "replied": 0,
      "cost_paise": 850000000
    }
  ],
  "by_template": [
    {
      "template_id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "channel": "string",
      "category": "string",
      "queued": 0,
      "sent": 0,
      "delivered": 0,
      "read": 0,
      "failed": 0,
      "replied": 0,
      "cost_paise": 850000000
    }
  ],
  "opt_outs": {
    "total": 0,
    "by_channel": [
      {
        "channel": "string",
        "count": 0
      }
    ]
  }
}

{ "range": { "from": "2026-10-06T05:30:00.000Z", "to": "2026-10-06T05:30:00.000Z", "from_day": "2026-10-06", "to_day": "2026-10-06", "days": 0 }, "totals": { "queued": 0, "sent": 0, "delivered": 0, "read": 0, "failed": 0, "replied": 0, "cost_paise": 850000000, "delivered_pct": 0, "read_pct": 0, "replied_pct": 0 }, "by_channel": [ { "channel": "string", "queued": 0, "sent": 0, "delivered": 0, "read": 0, "failed": 0, "replied": 0, "cost_paise": 850000000 } ], "by_template": [ { "template_id": "cmusrceel0000q7kaafxqi1om", "name": "string", "channel": "string", "category": "string", "queued": 0, "sent": 0, "delivered": 0, "read": 0, "failed": 0, "replied": 0, "cost_paise": 850000000 } ], "opt_outs": { "total": 0, "by_channel": [ { "channel": "string", "count": 0 } ] } }