curl --request POST \
--url https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"max_messages": 10,
"visibility_timeout_seconds": 60,
"wait_time_seconds": 20
}
'import requests
url = "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive"
payload = {
"max_messages": 10,
"visibility_timeout_seconds": 60,
"wait_time_seconds": 20
}
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({max_messages: 10, visibility_timeout_seconds: 60, wait_time_seconds: 20})
};
fetch('https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive', 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://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive",
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([
'max_messages' => 10,
'visibility_timeout_seconds' => 60,
'wait_time_seconds' => 20
]),
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://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive"
payload := strings.NewReader("{\n \"max_messages\": 10,\n \"visibility_timeout_seconds\": 60,\n \"wait_time_seconds\": 20\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://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"max_messages\": 10,\n \"visibility_timeout_seconds\": 60,\n \"wait_time_seconds\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive")
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 \"max_messages\": 10,\n \"visibility_timeout_seconds\": 60,\n \"wait_time_seconds\": 20\n}"
response = http.request(request)
puts response.read_body{
"messages": [
{
"id": "019400aa-bbbb-7ccc-8ddd-eeeeffff0000",
"receipt_handle": "019400aabbbb7ccc8dddeeeeffff00003f2a91c4d5e60718293a4b5c6d7e8f9015a6b7c8d9e0f1a2b3c4d5e6f708192a3",
"body": "{\"order_id\":\"A-1001\"}",
"receive_count": 1,
"enqueued_at": "2026-01-18T11:45:00Z",
"visible_at": "2026-01-18T11:45:30Z",
"attributes": {
"severity": {
"type": "String",
"value": "critical"
},
"attempt": {
"type": "Number",
"value": "2"
}
},
"message_group_id": "customer-42"
}
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"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": "NOT_FOUND",
"message": "Resource not found",
"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
}
}
}Receber mensagens com concessão
Usa POST porque receber altera o estado: concede mensagens, incrementa a contagem e as oculta de outros consumidores. Um GET poderia ser repetido por proxies como uma leitura segura. Retorna uma lista vazia, sem erro, quando não há mensagens.
curl --request POST \
--url https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"max_messages": 10,
"visibility_timeout_seconds": 60,
"wait_time_seconds": 20
}
'import requests
url = "https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive"
payload = {
"max_messages": 10,
"visibility_timeout_seconds": 60,
"wait_time_seconds": 20
}
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({max_messages: 10, visibility_timeout_seconds: 60, wait_time_seconds: 20})
};
fetch('https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive', 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://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive",
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([
'max_messages' => 10,
'visibility_timeout_seconds' => 60,
'wait_time_seconds' => 20
]),
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://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive"
payload := strings.NewReader("{\n \"max_messages\": 10,\n \"visibility_timeout_seconds\": 60,\n \"wait_time_seconds\": 20\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://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"max_messages\": 10,\n \"visibility_timeout_seconds\": 60,\n \"wait_time_seconds\": 20\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://queue.{region}.basaltic.sh/v1/queues/{queue_id}/messages/receive")
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 \"max_messages\": 10,\n \"visibility_timeout_seconds\": 60,\n \"wait_time_seconds\": 20\n}"
response = http.request(request)
puts response.read_body{
"messages": [
{
"id": "019400aa-bbbb-7ccc-8ddd-eeeeffff0000",
"receipt_handle": "019400aabbbb7ccc8dddeeeeffff00003f2a91c4d5e60718293a4b5c6d7e8f9015a6b7c8d9e0f1a2b3c4d5e6f708192a3",
"body": "{\"order_id\":\"A-1001\"}",
"receive_count": 1,
"enqueued_at": "2026-01-18T11:45:00Z",
"visible_at": "2026-01-18T11:45:30Z",
"attributes": {
"severity": {
"type": "String",
"value": "critical"
},
"attempt": {
"type": "Number",
"value": "2"
}
},
"message_group_id": "customer-42"
}
]
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"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": "NOT_FOUND",
"message": "Resource not found",
"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
}
}
}queue:ReceiveMessage. Veja QUEUE permissões para a lista completa, o escopo de cada ação e um exemplo de política.Autorizações
Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.
Parâmetros de caminho
"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"
Corpo
Quantidade de mensagens a conceder. O resultado pode conter menos mensagens mesmo quando há mais disponíveis.
1 <= x <= 1010
Substitui o padrão da fila somente nesta concessão.
0 <= x <= 4320060
Tempo máximo de espera por uma mensagem. O padrão é receive_wait_time_seconds da fila.
0 <= x <= 2020
Resposta
Mensagens concedidas; pode estar vazio.
Show child attributes
Show child attributes

