Messages

List messages

Returns one page of every text message your dedicated phones have received and sent, across conversations, newest first, each with its full body and its conversation_id; direction tells them apart. Filter by phone_id, direction and when the platform stored the message (created_after, created_before), for example to collect everything since your last read. To read a conversation, use GET /conversations//messages. Only dedicated phones with a current rental receive messages; texts arriving on shared phones, or after a rental lapses, are never stored.

GET

messages

List messages

curl --request GET \
  --url https://api.axilio.ai/api/v1/messages \
  --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/messages', 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/messages",
  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/messages"

	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/messages")

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

{
  "messages": [
    {
      "body": "<string>",
      "channel": "sms",
      "conversation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "direction": "inbound",
      "from": "<string>",
      "id": "<string>",
      "is_group": true,
      "parts": [
        {
          "type": "text",
          "file_id": "<string>",
          "mime_type": "<string>",
          "name": "<string>",
          "size_bytes": 123,
          "text": "<string>"
        }
      ],
      "phone_id": "<string>",
      "received_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "to": [
        "<string>"
      ],
      "truncated": true,
      "accepted_at": "2023-11-07T05:31:56Z",
      "api_key_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "error_code": "phone_unreachable",
      "failed_at": "2023-11-07T05:31:56Z",
      "phone_deletion": {
        "next_check_at": "2023-11-07T05:31:56Z",
        "reason": "<string>",
        "status": "pending"
      },
      "status": "queued",
      "user_id": "<string>"
    }
  ],
  "total": 123
}

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

Authorizations

X-Axilio-Api-Key

string

header

required

Customer API key (axl_ prefix).

Query Parameters

limit

integer<int64>

default:50

max items per page

Required range: 1 <= x <= 100

offset

integer<int64>

default:0

pagination offset

Required range: x >= 0

phone_id

string

only messages on this phone

Maximum string length: 64

created_after

string<date-time>

only messages stored at or after this time (RFC 3339)

created_before

string<date-time>

only messages stored at or before this time (RFC 3339)

direction

enum<string>

only received (inbound) or sent (outbound) messages

Available options:

inbound,

outbound

order_by

string

default:created_at desc

Sort expression '<field> [asc|desc]', direction defaulting to desc. field is created_at (when the platform stored the message), sent_at (when it was sent) or received_at (when the phone received it); messages without that time come last.

Pattern: ^(created_at|sent_at|received_at)( (asc|desc))?$

Response

One page of the organization's messages.

messages

object[] | null

required

Messages, newest first by created_at.

Show child attributes

total

integer<int64>

required

Total messages matching the query.

List messages

curl --request GET \
  --url https://api.axilio.ai/api/v1/messages \
  --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/messages', 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/messages",
  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/messages"

	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/messages")

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

{
  "messages": [
    {
      "body": "<string>",
      "channel": "sms",
      "conversation_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "direction": "inbound",
      "from": "<string>",
      "id": "<string>",
      "is_group": true,
      "parts": [
        {
          "type": "text",
          "file_id": "<string>",
          "mime_type": "<string>",
          "name": "<string>",
          "size_bytes": 123,
          "text": "<string>"
        }
      ],
      "phone_id": "<string>",
      "received_at": "2023-11-07T05:31:56Z",
      "sent_at": "2023-11-07T05:31:56Z",
      "to": [
        "<string>"
      ],
      "truncated": true,
      "accepted_at": "2023-11-07T05:31:56Z",
      "api_key_id": "<string>",
      "deleted_at": "2023-11-07T05:31:56Z",
      "delivered_at": "2023-11-07T05:31:56Z",
      "error": "<string>",
      "error_code": "phone_unreachable",
      "failed_at": "2023-11-07T05:31:56Z",
      "phone_deletion": {
        "next_check_at": "2023-11-07T05:31:56Z",
        "reason": "<string>",
        "status": "pending"
      },
      "status": "queued",
      "user_id": "<string>"
    }
  ],
  "total": 123
}

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

List messages

Authorizations

Query Parameters

Response