Fetch current interaction
Fetch the current interaction in a GBG Go journey to determine which domain elements to collect from the end user.
POST
/
journey
/
interaction
/
fetch
Fetch current interaction
curl --request POST \
--url https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instanceId": "<string>"
}
'import requests
url = "https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch"
payload = { "instanceId": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({instanceId: '<string>'})
};
fetch('https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch', 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://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch",
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([
'instanceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch"
payload := strings.NewReader("{\n \"instanceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"instanceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"instanceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"instanceId": "<string>",
"journey": {
"status": "<string>"
},
"interactionId": "<string>",
"interaction": {},
"context": {},
"instructions": "<unknown>",
"outstanding": "<unknown>",
"outstandingGroups": [
{
"elementId": "<string>",
"cardinality": "at-least-one",
"refs": [
"<string>"
]
}
],
"processing": true,
"result": {},
"joinedDevice": {
"connected": true
}
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}Authorizations
CustomerAccessInteractionAccess
Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start
Query Parameters
Response profile. Omit or 'full' for the full response (default, unchanged). 'slim' returns the compact, typed customer-facing shape. Any other value returns 400.
Example:
"slim"
Body
application/json
Response
Interaction state (full by default; slim with ?view=slim)
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Fetch current interaction
curl --request POST \
--url https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"instanceId": "<string>"
}
'import requests
url = "https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch"
payload = { "instanceId": "<string>" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({instanceId: '<string>'})
};
fetch('https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch', 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://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch",
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([
'instanceId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch"
payload := strings.NewReader("{\n \"instanceId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"instanceId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/fetch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"instanceId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"instanceId": "<string>",
"journey": {
"status": "<string>"
},
"interactionId": "<string>",
"interaction": {},
"context": {},
"instructions": "<unknown>",
"outstanding": "<unknown>",
"outstandingGroups": [
{
"elementId": "<string>",
"cardinality": "at-least-one",
"refs": [
"<string>"
]
}
],
"processing": true,
"result": {},
"joinedDevice": {
"connected": true
}
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}{
"errors": [
{
"code": "<string>",
"name": "<string>",
"problem": "<string>",
"action": "<string>",
"location": "Path"
}
]
}