SMS

Envía SMS y MMS desde tus números. Las respuestas llegan a la bandeja (plataforma sms) y como eventos message.received.

Quién respondió STOP

GET/v1/phone-numbers/{id}/sms/opt-outs

Los SMS desde este número a ellos se rechazan.

Parámetros

idstringobligatorio

Respuesta 200

data []

phoneNumberstringobligatorio
atstring (date-time)

curl "https://api.marsial.dev/v1/phone-numbers/num_…/sms/opt-outs" \
  -H "Authorization: Bearer $MARSIAL_API_KEY"

const res = await fetch('https://api.marsial.dev/v1/phone-numbers/num_…/sms/opt-outs', {
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
  },
});
const { data } = await res.json();

import os, requests

res = requests.get(
    "https://api.marsial.dev/v1/phone-numbers/num_…/sms/opt-outs",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
)
data = res.json()["data"]

Enviar un SMS

POST/v1/sms/messages

Desde uno de tus números con SMS activados. Las respuestas llegan a la conversación de la bandeja que devuelve.

Cuerpo

numberIdstringobligatorio
El número que lo envía (num_…), con SMS activados.
tostringobligatorio
textstring
Hasta 10 segmentos de SMS.
máx. 1530
mediaUrlsstring (uri)[]
URL públicas de archivos: envía un MMS donde la operadora lo permite.
máx. 10 elementos
sendAtstring (date-time)
Programarlo para más tarde.
idempotencyKeystring
máx. 100

Respuesta 201

data

conversationIdstring | nullobligatorio
La conversación de la bandeja (cnv_…) donde llegan las respuestas.
statusstringobligatorio
Valores: sent · scheduled

curl -X POST "https://api.marsial.dev/v1/sms/messages" \
  -H "Authorization: Bearer $MARSIAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "numberId": "num_…",
    "to": "+447700900123",
    "text": "Your order 4821 is on its way"
  }'

const res = await fetch('https://api.marsial.dev/v1/sms/messages', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.MARSIAL_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "numberId": "num_…",
    "to": "+447700900123",
    "text": "Your order 4821 is on its way"
  }),
});
const { data } = await res.json();

import os, requests

res = requests.post(
    "https://api.marsial.dev/v1/sms/messages",
    headers={"Authorization": f"Bearer {os.environ['MARSIAL_API_KEY']}"},
    json={
        "numberId": "num_…",
        "to": "+447700900123",
        "text": "Your order 4821 is on its way"
    },
)
data = res.json()["data"]