wechaty-puppet/docs/typedoc/interfaces/contactpayload.md

Abstract Puppet for Wechaty

[Wechaty Puppet v0.9.8 Interface](../README.md) > [ContactPayload](../interfaces/contactpayload.md)

# Interface: ContactPayload

## Hierarchy

**ContactPayload**

## Index

### Properties

* [address](contactpayload.md#address)
* [alias](contactpayload.md#alias)
* [avatar](contactpayload.md#avatar)
* [city](contactpayload.md#city)
* [friend](contactpayload.md#friend)
* [gender](contactpayload.md#gender)
* [id](contactpayload.md#id)
* [name](contactpayload.md#name)
* [province](contactpayload.md#province)
* [signature](contactpayload.md#signature)
* [star](contactpayload.md#star)
* [type](contactpayload.md#type)
* [weixin](contactpayload.md#weixin)

---

## Properties

<a id="address"></a>

### `<Optional>` address

**● address**: * `undefined` &#124; `string`
*

*Defined in [schemas/contact.ts:25](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L25)*

___
<a id="alias"></a>

### `<Optional>` alias

**● alias**: * `undefined` &#124; `string`
*

*Defined in [schemas/contact.ts:26](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L26)*

___
<a id="avatar"></a>

###  avatar

**● avatar**: *`string`*

*Defined in [schemas/contact.ts:23](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L23)*

___
<a id="city"></a>

### `<Optional>` city

**● city**: * `undefined` &#124; `string`
*

*Defined in [schemas/contact.ts:27](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L27)*

___
<a id="friend"></a>

### `<Optional>` friend

**● friend**: * `undefined` &#124; `true` &#124; `false`
*

*Defined in [schemas/contact.ts:28](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L28)*

___
<a id="gender"></a>

###  gender

**● gender**: *[ContactGender](../enums/contactgender.md)*

*Defined in [schemas/contact.ts:20](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L20)*

___
<a id="id"></a>

###  id

**● id**: *`string`*

*Defined in [schemas/contact.ts:19](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L19)*

___
<a id="name"></a>

###  name

**● name**: *`string`*

*Defined in [schemas/contact.ts:22](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L22)*

___
<a id="province"></a>

### `<Optional>` province

**● province**: * `undefined` &#124; `string`
*

*Defined in [schemas/contact.ts:29](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L29)*

___
<a id="signature"></a>

### `<Optional>` signature

**● signature**: * `undefined` &#124; `string`
*

*Defined in [schemas/contact.ts:30](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L30)*

___
<a id="star"></a>

### `<Optional>` star

**● star**: * `undefined` &#124; `true` &#124; `false`
*

*Defined in [schemas/contact.ts:31](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L31)*

___
<a id="type"></a>

###  type

**● type**: *[ContactType](../enums/contacttype.md)*

*Defined in [schemas/contact.ts:21](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L21)*

___
<a id="weixin"></a>

### `<Optional>` weixin

**● weixin**: * `undefined` &#124; `string`
*

*Defined in [schemas/contact.ts:32](https://github.com/Chatie/wechaty-puppet/blob/e056248/src/schemas/contact.ts#L32)*

___