喵提醒

喵提醒帮助与文档


发送实时提醒

[TOC]

简要描述
  • 给指定喵码发送实时送达的提醒通知。
请求URL
  • http://miaotixing.com/trigger
  • https://miaotixing.com/trigger
请求方式
  • GET
  • POST
参数
参数名 必选 类型 说明 示例
id string 喵码。指定发出的提醒,一个提醒对应一个喵码。 tDS0Se9
text string 提醒附加内容。收到的提醒时,会在标题换行后显示该内容,默认为空。 程序故障,错误号404
type string 返回内容格式,可选值jsonjsonp。为json时返回json格式数据;为jsonp时返回jsonp格式数据;默认为空,即返回文字描述信息。 json
callback string 当type为jsonp时,callback可指定回调函数名;默认为miaotixing_jsonpcallback。 mycallback
ts uint 请求时的10位数时间戳,单位:秒。传入该参数时,喵提醒将检查当前时间与时间戳相差值,如果相差超过60秒则拒绝请求。不传该参数时不做时间检查。 1615865402
templ string 套用提醒模板参数。传入该值时,喵提醒将检查提醒模板与参数格式是否匹配,匹配成功后将用提醒模板内容取代原提醒内容,且公众号提醒会改为提醒模板的样式,详见《提醒模板使用方法》。不传该参数时不使用提醒模板。 prvPe94,10,调试,无响应
product string 外发产品id。传入该值时,系统将标记本次提醒关联的外发产品,并享受外发产品服务。默认为无关联的外发产品。 p123456
option string 附加选项参数,多个参数之间用逗号隔开。支持以下参数:<br />nosms暂屏蔽短信通知<br />nophonecall暂屏蔽语音电话通知<br />noemail暂屏蔽电子邮件通知 nosms,nophonecall
返回示例

type为空:

成功

type为json

{
    &quot;code&quot;: 0,
    &quot;data&quot;: {
        &quot;users&quot;: 3,
        &quot;success_sent&quot;: {
            &quot;mptext&quot;: 3,
            &quot;sms&quot;: 0,
            &quot;phonecall&quot;: 0
        }
    },
    &quot;msg&quot;: &quot;完成&quot;
}
返回参数说明
参数名 类型 说明
code int 见错误码说明。
data object 相关结果。
data.users uint 成功发送提醒人数,如果提醒共享给了多人,该数字将大于1。
data.success_sent object 按提醒通知方式统计发送量:<br />mptext公众号提醒数;<br />sms短信提醒数;<br />phonecall语音电话提醒数
data.remaining uint 若提醒还在冷却时间内,该参数返回至少需要等多少秒才能发送下一次提醒。
data.warning object 若提醒过程出现异常,但不影响发出,该参数返回警告信息。
data.warning.templ object 若提醒模板使用异常,该参数返回相关警告信息:<br />code错误码,见错误码说明;<br />msg异常描述。
msg string 执行结果描述。
错误码说明
错误码 说明
-1 提醒失败(未指定原因)。
0 提醒成功。
101 参数格式有误。
102 提醒过于频繁,未过冷却时间,可在返回json的data.remaining获取还需要等多少秒。
103 找不到提醒,请检查喵码是否正确。
104 提醒已被喵主禁用。
105 该提醒的喵主未关注公众号。
106 该提醒的喵主账户暂时无法使用。
107 未能找到该提醒的喵主。
108 该提醒的喵主未完成账号注册。
109 同102,但提醒内容会保存到提醒缓冲池服务,1分钟内补发。[VIP]
110 时间戳已过期(使用了ts参数并且过期)。
201 未能找到提醒模板。
202 内容与提醒模板格式不匹配。
203 该提醒模板暂停使用。
注意事项
  • 若喵码所属用户为Lite账户(即未用手机号注册),提醒时text参数会被忽略,但如果使用了提醒模板,提醒模板生成的内容能正常收到。
  • 由于各种可能的原因,提醒网址可能会在意外的情况被误访问,对接受者带来不必要的打扰,建议建议使用ts参数,减少该情况发生。

页面列表

ITEM_HTML