邀请成员

通过邮箱或手机号批量邀请新成员加入组织。

POST /member/invite

邀请成员

cURL

curl --request POST \
  --url 'https://api.flashcat.cloud/member/invite?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "members": [
    {
      "member_name": "Charlie",
      "email": "[e-mail]",
      "locale": "en-US",
      "time_zone": "Asia/Shanghai",
      "role_ids": [
        6
      ]
    }
  ]
}
'

import requests

url = "https://api.flashcat.cloud/member/invite?app_key="

payload = { "members": [
        {
            "member_name": "Charlie",
            "email": "[e-mail]",
            "locale": "en-US",
            "time_zone": "Asia/Shanghai",
            "role_ids": [6]
        }
    ] }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    members: [
      {
        member_name: 'Charlie',
        email: '[e-mail]',
        locale: 'en-US',
        time_zone: 'Asia/Shanghai',
        role_ids: [6]
      }
    ]
  })
};

fetch('https://api.flashcat.cloud/member/invite?app_key=', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flashcat.cloud/member/invite?app_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'members' => [
        [
                'member_name' => 'Charlie',
                'email' => '[e-mail]',
                'locale' => 'en-US',
                'time_zone' => 'Asia/Shanghai',
                'role_ids' => [
                                6
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flashcat.cloud/member/invite?app_key="

	payload := strings.NewReader("{\n  \"members\": [\n    {\n      \"member_name\": \"Charlie\",\n      \"email\": \"[e-mail]\",\n      \"locale\": \"en-US\",\n      \"time_zone\": \"Asia/Shanghai\",\n      \"role_ids\": [\n        6\n      ]\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.flashcat.cloud/member/invite?app_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"members\": [\n    {\n      \"member_name\": \"Charlie\",\n      \"email\": \"[e-mail]\",\n      \"locale\": \"en-US\",\n      \"time_zone\": \"Asia/Shanghai\",\n      \"role_ids\": [\n        6\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.flashcat.cloud/member/invite?app_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"members\": [\n    {\n      \"member_name\": \"Charlie\",\n      \"email\": \"[e-mail]\",\n      \"locale\": \"en-US\",\n      \"time_zone\": \"Asia/Shanghai\",\n      \"role_ids\": [\n        6\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "member_id": 5068740052131,
        "member_name": "Charlie"
      }
    ]
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InvalidParameter",
    "message": "The specified parameter is not valid."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "Unauthorized",
    "message": "You are unauthorized."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "RequestTooFrequently",
    "message": "Request too frequently."
  }
}

{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "error": {
    "code": "InternalError",
    "message": "We encountered an internal error, and it has been reported. Please try again later."
  }
}

​

限制说明

项目	说明
速率限制	每个账户 1,000 次/分钟；50 次/秒
权限要求	成员管理（organization）

授权

app_key · string · query · 必填

在 Flashduty 控制台 账户 → APP Key 中签发的 app_key。调用任何公开 API 时都必须携带。它等同于所属账户的身份凭证，请妥善保管。

请求体

application/json

邀请成员请求

members · object[] · 必填

待邀请成员列表（最多 20 个）

Show child attributes

from · string

邀请来源上下文

响应

200

application/json

成功

成功响应结构。2xx 响应中 request_id 标识本次调用（同时出现在 Flashcat-Request-Id 响应头中），data 为接口业务 payload。失败响应使用不同结构，参见 ErrorResponse。

request_id · string · 必填

本次请求的唯一 ID，也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data · object · 必填

邀请成员响应

Show child attributes