重命名

POST https://api.pushwoosh.com/messaging/v2/rename

设置或清除先前创建的、由其 message_code 标识的消息的营销活动名称。消息的其他一切都不会改变。内容、受众和计划安排均与之前完全相同。

仅当消息仍处于待处理状态时，才能重命名——即消息已创建但尚未被提取以进行发送。已进入 waiting、processing 或更后续状态的消息将无法再重命名。在控制面板中，此状态在状态列显示为 Scheduled，而非字面意义上的 “Pending”。请参阅消息状态。

要检查消息是否仍处于可重命名状态，请参阅检查消息状态。

请求

在 Authorization: Token <API_TOKEN> 标头中使用您的服务器 API 令牌进行身份验证。

字段	类型	必需	描述
`message_code`	字符串	是	要重命名的消息的消息代码，由 `Notify` 在 `result.message_code` 中返回。
`campaign_name`	字符串	是	新的营销活动名称。将被裁剪并截断为 255 个字符。空字符串将清除该名称。

请求示例

curl -X POST https://api.pushwoosh.com/messaging/v2/rename \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "message_code": "XXXX-XXXXXXXX-XXXXXXXX",
    "campaign_name": "Flash_Sale_Push"
  }'

响应

成功后，返回 HTTP 200 和一个空的 JSON 正文。

{}

错误

错误使用标准的 gRPC-Gateway 错误封套：{ "code": ..., "message": ..., "details": [...] }。

HTTP 状态	条件
`400`	`message_code` 缺失。
`400`	消息不处于可重命名状态（不再是 `pending`）。
`403`	消息属于另一个账户。
`404`	给定的 `message_code` 不存在任何消息。
`500`	加载消息或应用新名称时发生内部错误。请重试请求。

示例

重命名一条已经开始发送的消息将返回 HTTP 400：

{
  "code": 9,
  "message": "message status \"waiting\" is not renamable",
  "details": []
}

检查消息状态

在重命名之前，您可以验证消息是否仍处于可重命名状态。除了在控制面板的消息表中读取状态列（Campaigns → 一次性消息）之外——可重命名的消息在该列中显示为 Scheduled，而非字面意义上的 “Pending”——您还可以使用 messages:list 以编程方式查询状态：

在 filters.messages_codes 数组中传递 message_code（以及必需的 filters.application）。
读取 items[] 中匹配条目的 status 字段。

重命名

请求

请求示例

响应

错误

检查消息状态

相关内容