文档

CreateSchedule - 创建触达计划

更新时间:

创建触达计划。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
paiplugin:CreateScheduleWrite
  • PAI
    acs:paiplugin::{#accountId}:*

请求参数

名称类型必填描述示例值
bodyobject

请求参数的主体信息。

EndTimestring

终止时间(UTC+8)。

2020-01-01
ExecuteTimestring

执行时间 (UTC+8),为空立即执行。

2020-01-01 12:00:00
GroupIdstring

人群ID。

0a54e195-03e2-40bd-869d-b71cb302783e
Namestring

触达计划名称。

增长-2021-0101
RepeatCycleinteger

重复周期,按重复周期与重复周期单位执行。

0
RepeatCycleUnitinteger

重复周期单位,若指定执行时间,则重复周期生效。

  • 0: 从不(默认)。
  • 1: 小时。
  • 2: 天。
  • 3: 周。
  • 4: 月。
0
RepeatTimesinteger

重复次数。

  • -1: 不设终止时间(默认)。
  • 0: 不重复。
  • N: 重复N次后终止。
1
SignNamestring

签名。

PAI
SignatureIdstring

签名Id,或指定签名。

0a54e195-03e2-40bd-869d-b71cb302783e
TemplateCodestring

模板Code。

SMS_123456
TemplateIdstring

模板Id,或指定模板Code。

0a54e195-03e2-40bd-869d-b71cb302783e
AISendStartDatestring

智能发送开始时间。

2020-01-01 12:00:00
AISendEndDatestring

智能发送结束时间。

2020-01-01 12:00:00
PaymentTypestring

计费类型(为空时默认后付费)。

  • PayAsYouGo:后付费
  • Subscription:预付费
PayAsYouGo

返回参数

名称类型描述示例值
object

成功注册触达计划,可通过控制台或GetSchedule获取触达计划检查与触达情况。

Dataobject

返回数据。

CreatedTimestring

创建时间 (UTC+8)。

2020-01-01 12:00:00
EndTimestring

终止时间(UTC+8)。

2020-01-01
ExecuteTimestring

执行时间 (UTC+8),为空立即执行。

2020-01-01 12:00:00
GroupIdstring

人群ID。

0a54e195-03e2-40bd-869d-b71cb302783e
Idstring

触达计划ID。

0a54e195-03e2-40bd-869d-b71cb302783e
Namestring

触达计划名称。

增长-2021-0101
RepeatCycleinteger

重复周期,按重复周期与重复周期单位执行。

0
RepeatCycleUnitinteger

重复周期单位,若指定执行时间,则重复周期生效。

  • 0: 从不(默认)。
  • 1: 小时。
  • 2: 天。
  • 3: 周。
  • 4: 月。
0
RepeatTimesinteger

重复次数。

  • -1: 不设终止时间(默认)。
  • 0: 不重复。
  • N: 重复N次后终止。
1
SignNamestring

签名。

PAI
SignatureIdstring

签名ID,或指定签名。

0a54e195-03e2-40bd-869d-b71cb302783e
Statusinteger

状态。

  • 0: 检查中。
  • 1: 检查成功。
  • 2: 检查失败。
  • 3: 发送中。
  • 4: 发送成功。
  • 5: 发送失败。
0
TemplateCodestring

模板Code。

SMS_123456
TemplateIdstring

模板ID,或指定模板Code。

0a54e195-03e2-40bd-869d-b71cb302783e
UpdatedTimestring

更新时间 (UTC+8)。

2020-01-01 12:00:00
ErrorCodeinteger

错误码。

0
ErrorMessagestring

错误信息。

OK
RequestIdstring

请求ID。

f8651828-609d-4de8-ab49-ab781d7fd85a

示例

正常返回示例

JSON格式

{
  "Data": {
    "CreatedTime": "2020-01-01 12:00:00",
    "EndTime": "2020-01-01",
    "ExecuteTime": "2020-01-01 12:00:00",
    "GroupId": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "Id": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "Name": "增长-2021-0101",
    "RepeatCycle": 0,
    "RepeatCycleUnit": 0,
    "RepeatTimes": 1,
    "SignName": "PAI",
    "SignatureId": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "Status": 0,
    "TemplateCode": "SMS_123456",
    "TemplateId": "0a54e195-03e2-40bd-869d-b71cb302783e",
    "UpdatedTime": "2020-01-01 12:00:00"
  },
  "ErrorCode": 0,
  "ErrorMessage": "OK",
  "RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}

错误码

访问错误中心查看更多错误码。

  • 本页导读 (1)
文档反馈