批量添加来宾用户

aki发表于:2019年08月16日 10:20:45更新于:2022年05月07日 12:39:52

批量添加来宾用户

不发送邀请邮件等,直接添加来宾用户。

  • 不管是否启用空间功能,都可以执行。

  • 不管是否启用来宾空间功能,都可以执行。

  • 如要与来宾空间关联,需要另外使用更新来宾空间的来宾成员的API 。

  • 添加的来宾用户,其邮件通知功能默认为ON。

HTTP 方法

POST

URI

https://(子域名).cybozu.cn/k/v1/guests.json

必要的访问权限

kintone系统管理员

请求参数

参数名称要指定的值必须说明
guests数组必须指定要添加的来宾用户的信息。
guests[].code字符串必须指定要添加的来宾用户的邮箱地址。
guests[].password字符串必须指定要添加的来宾用户的密码。
guests[].timezone字符串必须指定要添加的来宾用户的时区。
guests[].locale字符串
指定要添加的来宾用户的语言。 可指定auto(根据浏览器自动判断)、ja、en、zh。
省略时为auto。
guests[].image字符串
指定要添加的来宾用户的头像。使用文件上传API来上传文件,并在该参数中指定其返回的key。
省略时,使用初始头像。
guests[].name字符串必须在1~128个字符内指定要添加的来宾用户的显示名称。
guests[].surNameReading字符串

在64个字符内指定要添加的来宾用户的姓(拼音)。

省略时为空。

guests[].givenNameReading字符串

在64个字符内指定要添加的来宾用户的名字(拼音)。

省略时为空。

guests[].company字符串

在100个字符内指定要添加的来宾用户的公司名称。

省略时为空。

guests[].division字符串

在100个字符内指定要添加的来宾用户的部门。

省略时为空。

guests[].phone字符串

在100个字符内指定要添加的来宾用户的电话号码。

省略时为空。

guests[].callto字符串

在256个字符内指定要添加的来宾用户的 skype 用户名
省略时为空。

请求范例

以下是在HTTP请求的请求正文中设置JSON数据的范例。

请求头部
POST /k/v1/guests.json HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json
正文
{    
    "guests": [    
        {    
            "code": "kzhang@example.com",    
            "password": "p@ssword",    
            "timezone": "Asia/Shanghai",    
            "locale": "zh",    
            "image": "78a586f2-e73e-4a70-bec2-43976a60746e",    
            "name": "张 恺",    
            "surNameReading": "zhang",    
            "givenNameReading": "kai",    
            "company": "才望子信息技术(上海)有限公司",    
            "division": "营业部",    
            "phone": "137-4566-7890",    
            "callto": "zhangkai"    
        },    
        {    
            "code": "hli@example.com",    
            "password": "p@ssword",    
            "timezone": "Asia/Shanghai",    
            "locale": "auto",    
            "image": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",    
            "name": "李 好",    
            "surNameReading": "li",    
            "givenNameReading": "hao",    
            "company": "才望子信息技术(上海)有限公司",    
            "division": "开发部",    
            "phone": "135-1111-2222",    
            "callto": "lihao"    
        }    
    ]    
}
  • Content-Type里请指定application/json。如不指定,JSON 无法解析,执行时会报错。

  • JSON字符串放在请求正文里发送。

应答

处理成功时返回空的JSON数据。

{}

JavaScript范例

使用API请求发送 kintone REST API 请求

var body = {    
    "guests": [    
        {    
            "code": "kzhang@example.com",    
            "password": "p@ssword",    
            "timezone": "Asia/Shanghai",    
            "locale": "zh",    
            "image": "78a586f2-e73e-4a70-bec2-43976a60746e",    
            "name": "张 恺",    
            "surNameReading": "zhang",    
            "givenNameReading": "kai",    
            "company": "才望子信息技术(上海)有限公司",    
            "division": "营业部",    
            "phone": "137-4566-7890",    
            "callto": "zhangkai"    
        },    
        {    
            "code": "hli@example.com",    
            "password": "p@ssword",    
            "timezone": "Asia/Shanghai",    
            "locale": "auto",    
            "image": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",    
            "name": "李 好",    
            "surNameReading": "li",    
            "givenNameReading": "hao",    
            "company": "才望子信息技术(上海)有限公司",    
            "division": "开发部",    
            "phone": "135-1111-2222",    
            "callto": "lihao"    
        }    
    ]    
}    
kintone.api(kintone.api.url('/k/v1/guests', true), 'POST', body, function(resp) {    
    // success    
    console.log(resp);    
}, function(error) {    
    // error    
    console.log(error);    
});

使用 XMLHttpRequest 请求

var body = {    
    "guests": [    
        {    
            "code": "kzhang@example.com",    
            "password": "p@ssword",    
            "timezone": "Asia/Shanghai",    
            "locale": "zh",    
            "image": "78a586f2-e73e-4a70-bec2-43976a60746e",    
            "name": "张 恺",    
            "surNameReading": "zhang",    
            "givenNameReading": "kai",    
            "company": "才望子信息技术(上海)有限公司",    
            "division": "营业部",    
            "phone": "137-4566-7890",    
            "callto": "zhangkai"    
        },    
        {    
            "code": "hli@example.com",    
            "password": "p@ssword",    
            "timezone": "Asia/Shanghai",    
            "locale": "auto",    
            "image": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",    
            "name": "李 好",    
            "surNameReading": "li",    
            "givenNameReading": "hao",    
            "company": "才望子信息技术(上海)有限公司",    
            "division": "开发部",    
            "phone": "135-1111-2222",    
            "callto": "lihao"    
        }    
    ],    
    // CSRF TOKEN: 从kintone上执行API(POST, PUT, DELETE)时需要设置    
"__REQUEST_TOKEN__": kintone.getRequestToken()    
}

var url = 'https://{subdomain}.cybozu.cn/k/v1/guests.json';    
var xhr = new XMLHttpRequest();    
xhr.open('POST', url);    
xhr.setRequestHeader('X-Requested-With', 'XMLHttpRequest');    
xhr.setRequestHeader('Content-Type', 'application/json');    
xhr.onload = function() {    
    if (xhr.status === 200) {    
        // success    
        console.log(JSON.parse(xhr.responseText));    
    } else {    
        // error    
        console.log(JSON.parse(xhr.responseText));    
    }    
};    
xhr.send(JSON.stringify(body));