Enviar un mensaje
curl --request POST \
--url https://email.{region}.basaltic.sh/v1/sent-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity": "<string>",
"from": "<string>",
"to": [
"<string>"
],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<string>"
}
'import requests
url = "https://email.{region}.basaltic.sh/v1/sent-messages"
payload = {
"identity": "<string>",
"from": "<string>",
"to": ["<string>"],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identity: '<string>',
from: '<string>',
to: ['<string>'],
content: {
text: '<string>',
html: '<string>',
raw: '<string>',
template: '<string>',
template_data: {}
},
attachments_bucket: '<string>',
attachments: [
{
bucket: '<string>',
key: '<string>',
name: '<string>',
version_id: '<string>',
content_type: '<string>'
}
],
subject: '<string>',
configuration_set: '<string>'
})
};
fetch('https://email.{region}.basaltic.sh/v1/sent-messages', 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://email.{region}.basaltic.sh/v1/sent-messages",
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([
'identity' => '<string>',
'from' => '<string>',
'to' => [
'<string>'
],
'content' => [
'text' => '<string>',
'html' => '<string>',
'raw' => '<string>',
'template' => '<string>',
'template_data' => [
]
],
'attachments_bucket' => '<string>',
'attachments' => [
[
'bucket' => '<string>',
'key' => '<string>',
'name' => '<string>',
'version_id' => '<string>',
'content_type' => '<string>'
]
],
'subject' => '<string>',
'configuration_set' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://email.{region}.basaltic.sh/v1/sent-messages"
payload := strings.NewReader("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://email.{region}.basaltic.sh/v1/sent-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://email.{region}.basaltic.sh/v1/sent-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"expires_at": "2023-11-07T05:31:56Z",
"attachments": [
{
"name": "<string>",
"content_type": "<string>",
"size": 123,
"bucket": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"key": "<string>",
"sha256": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "<string>",
"identity": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:email:sa-saopaulo-1:acme:identity/example.com",
"name": "example.com"
},
"from": "<string>",
"to": [
"<string>"
],
"status": "queued",
"queued_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"smtp_response": "<string>",
"error_message": "<string>",
"outbound_ip": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}Mensajes enviados
Enviar un mensaje
Acepta un mensaje con contenido explícito text/HTML, MIME sin procesar o plantilla. Una respuesta correcta significa que está en cola, no entregado. Se aplican las cuotas de la organización al tamaño MIME y a los destinatarios. Las plantillas también requieren email:SendTemplatedMessage sobre la plantilla. Use Idempotency-Key para reintentos seguros.
POST
/
v1
/
sent-messages
Enviar un mensaje
curl --request POST \
--url https://email.{region}.basaltic.sh/v1/sent-messages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity": "<string>",
"from": "<string>",
"to": [
"<string>"
],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<string>"
}
'import requests
url = "https://email.{region}.basaltic.sh/v1/sent-messages"
payload = {
"identity": "<string>",
"from": "<string>",
"to": ["<string>"],
"content": {
"text": "<string>",
"html": "<string>",
"raw": "<string>",
"template": "<string>",
"template_data": {}
},
"attachments_bucket": "<string>",
"attachments": [
{
"bucket": "<string>",
"key": "<string>",
"name": "<string>",
"version_id": "<string>",
"content_type": "<string>"
}
],
"subject": "<string>",
"configuration_set": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identity: '<string>',
from: '<string>',
to: ['<string>'],
content: {
text: '<string>',
html: '<string>',
raw: '<string>',
template: '<string>',
template_data: {}
},
attachments_bucket: '<string>',
attachments: [
{
bucket: '<string>',
key: '<string>',
name: '<string>',
version_id: '<string>',
content_type: '<string>'
}
],
subject: '<string>',
configuration_set: '<string>'
})
};
fetch('https://email.{region}.basaltic.sh/v1/sent-messages', 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://email.{region}.basaltic.sh/v1/sent-messages",
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([
'identity' => '<string>',
'from' => '<string>',
'to' => [
'<string>'
],
'content' => [
'text' => '<string>',
'html' => '<string>',
'raw' => '<string>',
'template' => '<string>',
'template_data' => [
]
],
'attachments_bucket' => '<string>',
'attachments' => [
[
'bucket' => '<string>',
'key' => '<string>',
'name' => '<string>',
'version_id' => '<string>',
'content_type' => '<string>'
]
],
'subject' => '<string>',
'configuration_set' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://email.{region}.basaltic.sh/v1/sent-messages"
payload := strings.NewReader("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://email.{region}.basaltic.sh/v1/sent-messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://email.{region}.basaltic.sh/v1/sent-messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"identity\": \"<string>\",\n \"from\": \"<string>\",\n \"to\": [\n \"<string>\"\n ],\n \"content\": {\n \"text\": \"<string>\",\n \"html\": \"<string>\",\n \"raw\": \"<string>\",\n \"template\": \"<string>\",\n \"template_data\": {}\n },\n \"attachments_bucket\": \"<string>\",\n \"attachments\": [\n {\n \"bucket\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"version_id\": \"<string>\",\n \"content_type\": \"<string>\"\n }\n ],\n \"subject\": \"<string>\",\n \"configuration_set\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": {
"expires_at": "2023-11-07T05:31:56Z",
"attachments": [
{
"name": "<string>",
"content_type": "<string>",
"size": 123,
"bucket": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"key": "<string>",
"sha256": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "<string>"
}
],
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "<string>",
"identity": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:email:sa-saopaulo-1:acme:identity/example.com",
"name": "example.com"
},
"from": "<string>",
"to": [
"<string>"
],
"status": "queued",
"queued_at": "2023-11-07T05:31:56Z",
"subject": "<string>",
"smtp_response": "<string>",
"error_message": "<string>",
"outbound_ip": "<string>",
"sent_at": "2023-11-07T05:31:56Z",
"failed_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}Requiere la acción IAM
email:SendMessage. Consulte permisos de Email for the full list, what each one covers, and an example policy.Autorizaciones
Un token bearer de OAuth 2.0, enviado como Authorization: Bearer <token>. Esta es la forma recomendada de autenticación.
Obtén el token intercambiando el par de claves de acceso de una cuenta de servicio en POST /v1/oauth/token con grant_type=client_credentials. Es el flujo estándar de credenciales de cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar el token por ti.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Los tokens duran una hora por defecto. El mismo par de claves de acceso también sirve como credencial AWS SigV4 para el endpoint de objetos compatible con S3, que solo acepta ese método de autenticación.
Encabezados
Clave opcional generada por el cliente que hace que una creación sea segura para la reproducción. Al volver a intentar una solicitud con la misma clave, se devuelve el resultado original literalmente en lugar de crear un recurso duplicado. Se rechaza la reutilización de una clave con un cuerpo de solicitud diferente (422); una solicitud cuya clave todavía se está procesando devuelve 409. Los registros se mantienen durante 24 horas. Usa un UUID o un token único similar.
Maximum string length:
255Cuerpo
application/json
UUID, CRN o nombre único en la cuenta.
Minimum array length:
1Exactamente un modo de contenido: text y/o html; raw; o template con template_data opcional. El texto nunca se interpreta como HTML por inferencia.
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
UUID, CRN o nombre del bucket para adjuntos incluidos en MIME sin procesar. Los objetos se guardan en email/{identity_id}/sent/{message_id}/. Las entradas de attachments referencian objetos existentes.
Objetos del bucket para adjuntar. Requiere GetObject; la versión y la suma de comprobación se fijan al aceptar.
Show child attributes
Show child attributes
Asunto para contenido text/HTML. Para raw o template, el asunto procede de ese contenido.
UUID, CRN o nombre único en la cuenta.
Respuesta
Mensaje en cola para entrega.
Show child attributes
Show child attributes