Client Reference

ClientReference is an optional value that you attach to each recipient. Phonovation stores it unchanged and returns it in that recipient’s delivery receipt (DLR) webhook.

Add it to a recipient

Property names are case-sensitive. Use ClientReference exactly as shown.

Recipient with Client Reference

{
  "msisdn": "353871234567",
  "ClientReference": "appointment-88421"
}

Rules

Rule	Behavior
Required	No
Type	String or `null`
Maximum length	30 characters
Uniqueness	Not required by Phonovation
Storage	Preserved unchanged
If omitted	Stored and returned as `null`
Duplicate recipients	The first normalized recipient and its Client Reference are kept

Use a value that is meaningful inside your system, such as an appointment, order, or notification ID. Avoid phone numbers, message text, names, or other personal data.

Match the webhook

A delivery webhook returns the same property:

Delivered DLR

{
  "To": "353871234567",
  "From": "CompanyName",
  "Status": "DELIVERED",
  "ClientReference": "appointment-88421"
}

Use the value to locate your record, then update it with the delivery status. Make the update idempotent because webhook delivery can be duplicated and event order is not guaranteed.

Campaign summaries contain aggregate totals only. Use ClientReference on the DLR webhook when you need recipient-level correlation.

Webhooks

Verify signed DLRs and process Client References safely.

Get started

Core concepts

API Reference

Security and compliance

Tools

Add it to a recipient

Rules

Match the webhook

Webhooks

​Add it to a recipient

​Rules

​Match the webhook

Webhooks

Add it to a recipient

Rules

Match the webhook