Phones

Mint a live-view token

Mints a fresh live-view token (and hosted viewer URL) for an active session, per the session’s allocate-time live_view settings: token-mode sessions re-issue the bearer link allocate returned once, org-mode sessions exchange the caller’s identity. Refused for sessions allocated with live_view.disabled, for inactive sessions, and for sessions outside the caller’s organization (reads as not found). Sharp edge: the returned URL embeds the token and is a bearer capability — whoever holds it can watch (and, unless the session was allocated view-only, drive) the phone until the session ends, at which point both stop working.

POST

phones

sessions

{session_id}

live-view-token

Mint a live-view token

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

import requests

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

headers = {"X-Axilio-Api-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

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

fetch('https://api.axilio.ai/api/v1/phones/sessions/{session_id}/live-view-token', 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}/live-view-token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/live-view-token"

	req, _ := http.NewRequest("POST", 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}/live-view-token")

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

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

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

{
  "live_view_url": "<string>",
  "phone_id": "<string>",
  "session_id": "<string>",
  "token": "<string>",
  "view_only": true
}

{
  "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"
}

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Path Parameters

session_id

string<uuid>

required

Phone session identifier

Response

Live-view token mint response.

live_view_url

string

required

Hosted live-view page URL embedding this token (live screen + interaction, iframe-embeddable). Bearer capability; treat as a secret. Dies with the session.

phone_id

string

required

The session's phone.

session_id

string

required

Session the token is scoped to.

token

string

required

Allocation-scoped live-view token.

view_only

boolean

required

Whether the session's live view is watch-only.

Mint a live-view token

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

import requests

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

headers = {"X-Axilio-Api-Key": "<api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

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

fetch('https://api.axilio.ai/api/v1/phones/sessions/{session_id}/live-view-token', 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}/live-view-token",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  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}/live-view-token"

	req, _ := http.NewRequest("POST", 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}/live-view-token")

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

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

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

{
  "live_view_url": "<string>",
  "phone_id": "<string>",
  "session_id": "<string>",
  "token": "<string>",
  "view_only": true
}

{
  "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

Mint a live-view token

Authorizations

Path Parameters

Response