邀请成员 - Flashcat API

请求参数

Authorization

在 query 添加参数

app_key

示例：

app_key: ********************

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

members

array [object {6}]

成员列表

必需

单次邀请最多20个，单日邀请最多200个

<= 20 items

email

string

邮件地址

可选

和手机号至少有一个，邮件地址必须经过验证才可以接收通知信息，成员登录时系统将引导信息补全或验证

phone

string

手机号

可选

和邮件地址至少有一个，手机号必须经过验证才可以接收通知信息，成员登录时系统将引导信息补全或验证

country_code

string

国家码

可选

默认为CN

member_name

string

成员名称

可选

当传手机号时，必设置；当传email时，缺省使用email前缀。成员名称要求账户下唯一

ref_id

string

关联ID

可选

role_ids

array[integer]

账户角色ID列表

可选

不传不设置

示例

{
  "members": [
    {
      "email": "string",
      "phone": "string",
      "country_code": "string",
      "member_name": "string",
      "ref_id": "string",
      "role_ids": [
        0
      ]
    }
  ]
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.flashcat.cloud/member/invite?app_key' \
--header 'Content-Type: application/json' \
--data-raw '{
    "members": [
        {
            "email": "string",
            "phone": "string",
            "country_code": "string",
            "member_name": "string",
            "ref_id": "string",
            "role_ids": [
                0
            ]
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

error

object (DutyError)

可选

code

enum<string>

错误码

必需

枚举值:

InvalidParameterInvalidContentTypeUnauthorizedAccessDeniedMethodNotAllowedRequestTooFrequentlyRequestVerifyRequiredDangerousOperationRequestLockedRouteNotFoundBalanceNotEnoughUndonedOrderExistResourceNotFoundInternalErrorReferenceExist

message

string

错误描述

必需

items

array[object (MemberItemShort) {2}]

必需

MemberID

integer

成员ID

必需

MemberName

string

成员名称

必需

示例

{
  "error": {
    "code": "InvalidParameter",
    "message": "string"
  },
  "items": [
    {
      "MemberID": 0,
      "MemberName": "string"
    }
  ]
}