# Messaging

### MessagingTracker

Defines the tracker class for the messaging semantic package

#### Example

To track an event using the messaging package, you can use the corresponding method on the tracker instance:

```ts
Bird.tracker.messaging.messageSent(event_props, event_opts);
```

#### Extends

* `Tracker`

#### Methods

**messageBounced()**

```ts
messageBounced(props?: MessagingMessageBouncedProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageBouncedProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageDelivered()**

```ts
messageDelivered(props?: MessagingMessageDeliveredProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageDeliveredProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageDeliveryFailed()**

```ts
messageDeliveryFailed(props?: MessagingMessageDeliveryFailedProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageDeliveryFailedProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageLinkClicked()**

```ts
messageLinkClicked(props?: MessagingMessageLinkClickedProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageLinkClickedProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageMarkedSpam()**

```ts
messageMarkedSpam(props?: MessagingMessageMarkedSpamProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageMarkedSpamProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageOpened()**

```ts
messageOpened(props?: MessagingMessageOpenedProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageOpenedProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageSent()**

```ts
messageSent(props?: MessagingMessageSentProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageSentProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageSubscribed()**

```ts
messageSubscribed(props?: MessagingMessageSubscribedProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageSubscribedProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

**messageUnsubscribed()**

```ts
messageUnsubscribed(props?: MessagingMessageUnsubscribedProperties, opts?: BirdEventTrackingOptions): void
```

**Parameters**

• **props?**: `MessagingMessageUnsubscribedProperties`

• **opts?**: `BirdEventTrackingOptions`

**Returns**

`void`

***

### MessagingMessageBouncedProperties

Properties for messaging/message-bounced event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageDeliveredProperties

Properties for messaging/message-delivered event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageDeliveryFailedProperties

Properties for messaging/message-delivery-failed event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property          | Type     |
| ----------------- | -------- |
| `campaign_name?`  | `string` |
| `context_id?`     | `string` |
| `failure_reason?` | `string` |
| `flow_id?`        | `string` |
| `journey_id?`     | `string` |
| `message_id?`     | `string` |
| `platform_id?`    | `string` |
| `use_case_type?`  | `string` |
| `variation?`      | `string` |

***

### MessagingMessageLinkClickedProperties

Properties for messaging/message-link-clicked event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `url?`           | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageMarkedSpamProperties

Properties for messaging/message-marked-spam event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageOpenedProperties

Properties for messaging/message-opened event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageSentProperties

Properties for messaging/message-sent event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageSubscribedProperties

Properties for messaging/message-subscribed event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |

***

### MessagingMessageUnsubscribedProperties

Properties for messaging/message-unsubscribed event

#### Indexable

\[`k`: `string`]: `unknown`

#### Properties

| Property         | Type     |
| ---------------- | -------- |
| `campaign_name?` | `string` |
| `context_id?`    | `string` |
| `flow_id?`       | `string` |
| `journey_id?`    | `string` |
| `message_id?`    | `string` |
| `platform_id?`   | `string` |
| `use_case_type?` | `string` |
| `variation?`     | `string` |