跳转到主要内容
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": "服务器在处理请求时遇到了未预料的异常。"
}

授权

pubrio-api-key
string
header
必填

一个唯一的 API 令牌,用于标识您通过 API 执行的操作以及相应的权限和操作。您可以在 设置 部分创建该令牌。

请求体

application/json
peoples
string<uuid>[]
必填

用于用戶检索操作的一组唯一标识符(people_search_id)列表。

people_contact_types
enum<string>[]
必填

该参数用于控制检索的联系方式类型,如工作邮箱、个人邮箱、电话号码。可输入一个或多个。

可用选项:
email-personal,
email-work,
phone
示例:
["email-personal", "email-work", "phone"]
profile_id
integer

可选。发起请求的团队标识符。由于 API 密钥已包含您的工作区信息,此参数不再是必填项。如果提供,该 ID 有助于将查找与特定团队(工作区)关联,实现数据检索和额度追踪。

更多信息请参见团队标签下的 user details 端点。

响应

包含相关详细信息的成功响应。

data
object | null

响应信息取决于具体接口。