开发者

DELETE/tcr/v2/campaign/{campaignId}

停用消息活动

停用活动,核对其号码分配,并了解成功响应为何没有响应体。

本页
  1. 停用现有消息活动
  2. 先移除受影响号码的分配关系
  3. 提交本次停用请求
  4. 核实注册信息和分配关系
  5. 停用与账户结算相互独立

停用现有消息活动

停用账户所属的活动时,请使用此路由。请保留活动标识符,以便核对和查阅历史记录。如需更正内容或更新同意声明文本,请改用更新消息活动。

从获准的源 IP 地址通过 HTTPS,使用已启用的 API 账户进行身份验证。请先读取活动信息,并检查关联的品牌和发送号码。停用会更改注册信息;它不会创建替代活动,也不会将号码转移到其他活动。

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

先移除受影响号码的分配关系

公开的活动 DELETE 操作不会在消息运营商处解除电话号码的关联,也不会清除其本地分配关系。请使用移除号码与活动分配关系的流程处理每个受影响且归该账户所有的号码,然后核实其分配情况。移除分配关系不会释放电话号码。

门户中范围更广的“删除品牌”流程会先清理该品牌的活动和号码,再删除品牌。如果您打算保留该品牌及其其他活动,请勿使用该操作。当前的常规活动编辑器没有提供与此直接 API 路由等效的独立活动删除按钮。

提交本次停用请求

核查活动标识符和受影响的发送配置后,发送不带 JSON 请求体的 DELETE 请求:

curl --silent --show-error --fail-with-body --user "$API_USER:$API_PASSWORD" \
  --request DELETE \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  "https://api.multitel.net/tcr/v2/campaign/$CAMPAIGN_ID"

文档规定的成功响应为 HTTP 204,响应体为空。请检查 HTTP 状态,而不要期待 JSON status/response 封装。删除请求获接受后,当前服务会在本地将活动资源标记为已删除且已过期,并将其旧版活动记录标记为已过期。此操作不会级联删除品牌。

本次预期操作的请求应使用同一个幂等键,并原样保留方法、路径、查询和请求体字节,以便重放。如果原请求仍在处理中,重复请求可能返回带有 Retry-After 的 409;对于已完成的请求,可以重放已存储的结果。缓存的错误或连接中断无法确定注册机构是否已经执行了操作。请保留活动标识符,以及存在时的 requestId。

核实注册信息和分配关系

请求结束后,请在门户中检查活动的当前状态和受影响的号码。停用后,API 可能保留本地所有权元数据,以便仍可检查归该账户所有的标识符;请勿据此推断同一标识符在本地必定始终返回 404。已停用记录的返回状态或可用性由注册机构决定。

如果某个号码仍有分配关系,请核对并处理该现有分配关系。请勿仅为重试停用而创建另一个活动,也不要认为 HTTP 204 就能证明运营商端已完成清理。如果注册机构接受请求后本地同步失败,即使外部停用已经完成,API 仍可能返回 500。

停用结果
结果后续操作
204预期没有响应体。请核实活动状态,以及独立管理的号码分配关系。
400阅读返回的验证错误或注册机构状态错误。检查确切的活动标识符和现有状态。
401, 403, 404检查 API 凭据、获准的源 IP 地址和账户所有权。请勿改用其他客户的标识符。
409, 429区分正在处理或发生冲突的幂等请求与请求速率限制;如果提供了 Retry-After,请遵照执行。
500, 502 或超时保留请求详情,读取现有活动信息,并在再次提交前完成核对。

停用与账户结算相互独立

当前的 DELETE 服务不会发起即时的活动注册扣费。这不代表承诺退款、免除现有承诺或释放租用的号码。请在门户中查看账户的活动条款和未结清账单。号码租用和消息使用与活动注册相互独立。

如果在核对并处理完活动及其分配关系后,还要停用整个企业注册,请继续执行品牌停用流程。