Update a phone

PATCH

phones

{phone_id}

Update a phone

curl --request PATCH \
  --url https://api.axilio.ai/api/v1/phones/{phone_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "nickname": "<string>"
}
'

import requests

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

payload = { "nickname": "<string>" }
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({nickname: '<string>'})
};

fetch('https://api.axilio.ai/api/v1/phones/{phone_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/{phone_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'nickname' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"nickname\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")
	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.patch("https://api.axilio.ai/api/v1/phones/{phone_id}")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nickname\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nickname\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "current_session_id": "<string>",
  "last_heartbeat_at": "2023-11-07T05:31:56Z",
  "last_interaction_at": "2023-11-07T05:31:56Z",
  "location": "<string>",
  "model_id": "<string>",
  "model_name": "<string>",
  "nickname": "<string>",
  "owner_organization_id": "<string>",
  "ownership_type": "shared",
  "phone_id": "<string>",
  "phone_name": "<string>",
  "phone_number": "<string>",
  "phone_type": "android",
  "rental_expires_at": "2023-11-07T05:31:56Z",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "messaging": {
    "checked_at": "2023-11-07T05:31:56Z",
    "receiving": "on",
    "sending": "on",
    "service": "in_service"
  }
}

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

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

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

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Path Parameters

phone_id

string

required

device identifier

Body

application/json

The fields to change on a dedicated phone.

nickname

string

required

New display name for the phone.

Required string length: 1 - 100

Response

A phone in the fleet: display identity, status, and current allocation.

created_at

string<date-time>

required

When the phone record was created.

current_session_id

string | null

required

Session currently holding the phone, if allocated.

last_heartbeat_at

string<date-time> | null

required

Time of the phone's most recent heartbeat.

last_interaction_at

string<date-time> | null

required

Time of the most recent interaction on the phone.

location

string | null

required

Physical hosting location of the phone.

model_id

string | null

required

Hardware model identifier.

model_name

string | null

required

Hardware model name.

nickname

string | null

required

User-assigned nickname.

owner_organization_id

string | null

required

Owning organization, for private phones.

ownership_type

enum<string>

required

'shared' for pool phones, 'private' for dedicated rentals.

Available options:

shared,

private

phone_id

string

required

Phone identifier used by allocate and the phone APIs.

phone_name

string | null

required

Display name of the phone.

phone_number

string | null

required

The phone's own number in E.164, for a dedicated phone your organization rents: what its SIM reports, or else the number its latest received text was sent to. Null when neither is known, and for shared phones.

phone_type

enum<string> | null

required

Platform of the phone.

Available options:

android,

iphone,

unknown

rental_expires_at

string<date-time> | null

required

When the current rental ends, for rented phones.

status

enum<string>

required

Fleet status of the phone. Only active is allocatable. inactive: unreachable, back on its next heartbeat. maintenance: planned work that releases itself. suspended: an administrative hold. recovering: being repaired automatically. out_of_service: needs a repair at the rack. Treat unknown values as unavailable.

Available options:

active,

inactive,

maintenance,

suspended,

recovering,

out_of_service

updated_at

string<date-time>

required

When the phone record was last updated.

messaging

object

Whether the phone can text, as it last reported, for a dedicated phone your organization rents: checked_at says when, and status whether it is reachable now. Absent for shared phones.

Show child attributes

Update a phone

curl --request PATCH \
  --url https://api.axilio.ai/api/v1/phones/{phone_id} \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "nickname": "<string>"
}
'

import requests

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

payload = { "nickname": "<string>" }
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({nickname: '<string>'})
};

fetch('https://api.axilio.ai/api/v1/phones/{phone_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/{phone_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'nickname' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"nickname\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("X-Axilio-Api-Key", "<api-key>")
	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.patch("https://api.axilio.ai/api/v1/phones/{phone_id}")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"nickname\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["X-Axilio-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"nickname\": \"<string>\"\n}"

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "current_session_id": "<string>",
  "last_heartbeat_at": "2023-11-07T05:31:56Z",
  "last_interaction_at": "2023-11-07T05:31:56Z",
  "location": "<string>",
  "model_id": "<string>",
  "model_name": "<string>",
  "nickname": "<string>",
  "owner_organization_id": "<string>",
  "ownership_type": "shared",
  "phone_id": "<string>",
  "phone_name": "<string>",
  "phone_number": "<string>",
  "phone_type": "android",
  "rental_expires_at": "2023-11-07T05:31:56Z",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "messaging": {
    "checked_at": "2023-11-07T05:31:56Z",
    "receiving": "on",
    "sending": "on",
    "service": "in_service"
  }
}

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

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

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

Argus API

Update a phone

Authorizations

Path Parameters

Body

Response