Conversations

List conversations

Returns one page of your dedicated phones’ conversations, newest activity first: one per phone and set of people it texts with, each with its participants and latest message. Filter by phone (phone_id, or phone_number, the phone’s own number), and search the participants with search, which matches any part of a person’s number with formatting ignored. A text sent to a number and the replies from it are one conversation; the same number on two of your phones is two. Filter by what became of your texts with status, error_code and replied, optionally within a period (period_start_at, period_end_at): they look only at texts you sent in that period (the 7 days before period_end_at when the start is unset, the same window rules as GET /messages/metrics), combine with each other and with the other filters, and list a conversation when it passes every one. status and error_code match a conversation with at least one such text, so they list conversations, not texts: GET /messages/metrics counts both, in totals (texts) and conversations.by_outcome and failures[].conversations (conversations). With only a period, it lists the conversations you texted in it.

GET

conversations

List conversations

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

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

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

{
  "conversations": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "is_group": true,
      "last_message": {
        "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>"
      },
      "last_message_at": "2023-11-07T05:31:56Z",
      "participants": [
        {
          "handle": "<string>"
        }
      ],
      "phone_id": "<string>",
      "phone_number": "<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 conversations on this phone

Maximum string length: 64

phone_number

string

only conversations on the phone with this own number, E.164 (for example +16282788410)

Maximum string length: 32

status

enum<string>

only conversations with at least one text of yours, sent in the period, in this status: the same values as a message's status. sent means it left the phone but no delivery report came. A conversation counts once however many of its texts match. More statuses may be added.

Available options:

delivered,

sent,

unconfirmed,

failed,

queued

error_code

enum<string>

only conversations with at least one text of yours, sent in the period, that failed for this reason: the same codes as a message's error_code. A conversation counts once however many of its texts match. More codes may be added.

Available options:

phone_unreachable,

no_result,

policy_off,

expired,

no_subscription,

no_service,

radio_off,

carrier_rejected,

phone_rate_limited,

media_fetch_failed,

connection_lost,

queue_full,

send_failed

replied

enum<string>

true: only conversations you texted in the period where they wrote back within 24 hours of one of those texts (the reply may land after the period ends). false: only the ones you texted that they did not answer that way. The same rule as replied in GET /messages/metrics, so its texted minus replied is the number false lists.

Available options:

true,

false

period_start_at

string<date-time>

start of the period (RFC 3339) the status, error_code and replied filters look at your texts in. Unset: 7 days before period_end_at. It may be at most a year before now.

period_end_at

string<date-time>

end of the period (RFC 3339). Unset: now, and a later time is read as now. Must be after period_start_at.

string

free-text search across the conversation's participants: a conversation matches when someone's handle contains this. For a number the digits are compared with formatting ignored, so +1 (415) 555-0123, 4155550123 and 0123 all match +14155550123; other text matches a short code or an alphanumeric sender, case-insensitive.

Maximum string length: 64

Response

One page of the organization's conversations.

conversations

object[] | null

required

Conversations, newest activity first by last_message_at.

Show child attributes

total

integer<int64>

required

Total conversations matching the query.

List conversations

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

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

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

{
  "conversations": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "is_group": true,
      "last_message": {
        "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>"
      },
      "last_message_at": "2023-11-07T05:31:56Z",
      "participants": [
        {
          "handle": "<string>"
        }
      ],
      "phone_id": "<string>",
      "phone_number": "<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 conversations

Authorizations

Query Parameters

Response