feat(wxapi): 新增小程序发送订阅消息的接口

This commit is contained in:
Fu Diwei 2021-08-26 16:47:59 +08:00
parent e4203a76e3
commit 3f4bd40d5f
5 changed files with 101 additions and 3 deletions

View File

@ -14,8 +14,6 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
/// <summary>
/// <para>异步调用 [POST] /cgi-bin/message/subscribe/bizsend 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/api.html#send%E5%8F%91%E9%80%81%E8%AE%A2%E9%98%85%E9%80%9A%E7%9F%A5 </para>
/// <para>REF: https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html </para>
/// <para>REF: https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
@ -32,5 +30,26 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
return await client.SendRequestWithJsonAsync<Models.CgibinMessageSubscribeBusinessSendResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
/// <summary>
/// <para>异步调用 [POST] /cgi-bin/message/subscribe/send 接口。</para>
/// <para>REF: https://developers.weixin.qq.com/miniprogram/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html </para>
/// <para>REF: https://developers.weixin.qq.com/minigame/dev/api-backend/open-api/subscribe-message/subscribeMessage.send.html </para>
/// </summary>
/// <param name="client"></param>
/// <param name="request"></param>
/// <param name="cancellationToken"></param>
/// <returns></returns>
public static async Task<Models.CgibinMessageSubscribeSendResponse> ExecuteCgibinMessageSubscribeSendAsync(this WechatApiClient client, Models.CgibinMessageSubscribeSendRequest request, CancellationToken cancellationToken = default)
{
if (client is null) throw new ArgumentNullException(nameof(client));
if (request is null) throw new ArgumentNullException(nameof(request));
IFlurlRequest flurlReq = client
.CreateRequest(request, HttpMethod.Post, "cgi-bin", "message", "subscribe", "send")
.SetQueryParam("access_token", request.AccessToken);
return await client.SendRequestWithJsonAsync<Models.CgibinMessageSubscribeSendResponse>(flurlReq, data: request, cancellationToken: cancellationToken);
}
}
}

View File

@ -71,6 +71,6 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Models
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public IDictionary<string, Types.DataItem>? Data { get; set; }
public IDictionary<string, Types.DataItem> Data { get; set; } = new Dictionary<string, Types.DataItem>();
}
}

View File

@ -0,0 +1,66 @@
using System;
using System.Collections.Generic;
namespace SKIT.FlurlHttpClient.Wechat.Api.Models
{
/// <summary>
/// <para>表示 [POST] /cgi-bin/message/subscribe/send 接口的请求。</para>
/// </summary>
public class CgibinMessageSubscribeSendRequest : WechatApiRequest
{
public static class Types
{
public class DataItem
{
/// <summary>
/// 获取或设置消息内容文本。
/// </summary>
[Newtonsoft.Json.JsonProperty("value")]
[System.Text.Json.Serialization.JsonPropertyName("value")]
public string Value { get; set; } = string.Empty;
}
}
/// <summary>
/// 获取或设置接收消息的用户 OpenId。
/// </summary>
[Newtonsoft.Json.JsonProperty("touser")]
[System.Text.Json.Serialization.JsonPropertyName("touser")]
public string ToUserOpenId { get; set; } = string.Empty;
/// <summary>
/// 获取或设置订阅消息模板 ID。
/// </summary>
[Newtonsoft.Json.JsonProperty("template_id")]
[System.Text.Json.Serialization.JsonPropertyName("template_id")]
public string TemplateId { get; set; } = string.Empty;
/// <summary>
/// 获取或设置小程序页面路径。
/// </summary>
[Newtonsoft.Json.JsonProperty("page")]
[System.Text.Json.Serialization.JsonPropertyName("page")]
public string? MiniProgramPagePath { get; set; }
/// <summary>
/// 获取或设置小程序类型。
/// </summary>
[Newtonsoft.Json.JsonProperty("miniprogram_state")]
[System.Text.Json.Serialization.JsonPropertyName("miniprogram_state")]
public string? MiniProgramState { get; set; }
/// <summary>
/// 获取或设置消息正文。
/// </summary>
[Newtonsoft.Json.JsonProperty("data")]
[System.Text.Json.Serialization.JsonPropertyName("data")]
public IDictionary<string, Types.DataItem> Data { get; set; } = new Dictionary<string, Types.DataItem>();
/// <summary>
/// 获取或设置进入小程序的语言类型。
/// </summary>
[Newtonsoft.Json.JsonProperty("lang")]
[System.Text.Json.Serialization.JsonPropertyName("lang")]
public string? Language { get; set; }
}
}

View File

@ -0,0 +1,12 @@
using System;
using System.Collections.Generic;
namespace SKIT.FlurlHttpClient.Wechat.Api.Models
{
/// <summary>
/// <para>表示 [POST] /cgi-bin/message/subscribe/send 接口的响应。</para>
/// </summary>
public class CgibinMessageSubscribeSendResponse : WechatApiResponse
{
}
}

View File

@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
/* @codestyle-disable no-jsonable-property-in-get */
namespace SKIT.FlurlHttpClient.Wechat.TenpayV3.Models
{
/// <summary>