externalcontact

README

企业微信 客户联系部分

相关文档正在梳理中...

Documentation

Index

• Constants
• type AddCropTagItem
• type AddCropTagRequest
• type AddCropTagResponse
• type BatchGetExternalUserDetailsRequest
• type Client
  • func NewClient(ctx *context.Context) *Client
  • func (r *Client) AddCropTag(req AddCropTagRequest) (*TagGroup, error)
  • func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUser, error)
  • func (r *Client) DeleteCropTag(req DeleteCropTagRequest) error
  • func (r *Client) EditCropTag(req EditCropTagRequest) error
  • func (r *Client) GetCropTagList(req GetCropTagRequest) ([]TagGroup, error)
  • func (r *Client) GetExternalUserDetail(externalUserID string, nextCursor ...string) (*ExternalUser, error)
  • func (r *Client) GetExternalUserList(userID string) ([]string, error)
  • func (r *Client) GetFollowUserList() ([]string, error)
  • func (r *Client) MarkTag(request MarkTagRequest) error
  • func (r *Client) UpdateUserRemark(request UpdateUserRemarkRequest) error
• type DeleteCropTagRequest
• type EditCropTagRequest
• type ExternalUser
• type ExternalUserDetailListResponse
• type ExternalUserDetailResponse
• type ExternalUserListResponse
• type FollowUser
• type GetCropTagListResponse
• type GetCropTagRequest
• type MarkTagRequest
• type Tag
• type TagGroup
• type TagGroupTagItem
• type UpdateUserRemarkRequest
• type WechatChannel

Constants

const (
	// FetchExternalContactUserListURL 获取客户列表
	FetchExternalContactUserListURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list"
	// FetchExternalContactUserDetailURL 获取客户详情
	FetchExternalContactUserDetailURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get"
	// FetchBatchExternalContactUserDetailURL 批量获取客户详情
	FetchBatchExternalContactUserDetailURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch/get_by_user"
	// UpdateUserRemarkURL 更新客户备注信息
	UpdateUserRemarkURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remark"
)

const (
	// GetCropTagURL 获取标签列表
	GetCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_corp_tag_list"
	// AddCropTagURL 添加标签
	AddCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag"
	// EditCropTagURL 修改标签
	EditCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/edit_corp_tag"
	// DelCropTagURL 删除标签
	DelCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag"
	// MarkCropTagURL 为客户打上、删除标签
	MarkCropTagURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/mark_tag"
)

const (
	// FetchFollowUserListURL 获取配置了客户联系功能的成员列表
	FetchFollowUserListURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_follow_user_list"
)

Types

type AddCropTagItem

type AddCropTagItem struct {
	Name  string `json:"name"`
	Order int    `json:"order"`
}

AddCropTagItem 添加企业标签子项

type AddCropTagRequest

type AddCropTagRequest struct {
	GroupID   string           `json:"group_id"`
	GroupName string           `json:"group_name"`
	Order     int              `json:"order"`
	Tag       []AddCropTagItem `json:"tag"`
	AgentID   int              `json:"agentid"`
}

AddCropTagRequest 添加企业标签请求

type AddCropTagResponse

type AddCropTagResponse struct {
	util.CommonError
	TagGroup TagGroup `json:"tag_group"`
}

AddCropTagResponse 添加企业标签响应

type BatchGetExternalUserDetailsRequest

type BatchGetExternalUserDetailsRequest struct {
	UserIDList []string `json:"userid_list"`
	Cursor     string   `json:"cursor"`
}

BatchGetExternalUserDetailsRequest 批量获取外部联系人详情请求

type Client

type Client struct {
	*context.Context
}

Client 外部联系接口实例

func NewClient

func NewClient(ctx *context.Context) *Client

NewClient 初始化实例

func (*Client) AddCropTag

func (r *Client) AddCropTag(req AddCropTagRequest) (*TagGroup, error)

AddCropTag 添加企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117

func (*Client) BatchGetExternalUserDetails

func (r *Client) BatchGetExternalUserDetails(request BatchGetExternalUserDetailsRequest) ([]ExternalUser, error)

BatchGetExternalUserDetails 批量获取外部联系人详情

func (*Client) DeleteCropTag

func (r *Client) DeleteCropTag(req DeleteCropTagRequest) error

DeleteCropTag 删除企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117

func (*Client) EditCropTag

func (r *Client) EditCropTag(req EditCropTagRequest) error

EditCropTag 修改企业客户标签 @see https://developer.work.weixin.qq.com/document/path/92117

func (*Client) GetCropTagList

func (r *Client) GetCropTagList(req GetCropTagRequest) ([]TagGroup, error)

GetCropTagList 获取企业标签库 @see https://developer.work.weixin.qq.com/document/path/92117

func (*Client) GetExternalUserDetail

func (r *Client) GetExternalUserDetail(externalUserID string, nextCursor ...string) (*ExternalUser, error)

GetExternalUserDetail 获取外部联系人详情

func (*Client) GetExternalUserList

func (r *Client) GetExternalUserList(userID string) ([]string, error)

GetExternalUserList 获取客户列表 @see https://developer.work.weixin.qq.com/document/path/92113

func (*Client) GetFollowUserList

func (r *Client) GetFollowUserList() ([]string, error)

