Metadata

Developer-defined metadata can be sent with any type of Message. They are delivered back in Message Echo webhook.

{
  "channel": { ... },
  "contact": { ... },
  "content": { ... },
  "metadata": {
  	"any": "arbitrary data"
  }
}

🚧

Reserved metadata keywords

platform_metadata - Metadata to be sent directly to Viber API, see Platform Metadata below.

Platform Metadata

Viber API has its own concept of metadata. It's called tracking_data. You can send tracking data as a string with any message, see Viber API documentation. Amio API reserves platform_metadata keyword to be mapped to original Viber tracking_data attribute.

📘

You can use platform_metadata attribute to send tracking data directly to Viber API. This allows you to track messages and user’s replies. Tracking data are received back as metadata.platform_metadata attribute with message replies from the user.

{
  "channel": { ... },
  "contact": { ... },
  "content": { ... },
  "metadata": {
    "platform_metadata": "these data are going to be sent directly to Viber API as tracking_data attribute"
  }
}
ParameterTypeDescription
platform_metadatastringPlatform specific metadata to be sent directly to Viber API as a tracking_data attribute, see Viber API documentation. Max size 4000 characters.