work

package
v1.0.37 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 28, 2022 License: Zlib Imports: 17 Imported by: 0

Documentation

Overview

*

  • 企业微信处理（发消息，服务于报警）

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AGGetDetail added in v1.0.23 

func AGGetDetail(api *token.Api)

AGGetDetail 获取指定的应用详情 对于互联企业的应用，如果需要获取应用可见范围内其他互联企业的部门与成员，请调用互联企业-获取应用可见范围接口 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/agent/get?access_token=ACCESS_TOKEN&agentid=AGENTID

func BatchUserIdToOpenUserId added in v1.0.0 

func BatchUserIdToOpenUserId(api *token.Api, user *structs.UserIdReq) (*structs.OpenUserId, error)

BatchUserIdToOpenUserId userid的转换 doc: https://developer.work.weixin.qq.com/document/path/95435 将企业主体下的明文userid转换为服务商主体下的密文userid。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/batch/userid_to_openuserid?access_token=ACCESS_TOKEN

func DPCreate added in v1.0.34 

func DPCreate(api *token.Api, dep *structs.Department) error

DPCreate 创建部门 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/department/create?access_token=ACCESS_TOKEN

func DPDelete added in v1.0.35 

func DPDelete(api *token.Api, departId string) error

DPDelete 删除部门 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/department/delete?access_token=ACCESS_TOKEN&id=ID

func DPGetDetail added in v1.0.35 

func DPGetDetail(api *token.Api, id string) (*structs.Department, error)

DPGetDetail 获取单个部门详情 企业通讯录安全特别重要，企业微信将持续升级加固通讯录接口的安全机制，以下是关键的变更点： 【重要】从2022年8月15日10点开始，“企业管理后台 - 管理工具 - 通讯录同步”的新增IP将不能再调用此接口，企业可通过「获取部门ID列表」接口获取部门ID列表。查看调整详情。 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/department/get?access_token=ACCESS_TOKEN&id=ID

func DPGetList added in v1.0.34 

func DPGetList(api *token.Api, id string) ([]structs.Department, error)

DPGetList 获取部门列表 企业通讯录安全特别重要，企业微信将持续升级加固通讯录接口的安全机制，以下是关键的变更点： 【重要】从2022年8月15日10点开始，“企业管理后台 - 管理工具 - 通讯录同步”的新增IP将不能再调用此接口，企业可通过「获取部门ID列表」接口获取部门ID列表。查看调整详情。 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/department/list?access_token=ACCESS_TOKEN&id=ID

func DPGetListId added in v1.0.35 

func DPGetListId(api *token.Api, id string) ([]structs.DepartmentId, error)

DPGetListId 获取子部门ID列表 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/department/simplelist?access_token=ACCESS_TOKEN&id=ID

func DPUpdate added in v1.0.35 

func DPUpdate(api *token.Api, dep *structs.Department) error

DPUpdate 更新部门 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/department/update?access_token=ACCESS_TOKEN

func ECAddMsgTemplate added in v1.0.0 

func ECAddMsgTemplate(corp *token.Api, req *structs.ExMsgTemplate) (*structs.MsgTemplateRes, error)

ECAddMsgTemplate 添加企业群发消息模板 企业可通过此接口添加企业群发消息的模板并通知客服人员发送给相关客户。（注：企业微信终端需升级到2.7.5版本及以上） 注意：调用该接口并不会直接发送消息给客户，需要相关的客服人员操作以后才会实际发送（客服人员的企业微信需要升级到2.7.5及以上版本） 同一个企业对一个客户一个自然周内（周一至周日）至多只能发送一条消息，超过限制的用户将会被忽略。

func ECAddTag added in v1.0.34 

func ECAddTag(corp *token.Api, req *structs.AddTagReq) ([]*structs.TagGroup, error)

ECAddTag 添加企业客户标签 企业可通过此接口向客户标签库中添加新的标签组和标签，每个企业最多可配置3000个企业标签。 请求方式: POST(HTTP) 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_corp_tag?access_token=ACCESS_TOKEN

func ECBatchDetail added in v1.0.0 

func ECBatchDetail(corp *token.Api, batch *structs.BatchUserId) ([]*structs.ExternalContactDetail, string, error)

ECBatchDetail 批量获取客户详情 企业/第三方可通过此接口获取指定成员添加的客户信息列表。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/batch/get_by_user?access_token=ACCESS_TOKEN

func ECDeleteTag added in v1.0.34 

func ECDeleteTag(corp *token.Api, tags []string, groups []string, agentId string) error

ECDeleteTag 删除企业客户标签 企业可通过此接口删除客户标签库中的标签，或删除整个标签组。 请求方式: POST(HTTP) 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_corp_tag?access_token=ACCESS_TOKEN

func ECEditTag added in v1.0.34 

