Reply in a conversation

POST

conversations

{conversation_id}

messages

curl --request POST \
  --url https://api.axilio.ai/api/v1/conversations/{conversation_id}/messages \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "idempotency_key": "<string>",
  "parts": [
    {
      "file_id": "<string>",
      "text": "<string>"
    }
  ]
}
'

import requests

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

payload = {
    "idempotency_key": "<string>",
    "parts": [
        {
            "file_id": "<string>",
            "text": "<string>"
        }
    ]
}
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({idempotency_key: '<string>', parts: [{file_id: '<string>', text: '<string>'}]})
};

fetch('https://api.axilio.ai/api/v1/conversations/{conversation_id}/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/conversations/{conversation_id}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotency_key' => '<string>',
    'parts' => [
        [
                'file_id' => '<string>',
                'text' => '<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/conversations/{conversation_id}/messages"

	payload := strings.NewReader("{\n  \"idempotency_key\": \"<string>\",\n  \"parts\": [\n    {\n      \"file_id\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.axilio.ai/api/v1/conversations/{conversation_id}/messages")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotency_key\": \"<string>\",\n  \"parts\": [\n    {\n      \"file_id\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/conversations/{conversation_id}/messages")

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>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotency_key\": \"<string>\",\n  \"parts\": [\n    {\n      \"file_id\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ]\n}"

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

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

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

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

Body

application/json

idempotency_key

string

required

A caller-chosen key; the same key for your organization sends at most once.

Required string length: 1 - 128

parts

object[] | null

required

The message content in order. An SMS is one text part; media parts (at most 2 MiB in all) make it an MMS, with any text part first.

Required array length: 1 - 11 elements

Show child attributes

Response

Accepted

A text message on one of the organization's dedicated phones.

body

string

required

The message text: every text part, in order, joined with a newline. Empty for a message with no text.

channel

enum<string>

required

How the message travelled: sms (plain text), mms (multimedia, including group texts and some long texts), or rcs. More channels may be added; treat a value you don't know as a channel you don't handle.

Available options:

sms,

mms,

rcs

conversation_id

string

required

The conversation this message is in: GET /conversations/{conversation_id} reads it, and its messages are at GET /conversations/{conversation_id}/messages.

created_at

string<date-time>

required

When the platform stored the message. Lists sort and filter on this time.

direction

enum<string>

required

inbound for a message the phone received, outbound for one it sent.

Available options:

inbound,

outbound

from

string | null

required

Sender: an E.164 number, a short code, or an alphanumeric sender id. Null only when the sender is this phone's own SIM and the phone does not know its number.

string

required

Message identifier.

is_group

boolean

required

True for a group message (more than one recipient).

parts

object[] | null

required

The message content in order: text and media. A plain SMS has one text part.

Show child attributes

phone_id

string

required

The phone that received or sent the message.

received_at

string<date-time> | null

required

When this phone received the message, by the phone's clock, to the millisecond. Null for a message the phone sent.

sent_at

string<date-time> | null

required

When the message was sent. For a received message, the sending network's clock (SMS carries whole seconds); for a message this phone sent, when the platform learned the network accepted it. Null for a message not sent yet.

string[] | null

required

Every recipient, as E.164 numbers. For a one-to-one inbound message this is the phone's own number; a group message lists every recipient. Empty when the only recipient is this phone's own SIM and the phone does not know its number.

truncated

boolean

required

True when the text was longer than 5000 characters and was cut to that length.

accepted_at

string<date-time>

When the phone reported it had this outgoing message. Absent for a received message, and for one the phone never got.

api_key_id

string

The API key that sent this message. Absent for a message a signed-in user sent, a received message, and one sent before senders were recorded.

deleted_at

string<date-time>

When the message was deleted. Present only on a deleted message, which GET /messages/{message_id} still returns with no body or parts; lists and conversations leave it out.

delivered_at

string<date-time>

When a message this phone sent was delivered. Absent until then, and for a received message.

error

string

Why an outbound message failed or is unconfirmed, in words. Empty otherwise.

error_code

enum<string>

Why an outbound message failed or is unconfirmed, as a code to branch on: phone_unreachable (the phone never got it before its deadline; it did not go out), no_result (unconfirmed: the phone had it but has not reported), policy_off (the phone's sending switch is off), expired (its deadline passed before the phone could send it), no_subscription (no SIM line), no_service (no mobile service or data), radio_off, carrier_rejected, phone_rate_limited (Android's outgoing-message limit on the phone), media_fetch_failed (the phone could not download the attachment), connection_lost (the phone lost its connection before sending; it did not go out), queue_full (the phone was too busy), or send_failed (any other failure; error has the detail). Empty when error is. Absent on a failure reported by older phone software.

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

failed_at

string<date-time>

When a message this phone sent failed. Absent unless its status is failed.

phone_deletion

object

What the delete did to the copy on the phone. Present only on a deleted message: pending until the phone answers, then its answer.

Show child attributes

status

enum<string>

The delivery state of a message this phone sent: queued (accepted and issued to the phone), sent (the network accepted it), delivered (the recipient acknowledged it), failed, or unconfirmed (the phone had it but has not reported whether it went out; do not resend automatically, it may still turn sent or failed). Empty for a received message. More statuses may be added; treat one you don't know as still in progress.

Available options:

queued,

sent,

delivered,

failed,

unconfirmed

user_id

string

The signed-in user who sent this message, from the dashboard or the CLI. Absent for a message sent with an API key, a received message, and one sent before senders were recorded.

Reply in a conversation

curl --request POST \
  --url https://api.axilio.ai/api/v1/conversations/{conversation_id}/messages \
  --header 'Content-Type: application/json' \
  --header 'X-Axilio-Api-Key: <api-key>' \
  --data '
{
  "idempotency_key": "<string>",
  "parts": [
    {
      "file_id": "<string>",
      "text": "<string>"
    }
  ]
}
'

import requests

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

payload = {
    "idempotency_key": "<string>",
    "parts": [
        {
            "file_id": "<string>",
            "text": "<string>"
        }
    ]
}
headers = {
    "X-Axilio-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Axilio-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({idempotency_key: '<string>', parts: [{file_id: '<string>', text: '<string>'}]})
};

fetch('https://api.axilio.ai/api/v1/conversations/{conversation_id}/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/conversations/{conversation_id}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'idempotency_key' => '<string>',
    'parts' => [
        [
                'file_id' => '<string>',
                'text' => '<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/conversations/{conversation_id}/messages"

	payload := strings.NewReader("{\n  \"idempotency_key\": \"<string>\",\n  \"parts\": [\n    {\n      \"file_id\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.axilio.ai/api/v1/conversations/{conversation_id}/messages")
  .header("X-Axilio-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotency_key\": \"<string>\",\n  \"parts\": [\n    {\n      \"file_id\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.axilio.ai/api/v1/conversations/{conversation_id}/messages")

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>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotency_key\": \"<string>\",\n  \"parts\": [\n    {\n      \"file_id\": \"<string>\",\n      \"text\": \"<string>\"\n    }\n  ]\n}"

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

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

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

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

Reply in a conversation

Authorizations

Path Parameters

Body

Response