Upload asset

Upload asset

curl --request POST \
  --url https://macaly.com/api/client-app/assets/upload \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://macaly.com/api/client-app/assets/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://macaly.com/api/client-app/assets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://macaly.com/api/client-app/assets/upload"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://macaly.com/api/client-app/assets/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

POST

api

client-app

assets

upload

Upload asset

curl --request POST \
  --url https://macaly.com/api/client-app/assets/upload \
  --header 'Authorization: Bearer <token>'

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://macaly.com/api/client-app/assets/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://macaly.com/api/client-app/assets/upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://macaly.com/api/client-app/assets/upload"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://macaly.com/api/client-app/assets/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

Laddar upp en fil till en chatts filer (Assets) och returnerar en permanent CDN-URL. Använd den för bilder, dokument, ljud, video eller andra filer som din app eller ditt arbetsflöde ska referera till via URL.

Anrop

POST /api/client-app/assets/upload

Headers

Header	Obligatorisk	Beskrivning
`Authorization`	Ja	`Bearer macaly_...`
`Content-Type`	Ja	`multipart/form-data`

Formulärparametrar

Fält	Typ	Obligatoriskt	Standardvärde	Beskrivning
`chatId`	string	Ja	-	Chatten som filen laddas upp till
`file`	file	Ja	-	Filen som ska laddas upp. Maxstorlek 20 MB
`folderPath`	string	Nej	-	Mappsökväg med snedstreck som avgränsare, till exempel `images/products`
`createFolders`	string	Nej	`false`	`"true"`, `"1"` eller `"yes"` skapar mappar som saknas i `folderPath`
`folderId`	string	Nej	-	ID för en befintlig mapp. Skicka inte både `folderId` och `folderPath`
`title`	string	Nej	Ursprungligt filnamn	Visningsnamn för filen
`metadata`	string (JSON)	Nej	-	JSON-objekt som sparas tillsammans med filen

Ange antingen folderId eller folderPath, inte båda. Om du skickar båda returneras felet 400.

Exempelanrop

curl -X POST https://www.macaly.com/api/client-app/assets/upload \
  -H "Authorization: Bearer macaly_abc123..." \
  -F "chatId=abc123def456" \
  -F "file=@./logo.png;type=image/png"

const form = new FormData();
form.append('chatId', 'abc123def456');
form.append('file', fileBlob, 'logo.png');

const response = await fetch('https://www.macaly.com/api/client-app/assets/upload', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer macaly_abc123...',
  },
  body: form,
});

const data = await response.json();
console.log(data.asset.url);

import requests

response = requests.post(
    'https://www.macaly.com/api/client-app/assets/upload',
    headers={'Authorization': 'Bearer macaly_abc123...'},
    data={'chatId': 'abc123def456'},
    files={'file': ('logo.png', open('logo.png', 'rb'), 'image/png')},
)

data = response.json()
print(data['asset']['url'])

Ladda upp till en mapp

Använd folderPath för en läsbar mappstruktur och sätt createFolders=true för att skapa mappar som saknas längs sökvägen:

cURL

curl -X POST https://www.macaly.com/api/client-app/assets/upload \
  -H "Authorization: Bearer macaly_abc123..." \
  -F "chatId=abc123def456" \
  -F "folderPath=images/products" \
  -F "createFolders=true" \
  -F "title=Product hero image" \
  -F "file=@./hero.png;type=image/png"

Svar

{
  "success": true,
  "asset": {
    "assetId": "asset_123",
    "url": "https://cdn.macaly.app/user/chat/key/logo.png",
    "storageKey": "user/chat/key/logo.png",
    "contentType": "image/png",
    "fileSize": 12345,
    "type": "image",
    "folderId": "folder_123"
  }
}

Fält	Typ	Beskrivning
`asset.assetId`	string	Filens unika ID
`asset.url`	string	Permanent CDN-URL för den uppladdade filen
`asset.storageKey`	string	Intern lagringssökväg
`asset.contentType`	string	Den uppladdade filens MIME-typ
`asset.fileSize`	number	Filstorlek i byte
`asset.type`	string	Härledd filtyp, till exempel `image` eller `document`
`asset.folderId`	string \| null	Mappen som filen placerades i, om någon

Statuskoder

Status	Beskrivning
200	Lyckades, filen laddades upp
400	`chatId` eller `file` saknas, `metadata` är ogiltig JSON, eller både `folderId` och `folderPath` har skickats
401	Ogiltig eller saknad API-nyckel
403	API-nyckeln har inte åtkomst till den här chatten
404	Mappen hittades inte
413	Filen överskrider uppladdningsgränsen på 20 MB
500	Serverfel

Regler för mappar

Mappsökvägar delas upp vid /, mellanslag i början och slutet tas bort och tomma segment ignoreras.
Maxdjupet är 8 mappar.
Varje mappnamn får vara högst 255 tecken.
Mappnamn matchas utan hänsyn till versaler och gemener inom samma överordnade mapp.
Om folderPath inte finns och createFolders inte är true misslyckas uppladdningen med felet 404.

Bra att veta

Endpointen använder samma API-nyckel macaly_... som resten av API:t, även om URL:en börjar med /api/client-app/. Du behöver ingen separat token.
Chatten som anges i chatId måste tillhöra samma team som din API-nyckel.
Uppladdade filer får en permanent CDN-URL som du kan använda som bilaga i Create chat eller Publish message, eller var som helst utanför Macaly.

Kom igång

Endpoints

Anrop

Headers

Formulärparametrar

Exempelanrop

Ladda upp till en mapp

Svar

Statuskoder

Regler för mappar

Bra att veta

​Anrop

​Headers

​Formulärparametrar

​Exempelanrop

​Ladda upp till en mapp

​Svar

​Statuskoder

​Regler för mappar

​Bra att veta

Anrop

Headers

Formulärparametrar

Exempelanrop

Ladda upp till en mapp

Svar

Statuskoder

Regler för mappar

Bra att veta