func ECEditTag(corp *token.Api, req *structs.EditTagReq) error

ECEditTag 编辑企业客户标签 企业可通过此接口编辑客户标签/标签组的名称或次序值。 请求方式: POST(HTTP) 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/edit_corp_tag?access_token=ACCESS_TOKEN

func ECFollowUserList added in v1.0.0 

func ECFollowUserList(corp *token.Api) ([]string, error)

ECFollowUserList 获取配置了客户联系功能的成员列表 企业和第三方服务商可通过此接口获取配置了客户联系功能的成员列表。 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_follow_user_list?access_token=ACCESS_TOKEN

func ECGetDetail added in v1.0.0 

func ECGetDetail(corp *token.Api, externalUserid string, cursor string) (*structs.ExternalContactDetail, string, error)

ECGetDetail 获取客户详情 企业可通过此接口，根据外部联系人的userid（如何获取?），拉取客户详情。 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get?access_token=ACCESS_TOKEN&external_userid=EXTERNAL_USERID&cursor=CURSOR

func ECGetGroupMsgList added in v1.0.34 

func ECGetGroupMsgList(corp *token.Api, req *structs.GroupMsgReq) ([]*structs.GroupMsg, string, error)

ECGetGroupMsgList 获取群发记录列表 企业和第三方应用可通过此接口获取企业与成员的群发记录。 请求方式：POST(HTTPS) 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_groupmsg_list_v2?access_token=ACCESS_TOKEN

func ECGetList added in v1.0.0 

func ECGetList(corp *token.Api, userid string) ([]string, error)

ECGetList 获取外部联系人列表 企业可通过此接口获取指定成员添加的客户列表。客户是指配置了客户联系功能的成员所添加的外部联系人。

func ECGetNewExternalUserId added in v1.0.0 

func ECGetNewExternalUserId(corp *token.Api, externalUseridList []string) (string, error)

ECGetNewExternalUserId external_userid的转换 将企业主体下的external_userid转换为服务商主体下的external_userid。 转换客户external_userid 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_new_external_userid?access_token=ACCESS_TOKEN

func ECGetTagList added in v1.0.34 

func ECGetTagList(corp *token.Api, tags []string, groups []string) ([]*structs.TagGroup, error)

ECGetTagList 获取企业标签库 企业可通过此接口获取企业客户标签详情。 请求方式: POST(HTTP) 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_corp_tag_list?access_token=ACCESS_TOKEN

func ECGroupDetail added in v1.0.0 

func ECGroupDetail(corp *token.Api, chatId string, needName int) (*structs.GroupChatDetail, error)

ECGroupDetail 获取客户群详情 通过客户群ID，获取详情。包括群名、群成员列表、群成员入群时间、入群方式。（客户群是由具有客户群使用权限的成员创建的外部群） 需注意的是，如果发生群信息变动，会立即收到群变更事件，但是部分信息是异步处理，可能需要等一段时间调此接口才能得到最新结果 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get?access_token=ACCESS_TOKEN

func ECGroupList added in v1.0.0 

func ECGroupList(corp *token.Api, req *structs.ExternalGroupListReq) ([]*structs.GroupChat, string, error)

ECGroupList 获取客户群列表 该接口用于获取配置过客户群管理的客户群列表。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/list?access_token=ACCESS_TOKEN

func ECGroupNewExternalUserId added in v1.0.0 

func ECGroupNewExternalUserId(corp *token.Api, chatId string, externalUseridList []string) (string, error)

ECGroupNewExternalUserId 转换客户群成员external_userid 转换客户external_userid接口不支持客户群的场景，如果需要转换客户群中无好友关系的群成员external_userid，需要调用本接口，调用时需要传入客户群的chat_id。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/groupchat/get_new_external_userid?access_token=ACCESS_TOKEN

func ECMarkTag added in v1.0.34 

func ECMarkTag(corp *token.Api, tags *structs.MarkTagReq) error

ECMarkTag 编辑客户企业标签 企业可通过此接口为指定成员的客户添加上由企业统一配置的标签。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/mark_tag?access_token=ACCESS_TOKEN

func ECOpenGroupIdToChatId added in v1.0.0 

func ECOpenGroupIdToChatId(corp *token.Api, groupId string) (string, error)

ECOpenGroupIdToChatId 客户群opengid转换 用户在微信里的客户群里打开小程序时，某些场景下可以获取到群的opengid，如果该群是企业微信的客户群，则企业或第三方可以调用此接口将一个opengid转换为客户群chat_id 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/opengid_to_chatid?access_token=ACCESS_TOKEN

func ECRemark added in v1.0.34 

func ECRemark(corp *token.Api, remark *structs.ExternalRemark) error

ECRemark 修改客户备注信息 企业可通过此接口修改指定用户添加的客户的备注信息。 请求方式: POST(HTTP) 请求地址:https://qyapi.weixin.qq.com/cgi-bin/externalcontact/remark?access_token=ACCESS_TOKEN

