Get a session

GET

phones

sessions

{session_id}

Get a session

curl --request GET \
  --url https://api.axilio.ai/api/v1/phones/sessions/{session_id} \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/phones/sessions/{session_id}', 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.axilio.ai/api/v1/phones/sessions/{session_id}",
  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-Axilio-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/phones/sessions/{session_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/phones/sessions/{session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "allocated_at": "2023-11-07T05:31:56Z",
  "capture_enabled": true,
  "is_dedicated_phone": true,
  "phone_id": "<string>",
  "phone_status": "active",
  "recording_status": "ready",
  "session_id": "<string>",
  "source": "workflow",
  "status": "active",
  "telemetry_disabled": true,
  "allocated_by": "workflow_editor",
  "deallocated_at": "2023-11-07T05:31:56Z",
  "location": "<string>",
  "model_name": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "phone_name": "<string>",
  "phone_type": "android",
  "recording_url": "<string>",
  "tags": {},
  "workflow_id": "<string>",
  "workflow_name": "<string>"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Path Parameters

session_id

string<uuid>

required

Phone session identifier

Response

Detail for a single session: the session, phone display fields, and a recording URL when available.

allocated_at

string<date-time>

required

When the session claimed the phone.

capture_enabled

boolean

required

Whether media this session produces on the phone is captured into the org's file library. On by default; set capture=false at allocation to disable.

is_dedicated_phone

boolean

required

Whether the phone is a dedicated (rented) phone.

phone_id

string

required

Phone the session ran on.

phone_status

enum<string>

required

Fleet status of the phone.

Available options:

active,

inactive,

maintenance,

suspended

recording_status

enum<string>

required

'ready' when the recording URL is present, 'pending' while the recording is still being processed, or 'expired' when it is past the plan's recording retention window.

Available options:

ready,

pending,

expired

session_id

string

required

Session identifier.

source

enum<string>

required

'workflow' when tied to a workflow, else 'interactive'.

Available options:

workflow,

interactive

status

enum<string>

required

Session lifecycle status.

Available options:

active,

completed,

cancelled,

expired

telemetry_disabled

boolean

required

Whether session telemetry was disabled at allocation. When true the session has no live or archived trace by policy.

allocated_by

enum<string>

How the session was started.

Available options:

workflow_editor,

dashboard_run,

api_run,

interactive

deallocated_at

string<date-time>

When the session released the phone; absent while active.

location

string

Physical hosting location of the phone.

model_name

string

Hardware model name of the phone.

name

string

Optional user-chosen session label; unique among the org's active sessions.

nickname

string

User-assigned phone nickname.

phone_name

string

Display name of the phone.

phone_type

enum<string>

Platform of the phone.

Available options:

android,

iphone,

unknown

recording_url

string

Playback URL for the session recording, set only when ready.

tags

object

Optional key->value labels attached to the session.

Show child attributes

workflow_id

string

Workflow the session executed, when source is 'workflow'.

workflow_name

string

Name of the workflow the session executed.

Get a session

curl --request GET \
  --url https://api.axilio.ai/api/v1/phones/sessions/{session_id} \
  --header 'X-Axilio-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Axilio-Api-Key': '<api-key>'}};

fetch('https://api.axilio.ai/api/v1/phones/sessions/{session_id}', 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.axilio.ai/api/v1/phones/sessions/{session_id}",
  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-Axilio-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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.axilio.ai/api/v1/phones/sessions/{session_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/phones/sessions/{session_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "allocated_at": "2023-11-07T05:31:56Z",
  "capture_enabled": true,
  "is_dedicated_phone": true,
  "phone_id": "<string>",
  "phone_status": "active",
  "recording_status": "ready",
  "session_id": "<string>",
  "source": "workflow",
  "status": "active",
  "telemetry_disabled": true,
  "allocated_by": "workflow_editor",
  "deallocated_at": "2023-11-07T05:31:56Z",
  "location": "<string>",
  "model_name": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "phone_name": "<string>",
  "phone_type": "android",
  "recording_url": "<string>",
  "tags": {},
  "workflow_id": "<string>",
  "workflow_name": "<string>"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

Overview

Device Control Protocol

REST API

Vision API

Authorizations

Path Parameters

Response