go-workwx SDK

All incoming messages from the platform share a common structure defined by rxMessageCommon. This structure contains metadata required to identify the sender, receiver, message type, and timing. You must check MsgType to determine how to parse the specific content of the message.

Common Fields:

• ToUserName: The CorpID of the enterprise.
• FromUserName: The UserID of the member.
• CreateTime: Message creation timestamp (int64).
• MsgType: The type of message (e.g., text, image, event).
• MsgID: Unique 64-bit integer ID for the message.
• AgentID: The ID of the enterprise application.
• Event: The event type (present if MsgType is event).
• ChangeType: The change type (present if Event is change_external_contact).

type MessageType string

const (
	MessageTypeText    MessageType = "text"
	MessageTypeImage   MessageType = "image"
	MessageTypeVoice   MessageType = "voice"
	MessageTypeVideo   MessageType = "video"
	MessageTypeLocation MessageType = "location"
	MessageTypeLink     MessageType = "link"
	MessageTypeEvent    MessageType = "event"
)

An ExternalProfile contains a list of ExternalAttr (attributes) that describe the contact. Attributes currently support three types:

1. Text (type: 0): Requires the text field with a value (max 12 UTF-8 characters).
2. Web (type: 1): Requires web field with url (must include http/https) and title (max 12 UTF-8 characters). To clear this attribute, both url and title must be empty.
3. Miniprogram (type: 2): Requires miniprogram field with appid (must be installed in the enterprise), pagepath, and title. To clear this attribute, both appid and title must be empty.

Note: The name of the attribute must already exist in the management console, otherwise it will be ignored.

{
  "external_profile": {
    "external_attr": [
      {
        "type": 0,
        "name": "Occupation",
        "text": { "value": "Manager" }
      },
      {
        "type": 1,
        "name": "Website",
        "web": { "url": "https://example.com", "title": "Example" }
      }
    ]
  }
}

The FollowUserInfo model describes how an enterprise member added an external contact. It provides context on the relationship, such as:

• userid: The ID of the external contact.
• remark & description: The member's notes and description for the contact.
• createtime: When the contact was added.
• add_way: The source of the addition (e.g., QR code, mobile number, group chat).
• oper_userid: The user who initiated the addition.
• tag_id: A list of enterprise tags applied to the contact by this member (personal tags are not returned in this specific view).

Note on Tags: When using FollowInfo, only enterprise tag_ids are returned; personal tags are excluded.

// FollowUserAddWay 该成员添加此客户的来源
type FollowUserAddWay int

const (
	FollowUserAddWayUnknown FollowUserAddWay = 0
	FollowUserAddWayQRCode FollowUserAddWay = 1
	FollowUserAddWayMobile FollowUserAddWay = 2
	FollowUserAddWayCard FollowUserAddWay = 3
	FollowUserAddWayGroupChat FollowUserAddWay = 4
	FollowUserAddWayAddressBook FollowUserAddWay = 5
	FollowUserAddWayWeChatContact FollowUserAddWay = 6
	FollowUserAddWayWeChatFriendApply FollowUserAddWay = 7
	FollowUserAddWayThirdParty FollowUserAddWay = 8
	FollowUserAddWayEmail FollowUserAddWay = 9
	FollowUserAddWayInternalShare FollowUserAddWay = 201
	FollowUserAddWayAdmin FollowUserAddWay = 202
)

The OAContentValue model is used to assign data to specific form controls within an application. The field you use depends on the control type defined in the OAContent object.

Depending on the MsgType, you must parse additional fields.

Text Message (rxTextMessageSpecifics)

• Content: The actual text content.

Image Message (rxImageMessageSpecifics)

• PicURL: URL of the image.
• MediaID: Media file ID (valid for 3 days; use media interfaces to download).

Voice Message (rxVoiceMessageSpecifics)

• MediaID: Voice media file ID (valid for 3 days).
• Format: Audio format (e.g., amr, speex).

Video Message (rxVideoMessageSpecifics)

• MediaID: Video media file ID (valid for 3 days).
• ThumbMediaID: Thumbnail media ID.

Location Message (rxLocationMessageSpecifics)

• Lat: Latitude.
• Lon: Longitude.
• Scale: Map zoom level.
• Label: Location description.
• AppType: Always wxwork in Enterprise WeChat.

Link Message (rxLinkMessageSpecifics)

• Title: Link title.
• Description: Link description.
• URL: Destination URL.
• PicURL: Thumbnail URL.

Events related to external customers (contacts outside the enterprise) use specific models. Most include UserID (the employee) and ExternalUserID (the customer).

Add/Edit/Half-Add Contact

• rxEventAddExternalContact: Triggered when a customer is added.
• rxEventEditExternalContact: Triggered when customer info is edited.
• rxEventAddHalfExternalContact: Triggered when a member is added without verification.
• Key Fields: State (used to identify the channel/source via 'Contact Me' config) and WelcomeCode (used to send welcome messages).

Delete/Transfer Events

• rxEventDelExternalContact: Customer deleted.
• rxEventDelFollowUser: Follower deleted.
• rxEventTransferFail: Customer transfer failed. Includes FailReason (customer_refused or customer_limit_exceed).

Group Changes

• rxEventChangeExternalChat: Triggered by changes in customer groups. Includes ChatID.