邀请成员
curl --request POST \
--url 'https://api.flashcat.cloud/member/invite?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [
6
],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
]
}
'import requests
url = "https://api.flashcat.cloud/member/invite?app_key="
payload = { "members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [6],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
] }
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: 'charlie@example.com',
locale: 'en-US',
time_zone: 'Asia/Shanghai',
role_ids: [6],
schedule_id: 5789640530410
},
{
member_name: 'Dave',
phone: '13800138000',
country_code: 'CN',
locale: 'zh-CN',
time_zone: 'Asia/Shanghai'
}
]
})
};
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' => 'charlie@example.com',
'locale' => 'en-US',
'time_zone' => 'Asia/Shanghai',
'role_ids' => [
6
],
'schedule_id' => 5789640530410
],
[
'member_name' => 'Dave',
'phone' => '13800138000',
'country_code' => 'CN',
'locale' => 'zh-CN',
'time_zone' => 'Asia/Shanghai'
]
]
]),
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\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ],\n \"schedule_id\": 5789640530410\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\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\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ],\n \"schedule_id\": 5789640530410\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\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\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ],\n \"schedule_id\": 5789640530410\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"member_id": 5068740052131,
"member_name": "Charlie"
},
{
"member_id": 5068740052132,
"member_name": "Dave"
}
]
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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."
}
}成员管理
邀请成员
通过邮箱或手机号批量邀请新成员加入组织。每个账户 24 小时内最多发出 200 条邀请,单次请求最多邀请 20 名成员。
POST
/
member
/
invite
邀请成员
curl --request POST \
--url 'https://api.flashcat.cloud/member/invite?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [
6
],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
]
}
'import requests
url = "https://api.flashcat.cloud/member/invite?app_key="
payload = { "members": [
{
"member_name": "Charlie",
"email": "charlie@example.com",
"locale": "en-US",
"time_zone": "Asia/Shanghai",
"role_ids": [6],
"schedule_id": 5789640530410
},
{
"member_name": "Dave",
"phone": "13800138000",
"country_code": "CN",
"locale": "zh-CN",
"time_zone": "Asia/Shanghai"
}
] }
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: 'charlie@example.com',
locale: 'en-US',
time_zone: 'Asia/Shanghai',
role_ids: [6],
schedule_id: 5789640530410
},
{
member_name: 'Dave',
phone: '13800138000',
country_code: 'CN',
locale: 'zh-CN',
time_zone: 'Asia/Shanghai'
}
]
})
};
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' => 'charlie@example.com',
'locale' => 'en-US',
'time_zone' => 'Asia/Shanghai',
'role_ids' => [
6
],
'schedule_id' => 5789640530410
],
[
'member_name' => 'Dave',
'phone' => '13800138000',
'country_code' => 'CN',
'locale' => 'zh-CN',
'time_zone' => 'Asia/Shanghai'
]
]
]),
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\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ],\n \"schedule_id\": 5789640530410\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\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\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ],\n \"schedule_id\": 5789640530410\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\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\": \"charlie@example.com\",\n \"locale\": \"en-US\",\n \"time_zone\": \"Asia/Shanghai\",\n \"role_ids\": [\n 6\n ],\n \"schedule_id\": 5789640530410\n },\n {\n \"member_name\": \"Dave\",\n \"phone\": \"13800138000\",\n \"country_code\": \"CN\",\n \"locale\": \"zh-CN\",\n \"time_zone\": \"Asia/Shanghai\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"items": [
{
"member_id": 5068740052131,
"member_name": "Charlie"
},
{
"member_id": 5068740052132,
"member_name": "Dave"
}
]
}
}{
"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": "AccessDenied",
"message": "Access Denied."
}
}{
"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."
}
}限制说明
| 项目 | 说明 |
|---|---|
| 速率限制 | 每个账户 300 次/分钟;20 次/秒 |
| 权限要求 | 成员管理(organization) |
使用说明
- 每个条目需要提供
email,或同时提供member_name和phone。 - 邮箱或手机号已属于本账户成员的条目会被静默跳过;
items只列出本次新建的成员,一个都没有创建时为null。 - 新成员以
pending状态创建,并通过邮件或短信收到邀请。 - 邮箱以小写存储。账户限制了成员邮箱域名时,不在白名单内的地址返回
400;同一请求内邮箱或手机号重复也返回400。 country_code必须是 ISO 3166-1 alpha-2 地区代码(如 “CN”);写入前校验并统一转为大写,非法值返回 400。- 当成员的
phone不带 ”+” 前缀时,按该成员的country_code作为地区提示解析(未传时默认 “CN”)。 - 每次调用都会记录到账户审计日志,请不要把敏感信息放在请求字段中。
授权
请求体
application/json
此页面对您有帮助吗?