파일
파일 업로드
MMS 이미지 첨부 파일을 multipart/form-data로 업로드하고 file_key를 받습니다. 받은 file_key는 SMS/MMS 발송 페이로드에서 사용합니다. 동일한 byte를 다시 업로드하면 같은 file_key가 반환됩니다.
POST
/
files
파일 업로드
curl --request POST \
--url https://client-api.tryvox.co/v3/files \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form purpose=sms_attachmentimport requests
url = "https://client-api.tryvox.co/v3/files"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "purpose": "sms_attachment" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('purpose', 'sms_attachment');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://client-api.tryvox.co/v3/files', 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://client-api.tryvox.co/v3/files",
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=\"purpose\"\r\n\r\nsms_attachment\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://client-api.tryvox.co/v3/files"
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=\"purpose\"\r\n\r\nsms_attachment\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://client-api.tryvox.co/v3/files")
.header("Authorization", "Bearer <token>")
.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=\"purpose\"\r\n\r\nsms_attachment\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.tryvox.co/v3/files")
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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nsms_attachment\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"file_key": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"created_at": 123
}Authorizations
조직 API 키를 Authorization: Bearer <token> 형식으로 보냅니다.
Body
multipart/form-data
이 엔드포인트가 받는 multipart 폼 데이터입니다.
Response
성공 응답
POST /v3/files 응답.
서버가 생성한 불투명 file key입니다. SMS/MMS 발송 페이로드에서 업로드한 파일을 참조할 때 이 값을 사용합니다.
저장된 MIME 타입입니다. 지원 값은 image/jpeg, image/png, image/webp, image/gif이며, JPEG/PNG/WebP 업로드는 변환되어 image/jpeg로, GIF 업로드는 image/gif로 저장됩니다.
저장된 byte 크기입니다. JPEG/PNG/WebP 업로드는 변환 후 크기, GIF 업로드는 원본 byte 크기입니다.
리소스 생성 시각이며, 밀리초 단위 unix timestamp입니다.
Was this page helpful?
Previous
파일 다운로드조직이 소유한 `file_key`의 저장된 파일 바이트를 다운로드합니다. `sms_received` 웹훅 페이로드나 대화 메시지 `attachments`에 담긴 수신 MMS 첨부를 받을 때 사용합니다. 존재하지 않는 `file_key`와 다른 조직 소유의 `file_key`는 동일한 `404`를 반환합니다.
Next
⌘I
파일 업로드
curl --request POST \
--url https://client-api.tryvox.co/v3/files \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file='@example-file' \
--form purpose=sms_attachmentimport requests
url = "https://client-api.tryvox.co/v3/files"
files = { "file": ("example-file", open("example-file", "rb")) }
payload = { "purpose": "sms_attachment" }
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, data=payload, files=files, headers=headers)
print(response.text)const form = new FormData();
form.append('file', '<string>');
form.append('purpose', 'sms_attachment');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://client-api.tryvox.co/v3/files', 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://client-api.tryvox.co/v3/files",
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=\"purpose\"\r\n\r\nsms_attachment\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://client-api.tryvox.co/v3/files"
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=\"purpose\"\r\n\r\nsms_attachment\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://client-api.tryvox.co/v3/files")
.header("Authorization", "Bearer <token>")
.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=\"purpose\"\r\n\r\nsms_attachment\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://client-api.tryvox.co/v3/files")
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=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"purpose\"\r\n\r\nsms_attachment\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"file_key": "<string>",
"mime_type": "<string>",
"size_bytes": 123,
"created_at": 123
}