wechat/work/externalcontact/contact_way.go

package externalcontact

import (
	"fmt"

	"github.com/silenceper/wechat/v2/util"
)

const (
	// addContactWayURL 配置客户联系「联系我」方式
	addContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/add_contact_way?access_token=%s"
	// getContactWayURL 获取企业已配置的「联系我」方式
	getContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/get_contact_way?access_token=%s"
	// updateContactWayURL 更新企业已配置的「联系我」方式
	updateContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/update_contact_way?access_token=%s"
	// listContactWayURL 获取企业已配置的「联系我」列表
	listContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/list_contact_way?access_token=%s"
	// delContactWayURL 删除企业已配置的「联系我」方式
	delContactWayURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/del_contact_way?access_token=%s"
	// closeTempChatURL 结束临时会话
	closeTempChatURL = "https://qyapi.weixin.qq.com/cgi-bin/externalcontact/close_temp_chat?access_token=%s"
)

type (
	// ConclusionsRequest 结束语请求
	ConclusionsRequest struct {
		Text        ConclusionsText         `json:"text"`
		Image       ConclusionsImageRequest `json:"image"`
		Link        ConclusionsLink         `json:"link"`
		MiniProgram ConclusionsMiniProgram  `json:"miniprogram"`
	}
	// ConclusionsText 文本格式结束语
	ConclusionsText struct {
		Content string `json:"content"`
	}
	// ConclusionsImageRequest 图片格式结束语请求
	ConclusionsImageRequest struct {
		MediaID string `json:"media_id"`
	}
	// ConclusionsLink 链接格式结束语
	ConclusionsLink struct {
		Title  string `json:"title"`
		PicURL string `json:"picurl"`
		Desc   string `json:"desc"`
		URL    string `json:"url"`
	}
	// ConclusionsMiniProgram 小程序格式结束语
	ConclusionsMiniProgram struct {
		Title      string `json:"title"`
		PicMediaID string `json:"pic_media_id"`
		AppID      string `json:"appid"`
		Page       string `json:"page"`
	}
	// ConclusionsResponse 结束语响应
	ConclusionsResponse struct {
		Text        ConclusionsText          `json:"text"`
		Image       ConclusionsImageResponse `json:"image"`
		Link        ConclusionsLink          `json:"link"`
		MiniProgram ConclusionsMiniProgram   `json:"miniprogram"`
	}
	// ConclusionsImageResponse 图片格式结束语响应
	ConclusionsImageResponse struct {
		PicURL string `json:"pic_url"`
	}
)

type (
	// AddContactWayRequest 配置客户联系「联系我」方式请求
	AddContactWayRequest struct {
		Type          int                `json:"type"`
		Scene         int                `json:"scene"`
		Style         int                `json:"style"`
		Remark        string             `json:"remark"`
		SkipVerify    bool               `json:"skip_verify"`
		State         string             `json:"state"`
		User          []string           `json:"user"`
		Party         []int              `json:"party"`
		IsTemp        bool               `json:"is_temp"`
		ExpiresIn     int                `json:"expires_in"`
		ChatExpiresIn int                `json:"chat_expires_in"`
		UnionID       string             `json:"unionid"`
		IsExclusive   bool               `json:"is_exclusive"`
		MarkSource    bool               `json:"mark_source"`
		Conclusions   ConclusionsRequest `json:"conclusions"`
	}
	// AddContactWayResponse 配置客户联系「联系我」方式响应
	AddContactWayResponse struct {
		util.CommonError
		ConfigID string `json:"config_id"`
		QrCode   string `json:"qr_code"`
	}
)