GetFollowUserList 获取配置了客户联系功能的成员列表 @see https://developer.work.weixin.qq.com/document/path/92571

func (*Client) MarkTag

func (r *Client) MarkTag(request MarkTagRequest) error

MarkTag 为客户打上标签 @see https://developer.work.weixin.qq.com/document/path/92118

func (*Client) UpdateUserRemark

func (r *Client) UpdateUserRemark(request UpdateUserRemarkRequest) error

UpdateUserRemark 修改客户备注信息

type DeleteCropTagRequest

type DeleteCropTagRequest struct {
	TagID   []string `json:"tag_id"`
	GroupID []string `json:"group_id"`
	AgentID string   `json:"agent_id"`
}

DeleteCropTagRequest 删除企业标签请求

type EditCropTagRequest

type EditCropTagRequest struct {
	ID      string `json:"id"`
	Name    string `json:"name"`
	Order   int    `json:"order"`
	AgentID string `json:"agent_id"`
}

EditCropTagRequest 编辑客户企业标签请求

type ExternalUser

type ExternalUser struct {
	ExternalUserID  string       `json:"external_userid"`
	Name            string       `json:"name"`
	Avatar          string       `json:"avatar"`
	Type            int64        `json:"type"`
	Gender          int64        `json:"gender"`
	UnionID         string       `json:"unionid"`
	Position        string       `json:"position"`
	CorpName        string       `json:"corp_name"`
	CorpFullName    string       `json:"corp_full_name"`
	ExternalProfile string       `json:"external_profile"`
	FollowUser      []FollowUser `json:"follow_user"`
	NextCursor      string       `json:"next_cursor"`
}

ExternalUser 外部联系人

type ExternalUserDetailListResponse

type ExternalUserDetailListResponse struct {
	util.CommonError
	ExternalContactList []ExternalUser `json:"external_contact_list"`
}

ExternalUserDetailListResponse 批量获取外部联系人详情响应

type ExternalUserDetailResponse

type ExternalUserDetailResponse struct {
	util.CommonError
	ExternalUser
}

ExternalUserDetailResponse 外部联系人详情响应

type ExternalUserListResponse

type ExternalUserListResponse struct {
	util.CommonError
	ExternalUserID []string `json:"external_userid"`
}

ExternalUserListResponse 外部联系人列表响应

type FollowUser

type FollowUser struct {
	UserID         string        `json:"userid"`
	Remark         string        `json:"remark"`
	Description    string        `json:"description"`
	CreateTime     string        `json:"create_time"`
	Tags           []Tag         `json:"tags"`
	RemarkCorpName string        `json:"remark_corp_name"`
	RemarkMobiles  []string      `json:"remark_mobiles"`
	OperUserID     string        `json:"oper_userid"`
	AddWay         int64         `json:"add_way"`
	WeChatChannels WechatChannel `json:"wechat_channels"`
	State          string        `json:"state"`
}

FollowUser 跟进用户（指企业内部用户）

type GetCropTagListResponse

type GetCropTagListResponse struct {
	util.CommonError
	TagGroup []TagGroup `json:"tag_group"`
}

GetCropTagListResponse 获取企业标签列表响应

type GetCropTagRequest

type GetCropTagRequest struct {
	TagID   []string `json:"tag_id"`
	GroupID []string `json:"group_id"`
}

GetCropTagRequest 获取企业标签请求

type MarkTagRequest

type MarkTagRequest struct {
	UserID         string   `json:"user_id"`
	ExternalUserID string   `json:"external_userid"`
	AddTag         []string `json:"add_tag"`
	RemoveTag      []string `json:"remove_tag"`
}

MarkTagRequest 给客户打标签请求

type Tag

type Tag struct {
	GroupName string `json:"group_name"`
	TagName   string `json:"tag_name"`
	Type      int64  `json:"type"`
	TagID     string `json:"tag_id"`
}

Tag 已绑定在外部联系人的标签

type TagGroup

type TagGroup struct {
	GroupID    string            `json:"group_id"`
	GroupName  string            `json:"group_name"`
	CreateTime string            `json:"create_time"`
	GroupOrder int               `json:"group_order"`
	Deleted    bool              `json:"deleted"`
	Tag        []TagGroupTagItem `json:"tag"`
}

TagGroup 企业标签组

type TagGroupTagItem

type TagGroupTagItem struct {
	ID         string `json:"id"`
	Name       string `json:"name"`
	CreateTime int    `json:"create_time"`
	Order      int    `json:"order"`
	Deleted    bool   `json:"deleted"`
}

TagGroupTagItem 企业标签内的子项

type UpdateUserRemarkRequest

type UpdateUserRemarkRequest struct {
	UserID           string   `json:"userid"`
	ExternalUserID   string   `json:"external_userid"`
	Remark           string   `json:"remark"`
	Description      string   `json:"description"`
	RemarkCompany    string   `json:"remark_company"`
	RemarkMobiles    []string `json:"remark_mobiles"`
	RemarkPicMediaid string   `json:"remark_pic_mediaid"`
}

UpdateUserRemarkRequest 修改客户备注信息请求体

type WechatChannel

type WechatChannel struct {
	NickName string `json:"nickname"`
	Source   string `json:"source"`
}

WechatChannel 视频号添加的场景