Get Playbook Execution Setting
curl --request GET \
--url https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting \
--header 'X-Api-Key: <api-key>' \
--header 'X-Workspace-Id: <x-workspace-id>'import requests
url = "https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting"
headers = {
"X-Workspace-Id": "<x-workspace-id>",
"X-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Workspace-Id': '<x-workspace-id>', 'X-Api-Key': '<api-key>'}
};
fetch('https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting', 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://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Workspace-Id: <x-workspace-id>"
],
]);
$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://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting")
.header("X-Workspace-Id", "<x-workspace-id>")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"playbook_id": "d4e5f6a7-...",
"auto_execution": true,
"condition_sets": [
{
"label": "オンライン商談",
"auto_execution": true,
"meeting_type": "ONLINE",
"filters": [
{
"target_type": "MEETING_TITLE",
"condition_type": "CONTAINS",
"values": [
"商談"
]
}
]
}
]
}
}API Reference
Get Playbook Execution Setting
指定したPlaybookの自動実行条件を取得します。
Playbookや設定が非公開・無効であっても、同じワークスペースに存在すれば現在の設定を返します。
auto_execution が設定全体の有効状態、各条件セットの auto_execution がその条件セットの有効状態です。
条件セット同士はOR、同じ条件セット内のフィルター同士はAND、同じフィルター内の値はORとして評価されます。
meeting_type が ONLINE の条件は、アップロードされた OFFLINE ミーティングにも一致します。
メンバー条件の値はメンバーAPIの id と突合できます。設定・フィルター・値の内部IDは返しません。
条件の値のうち、APIで参照できないリソースを指すものは省略されます。
カンパニー条件（COMPANY_ID）の値は GET /v2/objects/{object}/records（object=company）で参照できるレコードの id に対応します。
company は段階提供（Staged）のため、ワークスペースによっては CRM オブジェクト API の公開対象外です。
非公開カンパニーを対象にした条件は値が省略され、Frictioの画面に表示される条件より少なく見えることがあります。
クエリパラメータはサポートしていません。
GET
/
v1
/
playbooks
/
{playbookId}
/
execution-setting
Get Playbook Execution Setting
curl --request GET \
--url https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting \
--header 'X-Api-Key: <api-key>' \
--header 'X-Workspace-Id: <x-workspace-id>'import requests
url = "https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting"
headers = {
"X-Workspace-Id": "<x-workspace-id>",
"X-Api-Key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'X-Workspace-Id': '<x-workspace-id>', 'X-Api-Key': '<api-key>'}
};
fetch('https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting', 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://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Workspace-Id: <x-workspace-id>"
],
]);
$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://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Workspace-Id", "<x-workspace-id>")
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting")
.header("X-Workspace-Id", "<x-workspace-id>")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.frictio.ai/v1/playbooks/{playbookId}/execution-setting")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"playbook_id": "d4e5f6a7-...",
"auto_execution": true,
"condition_sets": [
{
"label": "オンライン商談",
"auto_execution": true,
"meeting_type": "ONLINE",
"filters": [
{
"target_type": "MEETING_TITLE",
"condition_type": "CONTAINS",
"values": [
"商談"
]
}
]
}
]
}
}