人物連絡先の一括引き換え
curl --request POST \
--url https://api.pubrio.com/redeem/people/batch \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"peoples": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"people_contact_types": [
"email-personal",
"email-work",
"phone"
],
"profile_id": 123
}
'import requests
url = "https://api.pubrio.com/redeem/people/batch"
payload = {
"peoples": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"people_contact_types": ["email-personal", "email-work", "phone"],
"profile_id": 123
}
headers = {
"pubrio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
peoples: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
people_contact_types: ['email-personal', 'email-work', 'phone'],
profile_id: 123
})
};
fetch('https://api.pubrio.com/redeem/people/batch', 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.pubrio.com/redeem/people/batch",
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([
'peoples' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'people_contact_types' => [
'email-personal',
'email-work',
'phone'
],
'profile_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"pubrio-api-key: <api-key>"
],
]);
$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.pubrio.com/redeem/people/batch"
payload := strings.NewReader("{\n \"peoples\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"people_contact_types\": [\n \"email-personal\",\n \"email-work\",\n \"phone\"\n ],\n \"profile_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("pubrio-api-key", "<api-key>")
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.pubrio.com/redeem/people/batch")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"peoples\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"people_contact_types\": [\n \"email-personal\",\n \"email-work\",\n \"phone\"\n ],\n \"profile_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/redeem/people/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"peoples\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"people_contact_types\": [\n \"email-personal\",\n \"email-work\",\n \"phone\"\n ],\n \"profile_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"redeem_query_id": "a046c1da-b3d4-4ca1-aca6-1dd8c8055701",
"is_completed": false,
"estimated_time": 6,
"estimated_time_type": "second"
}
}{
"code": 40001,
"message": "エラーの背景やフィールド単位の情報などを含む追加データオブジェクトです。",
"details": {}
}{
"error": "クライアントはしばらく待ってから再試行することが推奨されます。"
}{
"error": "レスポンスボディには `error` フィールドが含まれ、問題の概要がメッセージとして記載されます。"
}引き換え
人物リディーム(バッチ処理)
複数の人物の連絡先情報を一括でアンロックするバッチリクエストを送信します。
POST
/
redeem
/
people
/
batch
人物連絡先の一括引き換え
curl --request POST \
--url https://api.pubrio.com/redeem/people/batch \
--header 'Content-Type: application/json' \
--header 'pubrio-api-key: <api-key>' \
--data '
{
"peoples": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"people_contact_types": [
"email-personal",
"email-work",
"phone"
],
"profile_id": 123
}
'import requests
url = "https://api.pubrio.com/redeem/people/batch"
payload = {
"peoples": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"people_contact_types": ["email-personal", "email-work", "phone"],
"profile_id": 123
}
headers = {
"pubrio-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'pubrio-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
peoples: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
people_contact_types: ['email-personal', 'email-work', 'phone'],
profile_id: 123
})
};
fetch('https://api.pubrio.com/redeem/people/batch', 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.pubrio.com/redeem/people/batch",
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([
'peoples' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'people_contact_types' => [
'email-personal',
'email-work',
'phone'
],
'profile_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"pubrio-api-key: <api-key>"
],
]);
$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.pubrio.com/redeem/people/batch"
payload := strings.NewReader("{\n \"peoples\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"people_contact_types\": [\n \"email-personal\",\n \"email-work\",\n \"phone\"\n ],\n \"profile_id\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("pubrio-api-key", "<api-key>")
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.pubrio.com/redeem/people/batch")
.header("pubrio-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"peoples\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"people_contact_types\": [\n \"email-personal\",\n \"email-work\",\n \"phone\"\n ],\n \"profile_id\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pubrio.com/redeem/people/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["pubrio-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"peoples\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"people_contact_types\": [\n \"email-personal\",\n \"email-work\",\n \"phone\"\n ],\n \"profile_id\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"redeem_query_id": "a046c1da-b3d4-4ca1-aca6-1dd8c8055701",
"is_completed": false,
"estimated_time": 6,
"estimated_time_type": "second"
}
}{
"code": 40001,
"message": "エラーの背景やフィールド単位の情報などを含む追加データオブジェクトです。",
"details": {}
}{
"error": "クライアントはしばらく待ってから再試行することが推奨されます。"
}{
"error": "レスポンスボディには `error` フィールドが含まれ、問題の概要がメッセージとして記載されます。"
}承認
ボディ
application/json
ユーザー検索処理で利用する people_search_id の一覧です。
取得する連絡先種別(勤務メール、個人メール、電話番号など)を制御するためのパラメーターで、1 つ以上を指定できます。
利用可能なオプション:
email-personal, email-work, phone 例:
["email-personal", "email-work", "phone"]オプション。リクエストを送信するチームを表す識別子です。API キーにワークスペース情報が既に含まれているため、このパラメータは必須ではなくなりました。指定した場合、検索結果が特定のチーム(ワークスペース)に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。
レスポンス
関連する詳細情報を含む成功レスポンスです。
エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。
⌘I

