Consultar status de um SMS
curl --request GET \
--url https://api.notifique.dev/v1/sms/messages/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/sms/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/sms/messages/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/sms/messages/{id}"
req, _ := http.NewRequest("GET", 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))
}{
"success": true,
"data": {
"smsId": "clxx123...",
"to": "5511999999999",
"message": "Olá! SMS de teste.",
"status": "DELIVERED",
"sentAt": "2025-02-16T12:00:00.000Z",
"deliveredAt": "2025-02-16T12:00:05.000Z",
"failedAt": null,
"scheduledFor": null,
"errorMessage": null,
"createdAt": "2025-02-16T11:59:58.000Z"
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Not Found",
"message": "SMS not found or access denied",
"code": "NOT_FOUND"
}SMS
Consultar status de um SMS
Consulta se um SMS foi enviado, entregue ou falhou, e mostra os detalhes dele.
GET
/
v1
/
sms
/
messages
/
{id}
Consultar status de um SMS
curl --request GET \
--url https://api.notifique.dev/v1/sms/messages/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/sms/messages/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/sms/messages/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/sms/messages/{id}"
req, _ := http.NewRequest("GET", 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))
}{
"success": true,
"data": {
"smsId": "clxx123...",
"to": "5511999999999",
"message": "Olá! SMS de teste.",
"status": "DELIVERED",
"sentAt": "2025-02-16T12:00:00.000Z",
"deliveredAt": "2025-02-16T12:00:05.000Z",
"failedAt": null,
"scheduledFor": null,
"errorMessage": null,
"createdAt": "2025-02-16T11:59:58.000Z"
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Not Found",
"message": "SMS not found or access denied",
"code": "NOT_FOUND"
}Autorizações
ntfSmsBearerAuthntfSmsApiKeyHeader
API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx
Parâmetros de caminho
ID (cuid) do SMS retornado em POST /v1/sms/messages.
Resposta
Dados do SMS.
Exemplo:
true
Resposta de um SMS na listagem ou em GET por ID: a API sempre devolve todos estes campos; datas ausentes vêm como null. Não inclui provider, externalId nem rawResponse.
Show child attributes
Show child attributes
Exemplo:
{
"smsId": "clxx...",
"to": "5511999999999",
"message": "string",
"status": "SCHEDULED",
"sentAt": "2025-02-10T14:00:00.000Z",
"deliveredAt": "2025-02-10T14:00:00.000Z",
"failedAt": "2025-02-10T14:00:00.000Z",
"scheduledFor": "2025-02-10T14:00:00.000Z",
"errorMessage": "string",
"createdAt": "2025-02-10T14:00:00.000Z"
}
Esta página foi útil?

