php 极光定时推送消息,极光短信 - 短信定时发送 API - 极光文档

短信定时发送 API

支持提交、修改、查询和删除模板短信定时发送任务

HTTP 验证

使用 HTTP Basic Authentication 的方式做访问授权。这样整个 API 请求可以使用常见的 HTTP 工具来完成,比如:curl,浏览器插件等;

HTTP Header(头)里加一个字段(Key/Value对):

Authorization: Basic base64_auth_string

其中 base64_auth_string 的生成算法为:base64(appKey:masterSecret),即:对 appKey 加上冒号,加上 masterSecret 拼装起来的字符串,再做 base64 转换。appKey、masterSecret 可以在控制台应用设置中查看。

单条定时短信提交 API

功能说明

提交单条模板短信定时发送任务

调用地址

POST https://api.sms.jpush.cn/v1/schedule

请求示例

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/schedule -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \

'{

"send_time": "2017-07-01 09:00:00",

"mobile": "13812345678",

"sign_id": *,

"temp_id": 1250,

"temp_para": {

"number": "741627"

}

}'

参数

KEY

REQUIRE

DESCRIPTION

send_time

TRUE

发送时间,格式为 yyyy-MM-dd HH:mm:ss

mobile

TRUE

手机号码

sign_id

FALSE

签名ID,该参数为空则使用应用默认签名,注意:签名审核通过后,可在控制台设为默认签名

temp_id

TRUE

模板ID

temp_para

FALSE

模板参数,需要替换的参数名和 value 的键值对

返回示例

请求成功

{"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e"}

请求失败

{

"error": {

"code": *****,

"message": "*****"

}

}

批量定时短信提交 API

功能说明

提交批量模板短信定时发送任务

调用地址

POST https://api.sms.jpush.cn/v1/schedule/batch

请求示例

curl --insecure -X POST -v https://api.sms.jpush.cn/v1/schedule/batch -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \

'{

"send_time": "2017-07-01 09:00:00",

"sign_id": *,

"temp_id": 1250,

"tag":"标签",

"recipients": [

{

"mobile": "13812345678",

"temp_para": {

"number": "741627"

}

},

{

"mobile": "18603050709",

"temp_para": {

"number": "147721"

}

}

]

}'

参数

KEY

REQUIRE

DESCRIPTION

send_time

TRUE

发送时间,格式为 yyyy-MM-dd HH:mm:ss

sign_id

FALSE

签名ID,该参数为空则使用应用默认签名,注意:签名审核通过后,可在控制台设为默认签名

temp_id

TRUE

模板ID

tag

FALSE

标签,仅用作标示该短信的别名,不在短信中展示,最多不超过 10 个字

recipients

TRUE

短信接收者列表

recipients.mobile

TRUE

手机号码,上限 1000 个

recipients.temp_para

FALSE

模板参数,需要替换的参数名和 value 的键值对

返回示例

请求成功

{

"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e",

"success_count": 1,

"failure_count": 1,

"failure_recipients": [

{

"error_code": "50006",

"error_message": "invalid mobile",

"mobile": "18603050709",

"temp_para": {

"number": "147721"

}

}

]

}

请求失败

{

"error": {

"code": *****,

"message": "*****"

}

}

单条定时短信修改 API

功能说明

修改单条模版短信定时发送任务

调用地址

PUT https://api.sms.jpush.cn/v1/schedule/{schedule_id}

请求示例

curl --insecure -X PUT -v https://api.sms.jpush.cn/v1/schedule/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \

'{

"send_time": "2017-07-01 09:00:00",

"mobile": "13812345678",

"sign_id": *,

"temp_id": 1250,

"temp_para": {

"number": "741627"

}

}'

参数

KEY

REQUIRE

DESCRIPTION

send_time

TRUE

发送时间,格式为 yyyy-MM-dd HH:mm:ss

mobile

TRUE

手机号码

sign_id

FALSE

签名ID,该参数为空则使用应用默认签名,注意:签名审核通过后,可在控制台设为默认签名

temp_id

TRUE

模板ID

temp_para

FALSE

模板参数,需要替换的参数名和 value 的键值对

返回示例

请求成功

{"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e"}

请求失败

{

"error": {

"code": *****,

"message": "*****"

}

}

批量定时短信修改 API

功能说明

修改批量模板短信定时发送任务

调用地址

PUT https://api.sms.jpush.cn/v1/schedule/batch/{schedule_id}

请求示例

curl --insecure -X PUT -v https://api.sms.jpush.cn/v1/schedule/batch/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" -d \

'{

"send_time": "2017-07-01 09:00:00",

"sign_id": *,

"temp_id": 1250,

"recipients": [

{

"mobile": "13812345678",

"temp_para": {

"number": "741627"

}

},

{

"mobile": "18603050709",

"temp_para": {

"number": "147721"

}

}

]

}'

参数

KEY

REQUIRE

DESCRIPTION

send_time

TRUE

发送时间,格式为 yyyy-MM-dd HH:mm:ss

sign_id

FALSE

签名ID,该参数为空则使用应用默认签名,注意:签名审核通过后,可在控制台设为默认签名

temp_id

TRUE

模板ID

recipients

TRUE

短信接收者列表

recipients.mobile

TRUE

手机号码,上限 1000 个

recipients.temp_para

FALSE

模板参数,需要替换的参数名和 value 的键值对

返回示例

请求成功

{

"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e",

"success_count": 1,

"failure_count": 1,

"failure_recipients": [

{

"error_code": "50006",

"error_message": "invalid mobile",

"mobile": "18603050709",

"temp_para": {

"number": "147721"

}

}

]

}

请求失败

{

"error": {

"code": *****,

"message": "*****"

}

}

定时短信查询API

功能说明

查询模板短信定时发送任务

调用地址

GET https://api.sms.jpush.cn/v1/schedule/{schedule_id}

请求示例

curl --insecure -X GET -v https://api.sms.jpush.cn/v1/schedule/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

返回示例

请求成功

{

"schedule_id": "1a886e7c-a267-49e6-9970-0d396ca5bb1e",

"send_time": "2017-07-01 09:00:00",

"temp_id": 1250,

"recipients": [

{

"msg_id": "274887115920",

"mobile": "13812345678",

"temp_para": {

"number": "741627"

}

}

]

}

请求失败

{

"error": {

"code": *****,

"message": "*****"

}

}

定时短信删除 API

功能说明

删除模板短信定时发送任务

调用地址

DELETE https://api.sms.jpush.cn/v1/schedule/{schedule_id}

请求示例

curl --insecure -X DELETE -v https://api.sms.jpush.cn/v1/schedule/1a886e7c-a267-49e6-9970-0d396ca5bb1e -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

返回示例

请求成功

HTTP/1.0 200

Content-Type: application/json

Content-Length: 0

请求失败

{

"error": {

"code": *****,

"message": "*****"

}

}

返回码

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值