func ECServiceToExternalUserid added in v1.0.34 

func ECServiceToExternalUserid(corp *token.Api, externalUserid string) (string, error)

ECServiceToExternalUserid 代开发应用external_userid转换 企业同时授权了服务商的第三方应用与代开发应用，服务商可使用该接口将代开发应用获取到的external_userid转换为第三方应用的external_userid， 从而进行关联映射。 若代开发自建应用已升级（升级说明见 代开发应用安全性升级），则获取到的external_userid与第三方应用一致，故无须调用该接口。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/to_service_external_userid?access_token=ACCESS_TOKEN

func ECUnionidToExternalUserid added in v1.0.34 

func ECUnionidToExternalUserid(corp *token.Api, unionid, openId string) (string, error)

ECUnionidToExternalUserid 企业主体unionid转换为第三方external_userid 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/unionid_to_external_userid?access_token=ACCESS_TOKEN

func GetAccessToken 

func GetAccessToken(tk token.Token, d data.D) (access.Token, error)

func GetCorpService added in v1.0.28 

func GetCorpService() token.Service

func GetProviderService added in v1.0.28 

func GetProviderService() token.Service

func GetService added in v1.0.28 

func GetService() token.Service

func GetSuiteService added in v1.0.28 

func GetSuiteService() token.Service

func IsTokenExpired 

func IsTokenExpired(code int32) bool

func MigrateToCustomizedApp added in v1.0.0 

func MigrateToCustomizedApp(api *token.Api, suiteAccessToken string) error

MigrateToCustomizedApp 自建应用迁移成代开发自建应用 该API可以将企业的自建应用关联到服务商的代开发应用模版上，从而将自建应用转换成代开发应用。测试企业的任意自建应用均可调用该接口；若非测试企业，则仅服务商管理端“历史应用迁移”列表中的应用可调用。 请求方式：POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/agent/migrate_to_customized_app?access_token=ACCESS_TOKEN

func NewCorpToken added in v1.0.15 

func NewCorpToken(app token.App) token.Token

func NewMessage 

func NewMessage(toWho structs.ToWho, msgType string, msg interface{}) structs.Message

func NewProviderToken added in v1.0.14 

func NewProviderToken(app token.App) token.Token

func NewSuiteToken added in v1.0.14 

func NewSuiteToken(app token.App) token.Token

func NewToken 

func NewToken(app token.App) token.Token

func ProviderTokenUrl added in v1.0.19 

func ProviderTokenUrl(acsKey string, uri string) string

func SendMessage 

func SendMessage(api *token.Api, msg structs.Message) error

SendMessage 发送应用消息,群聊消息,客户欢迎语

func SuiteTokenUrl added in v1.0.19 

func SuiteTokenUrl(acsKey string, uri string) string

func TAGAddUser added in v1.0.35 

func TAGAddUser(api *token.Api, tag *UserTag) error

TAGAddUser 增加标签成员 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/addtagusers?access_token=ACCESS_TOKEN

func TAGCreate added in v1.0.35 

func TAGCreate(api *token.Api, tag *Tag) (string, error)

TAGCreate 创建标签 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/create?access_token=ACCESS_TOKEN

func TAGDelete added in v1.0.35 

func TAGDelete(api *token.Api, tagId int64) error

TAGDelete 删除标签 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/delete?access_token=ACCESS_TOKEN&tagid=TAGID

func TAGDeleteUser added in v1.0.35 

func TAGDeleteUser(api *token.Api, tag *UserTag) error

TAGDeleteUser 删除标签成员 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/deltagusers?access_token=ACCESS_TOKEN

func TAGUpdate added in v1.0.35 

func TAGUpdate(api *token.Api, tag *Tag) error

TAGUpdate 更新标签名字 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/update?access_token=ACCESS_TOKEN

func USBatchDelete added in v1.0.2 

func USBatchDelete(api *token.Api, userid []string) error

USBatchDelete 批量删除成员 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/batchdelete?access_token=ACCESS_TOKEN

func USCreate added in v1.0.2 

func USCreate(api *token.Api, user *structs.CreateUser) error

USCreate 创建成员 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/create?access_token=ACCESS_TOKEN

func USDelete added in v1.0.2 

func USDelete(api *token.Api, userid string) error

USDelete 删除成员 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/delete?access_token=ACCESS_TOKEN&userid=USERID

func USFindByMobile added in v1.0.2 

func USFindByMobile(api *token.Api, mobile string) (string, error)

USFindByMobile 手机号获取userid 通过手机号获取其所对应的userid。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/getuserid?access_token=ACCESS_TOKEN

func USGetInfoByTicket added in v1.0.23 

