Conversations

Delete a conversation

Deletes every message in a conversation, as DELETE /messages/ does for one: the conversation and its messages are removed from every list at once, attachments within 48 hours, and the phone is asked to delete the conversation’s messages on its side up to the newest message deleted here (anything it holds that is newer, including texts it has not passed on yet, stays). The response returns at once, with phone_deletion.status pending while the phone has not answered; Axilio keeps checking for up to 7 days, asking the phone again until it confirms (phone_deletion.next_check_at is the next check), and a phone not yet set up to delete messages (not_default_app) is asked once it can. GET /messages/ on any of the deleted messages shows where the phone’s copy stands, and each message fires message.deleted, then message.phone_deleted or message.phone_delete_failed, as DELETE /messages/ describes. Deleting a conversation does not stop a message in it the phone is still sending. A conversation with no messages left is a 404.

DELETE

conversations

{conversation_id}

curl --request DELETE \
  --url https://api.axilio.ai/api/v1/conversations/{conversation_id} \
  --header 'X-Axilio-Api-Key: <api-key>'

import requests

url = "https://api.axilio.ai/api/v1/conversations/{conversation_id}"

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

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

print(response.text)

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

fetch('https://api.axilio.ai/api/v1/conversations/{conversation_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/conversations/{conversation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  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/{conversation_id}"

	req, _ := http.NewRequest("DELETE", 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/{conversation_id}")

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

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

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

{
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "message_count": 123,
  "phone_deletion": {
    "next_check_at": "2023-11-07T05:31:56Z",
    "reason": "<string>",
    "status": "pending"
  }
}

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

conversation_id

string<uuid>

required

conversation identifier

Response

A deleted conversation: every message in it is deleted and it no longer appears in any list or read.

deleted_at

string<date-time>

required

When the conversation was deleted.

string

required

The deleted conversation's id.

message_count

integer<int64>

required

How many messages were deleted.

phone_deletion

object

required

What the delete did to the conversation on the phone. Each deleted message's GET /messages/{message_id} shows the same outcome.

Show child attributes

Delete a conversation

curl --request DELETE \
  --url https://api.axilio.ai/api/v1/conversations/{conversation_id} \
  --header 'X-Axilio-Api-Key: <api-key>'

import requests

url = "https://api.axilio.ai/api/v1/conversations/{conversation_id}"

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

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

print(response.text)

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

fetch('https://api.axilio.ai/api/v1/conversations/{conversation_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/conversations/{conversation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  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/{conversation_id}"

	req, _ := http.NewRequest("DELETE", 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/{conversation_id}")

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

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

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

{
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "message_count": 123,
  "phone_deletion": {
    "next_check_at": "2023-11-07T05:31:56Z",
    "reason": "<string>",
    "status": "pending"
  }
}

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

Delete a conversation

Authorizations

Path Parameters

Response