• OkayAPI Docs
  • Login
  • Try for free



YesApi 接口文档

3001 微信小程序-获取微信基本信息接口

接口路径(新):http://api.okayapi.com/api/App/Weixin/GetWeixinInfoMini

接口路径(旧):http://api.okayapi.com/?s=App.Weixin.GetWeixinInfoMini

接口描述: 微信小程序获取微信信息,只传code的话只会返回openid,特别注意!小程序只有绑定了服务号,并且明文授权才会返回unionid和用户信息,否则只返回openid。只有传了iv和encryptedData才能获取其他参数。对应微信接口:sns/jscode2session。点击进入微信公众号/小程序配置。更多可参考官方的小程序登录 /小程序登录接口。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
codeStringRequired微信小程序 登录凭证 code
ivStringOptaion加密算法的初始向量
encryptedDataStringOptaion包括敏感数据在内的完整用户信息的加密数据
appnameStringOptaion小白开放平台配置的应用名称,如果是默认配置,此字段则可不传

API Usage Demo

API Response

KEYTypeDescription
err_codeInt操作码,0表示成功,正数表示业务失败场景,负数表示系统失败场景
err_msgString错误提示信息,err_code非0时参考此提示信息
openidString用户唯一标识
unionidString用户在开放平台的唯一标识符。本字段在满足一定条件的情况下才返回,小程序只有绑定了服务号才有此字段返回。
nicknameString用户昵称 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。
avatarUrlString用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空。若用户更换头像,原有头像URL将失效。 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。
genderString用户的性别,值为1时是男性,值为2时是女性,值为0时是未知 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。
cityString用户所在城市 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。
provinceString用户所在省份 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。
countryString用户所在国家 只有传了iv和encryptedData才会返回,小程序只有绑定了服务号才有此字段返回。

YesApi 接口文档

3002 微信小程序——发送微信模板消息接口

接口路径(新):http://api.okayapi.com/api/App/Weixin/SendTemplateMessage

接口路径(旧):http://api.okayapi.com/?s=App.Weixin.SendTemplateMessage

接口描述: 微信小程序发送模板消息,对应微信接口:templateMessage.send。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
touserStringRequired接收者(用户)的 openid
template_idStringRequired下发的模板消息的id
pageStringOptaion点击模板卡片后的跳转页面,仅限本小程序内的页面。支持带参数,(示例index?foo=bar)。该字段不填则模板无跳转。
form_idStringRequired表单提交场景下,为 submit 事件带上的 formId;支付场景下,为本次支付的 prepay_id
dataArrayJSON FormatOptaion模板内容,不填则下发空模板。具体格式请参考示例。需要JSON编码后传递JSON在线解析及格式化验证
emphasis_keywordStringOptaion模板需要放大的关键词,不填则默认无放大
appnameStringOptaion小白开放平台配置的应用名称,如果是默认配置,此字段则可不传

API Usage Demo

API Response

KEYTypeDescription
err_codeInt操作码,0发送成功,40037 template_id不正确,41028 form_id不正确,或者过期,41029form_id已被使用,41030page不正确,45009 接口调用超过限额(目前默认每个帐号日调用限额为100万)
err_msgString操作失败的结果

YesApi 接口文档

3003 微信小程序——校验一张图片是否含有违法违规内容。

接口路径(新):http://api.okayapi.com/api/App/Weixin/ImgSecCheck

接口路径(旧):http://api.okayapi.com/?s=App.Weixin.ImgSecCheck

接口描述: 校验一张图片是否含有违法违规内容,图片格式仅支持,PNG、JPEG、JPG、GIF,图片尺寸不超过 750px x 1334px,对应微信接口:security.imgSecCheck。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
fileStringRequiredSource: POST此参数必须使用POST方式传递,且必须进行base64编码后传递,对待上传文件二进制内容进行basse64编码后的数据,此部分数据需要纳入签名。格式示例:data:image/gif;base64,R0lGODlhAQABAIAAAHd3dwAAACH5BAAAAAAALAAAAAABAAEAAAICRAEAOw==
appnameStringOptaion小白开放平台配置的应用名称,如果是默认配置,此字段则可不传

API Usage Demo

API Response

KEYTypeDescription
err_codeInt操作码,0发送成功,87014为内容含有违法违规内容
err_msgString操作失败的结果

YesApi 接口文档

3004 微信小程序——检查一段文本是否含有违法违规内容。。

接口路径(新):http://api.okayapi.com/api/App/Weixin/MsgSecCheck

接口路径(旧):http://api.okayapi.com/?s=App.Weixin.MsgSecCheck

接口描述: 检查一段文本是否含有违法违规内容。,对应微信接口:security.msgSecCheck。

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
contentStringRequired要检测的文本内容,长度不超过 500KB
appnameStringOptaion小白开放平台配置的应用名称,如果是默认配置,此字段则可不传

API Usage Demo

API Response

KEYTypeDescription
err_codeInt操作码,0发送成功,87014为内容含有违法违规内容
err_msgString操作失败的结果

Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York May/10/2025 21:43:04