您可以根据本文提供的参数配置说明,创建触达计划,进行流失用户的触达和召回。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v2/schedules HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求参数的主体信息。 |
|
| EndTime |
string |
否 |
终止时间(UTC+8)。 |
2020-01-01 |
| ExecuteTime |
string |
否 |
执行时间 (UTC+8):
|
2020-01-01 12:00:00 |
| GroupId |
string |
是 |
人群 ID。如何获取人群 ID,请参见 ListGroups 。 |
0****195-03e2-40bd-869d-b71cb302783e |
| Name |
string |
是 |
触达计划名称。长度为 2~30 个字符,支持字母、数字、汉字和下划线(_)。 |
增长-2021-0101 |
| RepeatCycle |
integer |
否 |
重复周期,按重复周期与重复周期单位执行。 |
0 |
| RepeatCycleUnit |
integer |
否 |
重复周期单位,若指定执行时间(ExecuteTime),则按重复周期单位执行。
|
0 |
| RepeatTimes |
integer |
否 |
重复次数,取值如下:
|
-1 |
| SignName |
string |
否 |
签名名称,如何获取签名名称,请参见ListSignatures 。 |
PAI |
| SignatureId |
string |
否 |
签名 ID。如何获取签名 ID,请参见ListSignatures 。 |
0a54e195-03e2-40bd-869d-b71cb302**** |
| TemplateCode |
string |
否 |
模板 Code。如何获取模板 Code,请参见 ListTemplates 。 |
SMS_123*** |
| TemplateId |
string |
否 |
模板 ID,或指定模板 Code。如何获取模板 ID,请参见 ListTemplates 。 |
0a54e***-03e2-40bd-869d-b71cb30***** |
| AISendStartDate |
string |
否 |
智能发送开始时间,格式为 YYYY-MM-DD HH:mm:ss。 |
2020-01-01 12:00:00 |
| AISendEndDate |
string |
否 |
智能发送结束时间,格式为 YYYY-MM-DD HH:mm:ss。 |
2020-01-01 12:00:00 |
| PaymentType |
string |
否 |
计费类型(为空时默认后付费),取值如下:
|
PayAsYouGo |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
成功注册触达计划,可通过控制台或 GetSchedule 获取触达计划检查与触达情况。 |
||
| Data |
object |
返回数据。 |
|
| CreatedTime |
string |
创建时间 (UTC+8)。 |
2020-01-01 12:00:00 |
| EndTime |
string |
终止时间(UTC+8)。 |
2020-01-01 |
| ExecuteTime |
string |
执行时间 (UTC+8),为空立即执行。 |
2020-01-01 12:00:00 |
| GroupId |
string |
人群 ID。 |
0****195-03e2-40bd-869d-b71cb302783e |
| Id |
string |
触达计划 ID。 |
0a54****-03e2-40bd-869d-b71cb302783e |
| Name |
string |
触达计划名称。 |
增长-2021-0101 |
| RepeatCycle |
integer |
重复周期,按重复周期与重复周期单位执行。 |
0 |
| RepeatCycleUnit |
integer |
重复周期单位,若指定执行时间,则按重复周期单位执行。可能值:
|
0 |
| RepeatTimes |
integer |
重复次数,可能值:
|
-1 |
| SignName |
string |
签名。 |
PAI |
| SignatureId |
string |
签名 ID,或指定签名。 |
0a54e195-03e2-40bd-869d-b71cb302**** |
| Status |
integer |
状态。可能值:
|
0 |
| TemplateCode |
string |
模板 Code。 |
SMS_123*** |
| TemplateId |
string |
模板 ID,或指定模板 Code。 |
0a54e***-03e2-40bd-869d-b71cb30***** |
| UpdatedTime |
string |
更新时间 (UTC+8)。 |
2020-01-01 12:00:00 |
| ErrorCode |
integer |
错误码。 |
0 |
| ErrorMessage |
string |
错误信息。 |
OK |
| RequestId |
string |
请求 ID。 |
f8651828-609d-4de8-ab49-ab781d7fd85**** |
示例
正常返回示例
JSON格式
{
"Data": {
"CreatedTime": "2020-01-01 12:00:00",
"EndTime": "2020-01-01",
"ExecuteTime": "2020-01-01 12:00:00",
"GroupId": "0****195-03e2-40bd-869d-b71cb302783e",
"Id": "0a54****-03e2-40bd-869d-b71cb302783e",
"Name": "增长-2021-0101",
"RepeatCycle": 0,
"RepeatCycleUnit": 0,
"RepeatTimes": -1,
"SignName": "PAI",
"SignatureId": "0a54e195-03e2-40bd-869d-b71cb302****",
"Status": 0,
"TemplateCode": "SMS_123***",
"TemplateId": "0a54e***-03e2-40bd-869d-b71cb30*****",
"UpdatedTime": "2020-01-01 12:00:00"
},
"ErrorCode": 0,
"ErrorMessage": "OK",
"RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85****"
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。