全読者一覧
curl --request GET \
--url https://api.utage-system.com/v1/accounts/{account_id}/readers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.utage-system.com/v1/accounts/{account_id}/readers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.utage-system.com/v1/accounts/{account_id}/readers', 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.utage-system.com/v1/accounts/{account_id}/readers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.utage-system.com/v1/accounts/{account_id}/readers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.utage-system.com/v1/accounts/{account_id}/readers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/accounts/{account_id}/readers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"common_reader_id": "<string>",
"scenario_id": "<string>",
"scenario_fields": {},
"common_fields": {},
"line_display_name": "<string>",
"line_picture_url": "<string>",
"base_date": "<string>",
"is_blocked": true,
"is_line_blocked": true,
"is_mail_error": true,
"is_sms_blocked": true,
"partner": {
"name": "<string>"
},
"funnel_tracking_id": "<string>",
"funnel_tracking_name": "<string>",
"message_tracking_id": "<string>",
"message_tracking_name": "<string>",
"scenario_title": "<string>",
"created_at": "<string>"
}
],
"meta": {
"current_page": 123,
"per_page": 123,
"total": 123
}
}{
"error": {
"code": "unauthorized",
"message": "認証に失敗しました"
}
}{
"error": {
"code": "not_found",
"message": "リソースが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "バリデーションエラーが発生しました"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "リクエスト上限を超えました。しばらく時間を空けて再試行してください"
}
}読者
全読者一覧
プレビュー機能。仕様は今後変更される可能性があります。 指定アカウント配下の全シナリオを横断して読者一覧を取得します。
conditions で配信条件と同じ構造(conditions[].rules[].{key, condition, value})の絞り込みが可能です。
シナリオ横断のため、conditions の読者項目で使用できるキーは name / mail のみです(シナリオ固有の読者項目は使用できません)。
特別キー(label / scenario / broadcast / tracking / status / base_date 等)も利用できます。詳細は配信条件タイプ定義(GET /message-condition-types)を参照してください。
各読者の読者項目は scenario_fields(シナリオ固有)/ common_fields(全シナリオ共通)の2グループで返ります。
全読者一覧
curl --request GET \
--url https://api.utage-system.com/v1/accounts/{account_id}/readers \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.utage-system.com/v1/accounts/{account_id}/readers"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.utage-system.com/v1/accounts/{account_id}/readers', 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.utage-system.com/v1/accounts/{account_id}/readers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.utage-system.com/v1/accounts/{account_id}/readers"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.utage-system.com/v1/accounts/{account_id}/readers")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/accounts/{account_id}/readers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"common_reader_id": "<string>",
"scenario_id": "<string>",
"scenario_fields": {},
"common_fields": {},
"line_display_name": "<string>",
"line_picture_url": "<string>",
"base_date": "<string>",
"is_blocked": true,
"is_line_blocked": true,
"is_mail_error": true,
"is_sms_blocked": true,
"partner": {
"name": "<string>"
},
"funnel_tracking_id": "<string>",
"funnel_tracking_name": "<string>",
"message_tracking_id": "<string>",
"message_tracking_name": "<string>",
"scenario_title": "<string>",
"created_at": "<string>"
}
],
"meta": {
"current_page": 123,
"per_page": 123,
"total": 123
}
}{
"error": {
"code": "unauthorized",
"message": "認証に失敗しました"
}
}{
"error": {
"code": "not_found",
"message": "リソースが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "バリデーションエラーが発生しました"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "リクエスト上限を超えました。しばらく時間を空けて再試行してください"
}
}GET
https://api.utage-system.com/v1/accounts/{account_id}/readers
この機能はプレビュー版です。仕様が変更される場合があります。
Authorizations
APIキーをBearerトークンとして指定
Path Parameters
アカウントID
Query Parameters
シナリオIDで絞り込み
配信条件構造による絞り込み。配列またはJSON文字列。
読者項目で使用できるキーは name / mail のみ(シナリオ横断のため)。不正なキー・演算子・空の rules は422になります。
ページ番号
Required range:
x >= 11ページあたりの件数(既定20・最大100。超過時は100に丸められます)
Required range:
1 <= x <= 100⌘I