Table of Contents

Class ConversionRequest

Namespace
Vonage.Conversions
Assembly
Vonage.dll

Represents a request to report a conversion event to the Vonage Conversion API. A conversion occurs when a user completes a desired action after receiving a message or call.

public class ConversionRequest
Inheritance
ConversionRequest
Inherited Members

Properties

Delivered

Indicates whether the user completed the desired action (conversion). Set to true if the user replied to the message, answered the call, or completed your call-to-action. Set to false otherwise.

[JsonProperty("delivered", Order = 1)]
public bool Delivered { get; set; }

Property Value

bool

MessageId

The unique identifier of the message or call being reported on. Use the appropriate ID based on the API that sent the original communication:

  • SMS API: use the message-id from the send response
  • Voice API: use the call-id from the call response
  • Verify API: use the event_id from the Verify Check response
[JsonProperty("message-id", Order = 0)]
public string MessageId { get; set; }

Property Value

string

TimeStamp

The timestamp when the user completed the conversion action, in UTC format: yyyy-MM-dd HH:mm:ss. For example: 2024-01-15 14:30:00. If not specified, Vonage uses the time the request is received.

[JsonProperty("timestamp", Order = 2)]
public string TimeStamp { get; set; }

Property Value

string