目录

停止邀请码

功能介绍

此接口用于邀请测试停止邀请码。

接口原型

承载协议

HTTPS POST

接口方向

服务商服务器 -> 华为服务器

接口URL

https://connect-api.cloud.huawei.com/api/invitation/v1/invitationCode/stop

数据格式

请求：Content-Type: application/json

响应：Content-Type: application/json

请求参数

[h2]Header

参数名称

必选(M)/可选(O)

类型

参数说明

client_id

M

String

API客户端ID。

创建第三方平台成功后系统自动分配的客户端ID，可在第三方管理平台“开发配置 > 开发资料设置”页面中获取，详情请参见接口访问凭证（平台访问凭据）。

Authorization

M

String

认证信息，格式为“Authorization: Bearer ${access_token}”。access_token为获取平台级Token中获取的access_token。

[h2]Body

请求Body中使用JSON格式携带邀请码信息，参数如下表所示。

参数名称

必选(M)/可选(O)

类型

参数说明

app_id

M

String(128)

应用ID。

invitation_code_id

O

String(64)

邀请码ID。

请求示例

 POST /api/invitation/v1/invitationCode/stop HTTP/1.1 
 Host: connect-api.cloud.huawei.com 
 client_id: 4141******68 
 Content-Type: application/json 
 Authorization: Bearer ******* 
  {
   "app_id": "761e********08",
   "invitationCodeId": "1f******ll"
 }

响应参数

参数名称

必选(M)/可选(O)

类型

参数说明

resultCode

M

String(16)

返回码。

具体返回码如下：

  • 000000：Success
  • ASD990300：System error，即系统错误。
  • ASD700000：Invalid parameter，即通用参数校验失败。
  • ASD700002：Permission denied，即认证失败。
  • ASD810201：Service exception, try later，即通用业务异常。

resultDesc

M

String(32)

返回码描述信息。

businessCode

O

String(128)

业务错误码。

取值范围：

  • 100：邀请码ID不存在。
  • 101：邀请码已失效。
  • 102：邀请码已达使用次数上限。

响应示例

{
  "rtnCode": 0,
  "rtnDesc": "success",
  "businessCode": 0
}