HiPush 是Hi提醒的API推送服务

通过GET/POST调用API实现推送信息的自定义。不需要提前创建提醒任务,触发即可推送。

你还可以一对多 群组推送 大家共同接收信息。

HiPush推送说明(API推送)

API接口可以将信息直接推送至你所指定的接收通道, 你只需设定好参数后使用GET/POST调用接口即可。


支持的通道:

微信公众号:推送至 Hi提醒 公众号,关注公众号即可。

企业微信应用消息:需要申请企业微信帐号(个人也可以注册),不用安装企业微信也能直接收到信息。

企业微信群机器人消息:推送至你的企业微信机器人群。

钉钉群机器人消息:推送至你的钉钉机器人群。

飞书群机器人消息:推送至你的飞书机器人群。

短信:通过短信推送到你的手机,需绑定手机号。

语音电话:通过语音电话推送到你的手机,需绑定手机号。

电子邮件:通过邮件方式发送到你的邮箱,需绑定电子邮件。

自定义通道:推送到其它自定义的机器人(用于补充有多个钉钉、飞书、企微机器人时的应用场景)。


API统一调用地址:

Url:https://api.caicenter.com/send.php


测试时请将以下示例中的 xxxxxxxx 更换为自己的 appkey。

appkey在关注Hi提醒公众号后 点击[我的]->[个人中心]查看。


GET示例1:

https://api.caicenter.com/send.php?appkey=xxxxxxxx&title=title&channel=1

[推送信息至微信公众号,标题为title]


GET示例2-:

https://api.caicenter.com/send.php?appkey=xxxxxxxx&title=title&describes=test&channel=1|10&msg_type=text&cc_user=@all

[推送信息至微信公众号和微信群机器人,标题为title,内容为test,消息使用文本类型并提醒全员查看]


GET示例3 一对多群组推送:

https://api.caicenter.com/send.php?appkey=xxxxxxxx&title=title&describes=test&channel=1&cc_user=group_12345678

[推送信息至 群组 group_12345678 ,注意: 群组必须是微信公众号通道接收,群组在公众号中创建,代码中间为下划线]


注:如果参数中如有中文,请记得进行urlencode编码,正文需要换行时可使用'\n'。


参数说明:

appkey:用户身份标识,请勿泄漏。

title:消息的标题,必填。

describes:消息的内容,选填。如内容过多建议使用POST方式推送。

channel:指定推送消息的通道,默认为微信公众号通道。填写通道代码即可,多个通道请用|号隔开,如 10|20 代表同时推送至微信机器人和手机短信。

cc_user:抄送的群组。填写群组代码可实现一对多的提醒(请提前创建好群组),或者填写 @all代表提醒全员查看(仅机器人通道有效)。

msg_type:指定消息的类型,选填,可选值有 markdown、text。默认text,群机器人消息有效。

channel_url:自定义通道地址,选择自定义通道推送时必填机器的地址(目前只支持post)。


通道名称及对应代码:

微信公众号:1

企业微信应用消息:13

企业微信群机器人消息:10

钉钉群机器人消息:11

飞书群机器人消息:12

短信:20

语音电话:30

电子邮件:40

自定义通道:95



POST调用示例:

<?php

//组合推送参数

$PUSH_DATA=array(

'title'=>'这是标题',

'describes'=>'这是内容',

'channel'=>'1|10',

'msg_type'=>'markdown',

'cc_user'=>'',

'appkey'=>'xxxxxxxxx',

);


//正试推送

curl_post('https://api.caicenter.com/send.php' , $PUSH_DATA);


//post请求

function curl_post($URL , $data=array()){

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $URL);

curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);

curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);

curl_setopt($ch, CURLOPT_POSTFIELDS, $data);

$output = curl_exec($ch);

curl_close($ch);

return $output;

}

?>



参数返回结果使用json格式。


推送成功:

{"msg":"ok","code":0,"sendCode":"7tM154wFnRV3h","data":{"c_1":{"code":0,"msg":"推送成功"}}}


推送失败:

{"msg":"appKey已失效","code":110110}


code: 状态码, 0成功,>0失败

msg:错误信息说明

sendCode:消息标识码,可通过该参数查询接口推送结果。

data:消息通道体数据;c_1代表微信公众号通道的结果,其它通道同理。



---------------------------------------


API查询推送结果:

https://api.caicenter.com/select.php?appkey=xxxxx&send_code=xxxxxxx

[替换xxxxxx为自己的appkey/send_code消息标识码]


返回结果:


查询成功:

{"code":0,"msg":"查询成功","data":[{"todoId":"0","channel":"1","pushTime":"2022-04-30 16:13:05","pushResult":{"code":0,"msg":"推送成功"},"status":"1"}]}


查询失败:

{"code":10013,"msg":"记录已过期或错误的推送代码(send_code)"}