// AddContactWay 配置客户联系「联系我」方式
// see https://developer.work.weixin.qq.com/document/path/92228
func (r *Client) AddContactWay(req *AddContactWayRequest) (*AddContactWayResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.PostJSON(fmt.Sprintf(addContactWayURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &AddContactWayResponse{}
	err = util.DecodeWithError(response, result, "AddContactWay")
	return result, err
}

type (
	// GetContactWayRequest 获取企业已配置的「联系我」方式请求
	GetContactWayRequest struct {
		ConfigID string `json:"config_id"`
	}
	// GetContactWayResponse 获取企业已配置的「联系我」方式响应
	GetContactWayResponse struct {
		util.CommonError
		ContactWay ContactWay `json:"contact_way"`
	}
	// ContactWay 「联系我」配置
	ContactWay struct {
		ConfigID      string              `json:"config_id"`
		Type          int                 `json:"type"`
		Scene         int                 `json:"scene"`
		Style         int                 `json:"style"`
		Remark        string              `json:"remark"`
		SkipVerify    bool                `json:"skip_verify"`
		State         string              `json:"state"`
		QrCode        string              `json:"qr_code"`
		User          []string            `json:"user"`
		Party         []int               `json:"party"`
		IsTemp        bool                `json:"is_temp"`
		ExpiresIn     int                 `json:"expires_in"`
		ChatExpiresIn int                 `json:"chat_expires_in"`
		UnionID       string              `json:"unionid"`
		MarkSource    bool                `json:"mark_source"`
		Conclusions   ConclusionsResponse `json:"conclusions"`
	}
)

// GetContactWay 获取企业已配置的「联系我」方式
// see https://developer.work.weixin.qq.com/document/path/92228
func (r *Client) GetContactWay(req *GetContactWayRequest) (*GetContactWayResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.PostJSON(fmt.Sprintf(getContactWayURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &GetContactWayResponse{}
	err = util.DecodeWithError(response, result, "GetContactWay")
	return result, err
}

type (
	// UpdateContactWayRequest 更新企业已配置的「联系我」方式请求
	UpdateContactWayRequest struct {
		ConfigID      string             `json:"config_id"`
		Remark        string             `json:"remark"`
		SkipVerify    bool               `json:"skip_verify"`
		Style         int                `json:"style"`
		State         string             `json:"state"`
		User          []string           `json:"user"`
		Party         []int              `json:"party"`
		ExpiresIn     int                `json:"expires_in"`
		ChatExpiresIn int                `json:"chat_expires_in"`
		UnionID       string             `json:"unionid"`
		MarkSource    bool               `json:"mark_source"`
		Conclusions   ConclusionsRequest `json:"conclusions"`
	}
	// UpdateContactWayResponse 更新企业已配置的「联系我」方式响应
	UpdateContactWayResponse struct {
		util.CommonError
	}
)

// UpdateContactWay 更新企业已配置的「联系我」方式
// see https://developer.work.weixin.qq.com/document/path/92228
func (r *Client) UpdateContactWay(req *UpdateContactWayRequest) (*UpdateContactWayResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.PostJSON(fmt.Sprintf(updateContactWayURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &UpdateContactWayResponse{}
	err = util.DecodeWithError(response, result, "UpdateContactWay")
	return result, err
}

type (
	//ListContactWayRequest 获取企业已配置的「联系我」列表请求
	ListContactWayRequest struct {
		StartTime int    `json:"start_time"`
		EndTime   int    `json:"end_time"`
		Cursor    string `json:"cursor"`
		Limit     int    `json:"limit"`
	}
	//ListContactWayResponse 获取企业已配置的「联系我」列表响应
	ListContactWayResponse struct {
		util.CommonError
		ContactWay []*ContactWayForList `json:"contact_way"`
		NextCursor string               `json:"next_cursor"`
	}
	// ContactWayForList 「联系我」配置
	ContactWayForList struct {
		ConfigID string `json:"config_id"`
	}
)

// ListContactWay 获取企业已配置的「联系我」列表
// see https://developer.work.weixin.qq.com/document/path/92228
func (r *Client) ListContactWay(req *ListContactWayRequest) (*ListContactWayResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.PostJSON(fmt.Sprintf(listContactWayURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &ListContactWayResponse{}
	err = util.DecodeWithError(response, result, "ListContactWay")
	return result, err
}

type (
	// DelContactWayRequest 删除企业已配置的「联系我」方式请求
	DelContactWayRequest struct {
		ConfigID string `json:"config_id"`
	}
	// DelContactWayResponse 删除企业已配置的「联系我」方式响应
	DelContactWayResponse struct {
		util.CommonError
	}
)

// DelContactWay 删除企业已配置的「联系我」方式
// see https://developer.work.weixin.qq.com/document/path/92228
func (r *Client) DelContactWay(req *DelContactWayRequest) (*DelContactWayResponse, error) {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return nil, err
	}
	var response []byte
	if response, err = util.PostJSON(fmt.Sprintf(delContactWayURL, accessToken), req); err != nil {
		return nil, err
	}
	result := &DelContactWayResponse{}
	err = util.DecodeWithError(response, result, "DelContactWay")
	return result, err
}

// CloseTempChatRequest 结束临时会话请求
type CloseTempChatRequest struct {
	UserID         string `json:"userid"`
	ExternalUserID string `json:"external_userid"`
}

// CloseTempChat 结束临时会话
// @see https://developer.work.weixin.qq.com/document/path/92228
func (r *Client) CloseTempChat(req *CloseTempChatRequest) error {
	var (
		accessToken string
		err         error
	)
	if accessToken, err = r.GetAccessToken(); err != nil {
		return err
	}
	var response []byte
	if response, err = util.PostJSON(fmt.Sprintf(closeTempChatURL, accessToken), req); err != nil {
		return err
	}
	return util.DecodeWithCommonError(response, "CloseTempChat")
}