Download OpenAPI specification:Download
Wechaty is a Conversational RPA SDK for chatbot makers. With only 6 lines of code, you can create a bot on the most popular IMs like WeChat, Whatsapp, WeCom, Gitter, etc.
Wechaty Puppet Service is the RESTful API for Wechaty API, which is build on top of the Wechaty Puppet Abstraction and the gRPC proto definition.
| contactId required | string |
| corporationRemarkStringValueDeprecated | string |
| corporationRemark | string |
{- "corporationRemarkStringValueDeprecated": "string",
- "corporationRemark": "string"
}{ }| contactId required | string |
| descriptionStringValueDeprecated | string |
| description | string |
{- "descriptionStringValueDeprecated": "string",
- "description": "string"
}{ }| contactId required | string |
| contactIdStringValueDeprecated | string @deprecated: Huan(202109): Wrapper types must not be used going forward. https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields |
{- "ids": [
- "string"
]
}| id required | string |
| aliasStringValueDeprecated | string (nullable) |
| alias | string |
{- "aliasStringValueDeprecated": "string",
- "alias": "string"
}{- "aliasStringValueDeprecated": "string",
- "alias": "string"
}| id required | string |
| type required | stringPAYLOAD_TYPE_CONTACT Enum: "PAYLOAD_TYPE_UNSPECIFIED" "PAYLOAD_TYPE_MESSAGE" "PAYLOAD_TYPE_CONTACT" "PAYLOAD_TYPE_ROOM" "PAYLOAD_TYPE_ROOM_MEMBER" "PAYLOAD_TYPE_FRIENDSHIP" |
{ }| conversationId required | string |
| contactId | string |
{- "contactId": "string"
}{- "idStringValueDeprecated": "string",
- "id": "string"
}| conversationId required | string |
object (puppetLocationPayload) | |||||||||||
| |||||||||||
{- "location": {
- "accuracy": 0.1,
- "address": "string",
- "latitude": 0.1,
- "longitude": 0.1,
- "name": "string"
}
}{- "id": "string"
}| conversationId required | string |
| miniProgramDeprecated | string (*
Huan(202110): We should use payload instead of JSON.stringify string
The compatible code will be removed after Dec 31, 2022) |
object (puppetMiniProgramPayload) |
{- "miniProgramDeprecated": "string",
- "miniProgram": {
- "appid": "string",
- "description": "string",
- "pagePath": "string",
- "iconUrl": "string",
- "shareId": "string",
- "thumbUrl": "string",
- "title": "string",
- "username": "string",
- "thumbKey": "string"
}
}{- "idStringValueDeprecated": "string",
- "id": "string"
}| conversationId required | string |
| text | string |
| mentionalIds | Array of strings (Huan(202011) FIXME: Issue #99
https://github.com/wechaty/grpc/issues/99) |
{- "text": "string",
- "mentionalIds": [
- "string"
]
}{- "idStringValueDeprecated": "string",
- "id": "string"
}| conversationId required | string |
| urlLinkDeprecated | string (*
Huan(202110): We should use payload instead of JSON.stringify string
The compatible code will be removed after Dec 31, 2022) |
object (puppetUrlLinkPayload) |
{- "urlLinkDeprecated": "string",
- "urlLink": {
- "description": "string",
- "thumbnailUrl": "string",
- "title": "string",
- "url": "string"
}
}{- "idStringValueDeprecated": "string",
- "id": "string"
}| contactId required | string |
| hello | string |
| sourceRoomIdStringValueDeprecated | string |
| sourceContactIdStringValueDeprecated | string |
object (*
"Referrer" and "Referral" refers to different things. "Referrer" is something or somebody who refers. "Referral" is the act of referring.
- https://english.stackexchange.com/questions/33135/referrer-versus-referral-versus-referer) |
{- "hello": "string",
- "sourceRoomIdStringValueDeprecated": "string",
- "sourceContactIdStringValueDeprecated": "string",
- "referrer": {
- "contactId": "string",
- "roomId": "string"
}
}{ }Friendship
| id required | string |
| payloadStringValueDeprecated | string
|
| payload | string |
{- "id": "string",
- "contactId": "string",
- "hello": "string",
- "type": "FRIENDSHIP_TYPE_UNSPECIFIED",
- "stranger": "string",
- "ticket": "string",
- "scene": "FRIENDSHIP_SCENE_TYPE_UNSPECIFIED"
}| id required | string |
| type required | stringPAYLOAD_TYPE_FRIENDSHIP Enum: "PAYLOAD_TYPE_UNSPECIFIED" "PAYLOAD_TYPE_MESSAGE" "PAYLOAD_TYPE_CONTACT" "PAYLOAD_TYPE_ROOM" "PAYLOAD_TYPE_ROOM_MEMBER" "PAYLOAD_TYPE_FRIENDSHIP" |
{ }{- "id": "string",
- "filename": "string",
- "text": "string",
- "timestampDeprecated": "string",
- "type": "MESSAGE_TYPE_UNSPECIFIED",
- "fromId": "string",
- "roomId": "string",
- "toId": "string",
- "mentionIds": [
- "string"
], - "receiveTime": "2019-08-24T14:15:22Z"
}| id required | string |
| type required | stringPAYLOAD_TYPE_MESSAGE Enum: "PAYLOAD_TYPE_UNSPECIFIED" "PAYLOAD_TYPE_MESSAGE" "PAYLOAD_TYPE_CONTACT" "PAYLOAD_TYPE_ROOM" "PAYLOAD_TYPE_ROOM_MEMBER" "PAYLOAD_TYPE_FRIENDSHIP" |
{ }{- "miniProgramDeprecated": "string",
- "miniProgram": {
- "appid": "string",
- "description": "string",
- "pagePath": "string",
- "iconUrl": "string",
- "shareId": "string",
- "thumbUrl": "string",
- "title": "string",
- "username": "string",
- "thumbKey": "string"
}
}Room Invitation
| id required | string |
| payloadStringValueDeprecated | string
@deprecated: use payload instead. Huan(202109): Wrapper types must not be used going forward. https://cloud.google.com/apis/design/design_patterns#optional_primitive_fields |
| payload | string |
{- "id": "string",
- "inviterId": "string",
- "topic": "string",
- "memberCount": 0,
- "memberIds": [
- "string"
], - "timestampUint64Deprecated": "string",
- "avatar": "string",
- "invitation": "string",
- "receiverId": "string",
- "receiveTime": "2019-08-24T14:15:22Z"
}| id required | string |
| textStringValueDeprecated | string |
| text | string |
{- "textStringValueDeprecated": "string",
- "text": "string"
}{- "textStringValueDeprecated": "string",
- "text": "string"
}| id required | string |
| type required | stringPAYLOAD_TYPE_ROOM_MEMBER Enum: "PAYLOAD_TYPE_UNSPECIFIED" "PAYLOAD_TYPE_MESSAGE" "PAYLOAD_TYPE_CONTACT" "PAYLOAD_TYPE_ROOM" "PAYLOAD_TYPE_ROOM_MEMBER" "PAYLOAD_TYPE_FRIENDSHIP" |
{ }| id required | string |
| type required | stringPAYLOAD_TYPE_ROOM Enum: "PAYLOAD_TYPE_UNSPECIFIED" "PAYLOAD_TYPE_MESSAGE" "PAYLOAD_TYPE_CONTACT" "PAYLOAD_TYPE_ROOM" "PAYLOAD_TYPE_ROOM_MEMBER" "PAYLOAD_TYPE_FRIENDSHIP" |
{ }| id | string |
{- "id": "string"
}{- "result": {
- "fileBoxChunk": {
- "data": "string",
- "name": "string"
}
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}| id | string |
| type | string (puppetImageType) Default: "IMAGE_TYPE_UNSPECIFIED" Enum: "IMAGE_TYPE_UNSPECIFIED" "IMAGE_TYPE_THUMBNAIL" "IMAGE_TYPE_HD" "IMAGE_TYPE_ARTWORK" |
{- "id": "string",
- "type": "IMAGE_TYPE_UNSPECIFIED"
}{- "fileBox": "string"
}| id | string |
| type | string (puppetImageType) Default: "IMAGE_TYPE_UNSPECIFIED" Enum: "IMAGE_TYPE_UNSPECIFIED" "IMAGE_TYPE_THUMBNAIL" "IMAGE_TYPE_HD" "IMAGE_TYPE_ARTWORK" |
{- "id": "string",
- "type": "IMAGE_TYPE_UNSPECIFIED"
}{- "result": {
- "fileBoxChunk": {
- "data": "string",
- "name": "string"
}
}, - "error": {
- "code": 0,
- "message": "string",
- "details": [
- {
- "@type": "string",
- "property1": null,
- "property2": null
}
]
}
}| conversationId | string |
| fileBox | string |
{- "conversationId": "string",
- "fileBox": "string"
}{- "idStringValueDeprecated": "string",
- "id": "string"
}(streaming inputs)
| conversationId | string (oneof payload {) |
object (puppetFileBoxChunk) |
{- "conversationId": "string",
- "fileBoxChunk": {
- "data": "string",
- "name": "string"
}
}{- "idStringValueDeprecated": "string",
- "id": "string"
}{- "id": "string",
- "gender": "CONTACT_GENDER_UNSPECIFIED",
- "type": "CONTACT_TYPE_UNSPECIFIED",
- "name": "string",
- "avatar": "string",
- "address": "string",
- "alias": "string",
- "city": "string",
- "friend": true,
- "province": "string",
- "signature": "string",
- "star": true,
- "weixin": "string",
- "corporation": "string",
- "title": "string",
- "description": "string",
- "coworker": true,
- "phones": [
- "string"
]
}