func USGetInfoByTicket(api *token.Api, ticket string) (*structs.UserInfo, error)

USGetInfoByTicket 获取访问用户敏感信息 自建应用与代开发应用可通过该接口获取成员授权的敏感字段 对于自建应用与代开发应用，敏感字段需要管理员在应用详情里选择，且成员oauth2授权时确认后才返回。 敏感字段包括：性别、头像、员工个人二维码、手机、邮箱、企业邮箱、地址。 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/auth/getuserdetail?access_token=ACCESS_TOKEN

func USGetInfoWithCode added in v1.0.0 

func USGetInfoWithCode(api *token.Api, code string) (*structs.UserInfoWithCode, error)

USGetInfoWithCode 获取访问用户身份 该接口用于根据code获取成员信息 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/auth/getuserinfo?access_token=ACCESS_TOKEN&code=CODE

func USGetList added in v1.0.0 

func USGetList(api *token.Api, cursor string, limit int) ([]structs.DepUser, error)

func USUpdate added in v1.0.2 

func USUpdate(api *token.Api, user *structs.CreateUser) error

USUpdate 更新成员 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/user/update?access_token=ACCESS_TOKEN

func USUserId2OpenId added in v1.0.2 

func USUserId2OpenId(api *token.Api, userid string) (string, error)

USUserId2OpenId userid转openid 该接口使用场景为企业支付，在使用企业红包和向员工付款时，需要自行将企业微信的userid转成openid。 注：需要成员使用微信登录企业微信或者关注微信插件（原企业号）才能转成openid; 如果是外部联系人，请使用外部联系人openid转换转换openid 请求方式：POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/user/convert_to_openid?access_token=ACCESS_TOKEN

Types

type AgentBase added in v1.0.23 

type AgentBase struct {
	AgentId       int    `json:"agentid"`
	Name          string `json:"name"`
	SquareLogoUrl string `json:"square_logo_url"`
}

func AGGetList added in v1.0.23 

func AGGetList(api *token.Api) ([]AgentBase, error)

AGGetList 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/agent/list?access_token=ACCESS_TOKEN

type AgentDetail added in v1.0.23 

type AgentDetail struct {
	AgentBase
	Description             string         `json:"description"`
	AllowUserInfos          AllowUserinfos `json:"allow_userinfos"`
	AllowPartys             AllowPartys    `json:"allow_partys"`
	AllowTags               AllowTags      `json:"allow_tags"`
	Close                   int            `json:"close"`
	RedirectDomain          string         `json:"redirect_domain"`
	ReportLocationFlag      int            `json:"report_location_flag"`
	Isreportenter           int            `json:"isreportenter"`
	HomeUrl                 string         `json:"home_url"`
	CustomizedPublishStatus int            `json:"customized_publish_status"`
}

type AllowPartys added in v1.0.23 

type AllowPartys struct {
	Partyid []int `json:"partyid"`
}

type AllowTags added in v1.0.23 

type AllowTags struct {
	Tagid []int `json:"tagid"`
}

type AllowUser added in v1.0.23 

type AllowUser struct {
	Userid string `json:"userid"`
}

type AllowUserinfos added in v1.0.23 

type AllowUserinfos struct {
	User []AllowUser `json:"user"`
}

type ExternalUseridInfo added in v1.0.34 

type ExternalUseridInfo struct {
	CorpId         string `json:"corpid"`
	ExternalUserid string `json:"external_userid"`
}

func ECUnionidToExternalUserid3rd added in v1.0.34 

func ECUnionidToExternalUserid3rd(corp *token.Api, unionid, openId string) ([]*ExternalUseridInfo, error)

ECUnionidToExternalUserid3rd 第三方主体unionid转换为第三方external_userid 请求方式：POST（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/externalcontact/unionid_to_external_userid_3rd?suite_access_token=ACCESS_TOKEN

type Tag added in v1.0.35 

type Tag struct {
	TagId   int64  `json:"tagid,omitempty"`
	TagName string `json:"tagname,omitempty"`
}

func TAGGetList added in v1.0.35 

func TAGGetList(api *token.Api) ([]Tag, error)

TAGGetList 获取标签列表 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/list?access_token=ACCESS_TOKEN

type User added in v1.0.35 

type User struct {
	Userid string `json:"userid"`
	Name   string `json:"name"`
}

type UserTag added in v1.0.35 

type UserTag struct {
	Tag
	UserList  []User `json:"userlist,omitempty"`
	PartyList []int  `json:"partylist,omitempty"`
}

func TAGUser added in v1.0.35 

func TAGUser(api *token.Api, tagId int64) (*UserTag, error)

TAGUser 获取标签成员 请求方式：GET（HTTPS） 请求地址：https://qyapi.weixin.qq.com/cgi-bin/tag/get?access_token=ACCESS_TOKEN&tagid=TAGID

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.