Skip to main content
POST
/
api
/
messaging
/
channels
/
{channelId}
/
upload-media
Upload media to channel
curl --request POST \
  --url http://localhost:3000/api/messaging/channels/{channelId}/upload-media \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form agentId=3c90c3cc-0d44-4b50-8888-8dd25736052a
import requests

url = "http://localhost:3000/api/messaging/channels/{channelId}/upload-media"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }

response = requests.post(url, data=payload, files=files)

print(response.text)
const form = new FormData();
form.append('file', '<string>');
form.append('agentId', '3c90c3cc-0d44-4b50-8888-8dd25736052a');

const options = {method: 'POST'};

options.body = form;

fetch('http://localhost:3000/api/messaging/channels/{channelId}/upload-media', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/messaging/channels/{channelId}/upload-media",
  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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "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 := "http://localhost:3000/api/messaging/channels/{channelId}/upload-media"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("http://localhost:3000/api/messaging/channels/{channelId}/upload-media")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--")
  .asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/messaging/channels/{channelId}/upload-media")

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

request = Net::HTTP::Post.new(url)
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"agentId\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "url": "<string>",
  "channelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mimeType": "<string>",
  "size": 123
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}
{
  "success": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<string>"
  }
}

Path Parameters

​
channelId
string<uuid>
required

ID of the channel

Body

multipart/form-data
​
file
file

Media file to upload

​
agentId
string<uuid>

ID of the agent uploading the media

Response

Media uploaded successfully

​
id
string<uuid>
​
url
string

URL of the uploaded media

​
channelId
string<uuid>
​
agentId
string<uuid>
​
type
enum<string>
Available options:
image,
video
​
mimeType
string
​
size
integer