Conversations
Upload a conversation
Upload a conversation using multipart form data. Recommended for smaller files (up to 100MB).
POST
/
conversations
/
upload
Upload a conversation
curl --request POST \
--url https://api.rulebase.co/conversations/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'upload[source]=xcally' \
--form 'upload[metadata][unique_id]=<string>' \
--form 'upload[metadata][agent]=<string>' \
--form 'upload[metadata][caller]=<string>' \
--form 'upload[metadata][called]=<string>' \
--form 'upload[metadata][recorded_at]=<string>' \
--form upload[file]='@example-file'import requests
url = "https://api.rulebase.co/conversations/upload"
files = { "upload[file]": ("example-file", open("example-file", "rb")) }
payload = {
"upload[source]": "xcally",
"upload[metadata][unique_id]": "<string>",
"upload[metadata][agent]": "<string>",
"upload[metadata][caller]": "<string>",
"upload[metadata][called]": "<string>",
"upload[metadata][recorded_at]": "<string>"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('upload[source]', 'xcally');
form.append('upload[metadata][unique_id]', '<string>');
form.append('upload[metadata][agent]', '<string>');
form.append('upload[metadata][caller]', '<string>');
form.append('upload[metadata][called]', '<string>');
form.append('upload[metadata][recorded_at]', '<string>');
form.append('upload[file]', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.rulebase.co/conversations/upload', 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.rulebase.co/conversations/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.rulebase.co/conversations/upload"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.rulebase.co/conversations/upload")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rulebase.co/conversations/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
API key authentication using Bearer Token
Body
multipart/form-data
The source system or platform from which the call is being uploaded
Available options:
xcally Unique identifier for the call
The direction of the call (inbound or outbound)
Available options:
inbound, outbound The agent email address. Used to identify the employee on the call for both inbound and outbound uploads.
Inbound: customer phone number. Outbound: agent email (may duplicate upload[metadata][agent]).
Inbound: trunk or extension phone number. Outbound: customer phone number.
The date and time the call was recorded
The audio recording file (WAV, MP3, or M4A format, max 100MB)
Response
201 - application/json
Conversation uploaded successfully
Show child attributes
Show child attributes
⌘I
Upload a conversation
curl --request POST \
--url https://api.rulebase.co/conversations/upload \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'upload[source]=xcally' \
--form 'upload[metadata][unique_id]=<string>' \
--form 'upload[metadata][agent]=<string>' \
--form 'upload[metadata][caller]=<string>' \
--form 'upload[metadata][called]=<string>' \
--form 'upload[metadata][recorded_at]=<string>' \
--form upload[file]='@example-file'import requests
url = "https://api.rulebase.co/conversations/upload"
files = { "upload[file]": ("example-file", open("example-file", "rb")) }
payload = {
"upload[source]": "xcally",
"upload[metadata][unique_id]": "<string>",
"upload[metadata][agent]": "<string>",
"upload[metadata][caller]": "<string>",
"upload[metadata][called]": "<string>",
"upload[metadata][recorded_at]": "<string>"
}
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('upload[source]', 'xcally');
form.append('upload[metadata][unique_id]', '<string>');
form.append('upload[metadata][agent]', '<string>');
form.append('upload[metadata][caller]', '<string>');
form.append('upload[metadata][called]', '<string>');
form.append('upload[metadata][recorded_at]', '<string>');
form.append('upload[file]', '<string>');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.rulebase.co/conversations/upload', 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.rulebase.co/conversations/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.rulebase.co/conversations/upload"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.rulebase.co/conversations/upload")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rulebase.co/conversations/upload")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bsource%5D\"\r\n\r\nxcally\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bunique_id%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bagent%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcaller%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Bcalled%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload%5Bmetadata%5D%5Brecorded_at%5D\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"upload[file]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}