Get many conversation items
curl --request POST \
--url https://api.withallo.com/v2/api/conversations/items/batch \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"cll-abc123",
"cll-def456",
"cll-ghi789"
]
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/items/batch"
payload = { "ids": ["cll-abc123", "cll-def456", "cll-ghi789"] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ids: ['cll-abc123', 'cll-def456', 'cll-ghi789']})
};
fetch('https://api.withallo.com/v2/api/conversations/items/batch', 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.withallo.com/v2/api/conversations/items/batch",
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([
'ids' => [
'cll-abc123',
'cll-def456',
'cll-ghi789'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.withallo.com/v2/api/conversations/items/batch"
payload := strings.NewReader("{\n \"ids\": [\n \"cll-abc123\",\n \"cll-def456\",\n \"cll-ghi789\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.withallo.com/v2/api/conversations/items/batch")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"cll-abc123\",\n \"cll-def456\",\n \"cll-ghi789\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/items/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"cll-abc123\",\n \"cll-def456\",\n \"cll-ghi789\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "cll-abc123",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"contacts": [
{
"id": "cnt-abc123",
"name": "Sarah Johnson",
"company": {
"id": "com-xyz789",
"name": "Acme Corp"
},
"deals": [
{
"id": "dea-def456",
"name": "Enterprise Plan"
}
]
}
],
"user": {
"id": "usr-abc123",
"name": "John",
"email": "[email protected]"
},
"date": "2023-11-07T05:31:56Z",
"duration": 123,
"recording_url": "<string>",
"summary": "<string>",
"tags": [
"<string>"
],
"transcript": [
{
"time": "2023-11-07T05:31:56Z",
"text": "<string>"
}
],
"content": "<string>"
}
]
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Conversations
Get many conversation items
Returns multiple conversation items by their IDs in a single request. Use this to fetch full details (summary, tags, recording, etc.) for items returned by the analytics drilldown or any other list.
POST
/
v2
/
api
/
conversations
/
items
/
batch
Get many conversation items
curl --request POST \
--url https://api.withallo.com/v2/api/conversations/items/batch \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"ids": [
"cll-abc123",
"cll-def456",
"cll-ghi789"
]
}
'import requests
url = "https://api.withallo.com/v2/api/conversations/items/batch"
payload = { "ids": ["cll-abc123", "cll-def456", "cll-ghi789"] }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({ids: ['cll-abc123', 'cll-def456', 'cll-ghi789']})
};
fetch('https://api.withallo.com/v2/api/conversations/items/batch', 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.withallo.com/v2/api/conversations/items/batch",
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([
'ids' => [
'cll-abc123',
'cll-def456',
'cll-ghi789'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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.withallo.com/v2/api/conversations/items/batch"
payload := strings.NewReader("{\n \"ids\": [\n \"cll-abc123\",\n \"cll-def456\",\n \"cll-ghi789\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.withallo.com/v2/api/conversations/items/batch")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ids\": [\n \"cll-abc123\",\n \"cll-def456\",\n \"cll-ghi789\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withallo.com/v2/api/conversations/items/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ids\": [\n \"cll-abc123\",\n \"cll-def456\",\n \"cll-ghi789\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "cll-abc123",
"allo_number": "+14155550100",
"contact_number": "+14155551234",
"contacts": [
{
"id": "cnt-abc123",
"name": "Sarah Johnson",
"company": {
"id": "com-xyz789",
"name": "Acme Corp"
},
"deals": [
{
"id": "dea-def456",
"name": "Enterprise Plan"
}
]
}
],
"user": {
"id": "usr-abc123",
"name": "John",
"email": "[email protected]"
},
"date": "2023-11-07T05:31:56Z",
"duration": 123,
"recording_url": "<string>",
"summary": "<string>",
"tags": [
"<string>"
],
"transcript": [
{
"time": "2023-11-07T05:31:56Z",
"text": "<string>"
}
],
"content": "<string>"
}
]
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}{
"error": {
"type": "<string>",
"code": "<string>",
"message": "<string>",
"retryable": true,
"request_id": "<string>",
"retry_after_seconds": 123
}
}Required scope:
CONVERSATIONS_READLimits
- Maximum 100 items per batch request
- Exceeding this returns a
400error with codeBATCH_TOO_LARGE
Item ID format
- Call IDs start with
cll-(e.g.,cll-abc123) - Message IDs start with
msg-(e.g.,msg-def456)
Field notes
| Field | Null when |
|---|---|
summary | SMS items, or calls where AI summary is not yet available |
duration | SMS items (only applies to calls) |
result | SMS items (only applies to calls) |
recording_url | Recording disabled, call not answered, or SMS items |
transcript | Not requested via extend=transcript, or SMS items |
content | Call items (only applies to SMS) |
status | Call items (only applies to SMS) |
Extend parameter
| Value | Effect |
|---|---|
transcript | Include full call transcripts for all call items in the batch |
400 error with code UNSUPPORTED_EXTEND_VALUE.Was this page helpful?
⌘I