canonical: https://jentic.com/apis/altiria.com/altiria # Altiria API Jentic publishes the only available OpenAPI specification for Altiria API, keeping it validated and agent-ready. Altiria is a Spanish business-messaging platform that provides programmatic access to SMS, email, voice, WhatsApp, and SMS-with-landing-page channels through 11 HTTP Basic-authenticated endpoints. Teams use it to send transactional notifications, OTPs, and marketing campaigns across channels, and to manage two-way WhatsApp conversations. The API targets Spanish-speaking markets with strong coverage across Iberia and Latin America. ## For AI agents Send SMS, email, voice, and WhatsApp messages and manage WhatsApp conversations through 11 HTTP Basic-authenticated endpoints. Useful for agents handling notifications, OTPs, and customer-care messaging in Spanish-speaking markets. ## Scope Does not handle inbound voice IVR call control, push notifications, or chat-widget hosting - use for sending SMS, email, voice, WhatsApp, and SMS-with-landing-page messages only. ## Capabilities - Send transactional and marketing SMS messages via POST /sms - Look up the delivery status of a sent SMS by id with GET /sms/{id} - Send transactional emails through POST /mailing - Send text-to-speech voice messages with POST /voice and pre-recorded audio with POST /voiceAudio - Send SMS messages that link to a hosted landing page via POST /landingsms - Send templated WhatsApp messages and manage two-way WhatsApp conversations - List, retrieve, and post messages within an active WhatsApp conversation thread ## Use cases ### Multi-Channel Transactional Notifications Operations teams route order confirmations, shipping updates, and OTPs across SMS, email, voice, and WhatsApp from a single Altiria account. Because the channels share an account and an HTTP Basic credential, the integration is one credential plus a small dispatcher that picks the channel based on the customer's preference. Delivery status for SMS is exposed via GET /sms/{id}. Example prompt: POST /sms with destination phone, message body, and sender id, then poll GET /sms/{id} until status is delivered or expired. ### Two-Way WhatsApp Customer Care Customer-care teams use the WhatsApp endpoints to receive inbound messages and reply within the WhatsApp 24-hour window from their existing helpdesk. Altiria exposes conversation listing, message retrieval, and reply-send endpoints, so a helpdesk integration can render full conversation threads alongside the customer's record. Example prompt: Call GET /whatsapp/conversations/{from}/{to}/messages to fetch the open conversation, then POST a reply to /whatsapp/conversations/{from}/{to}/messages. ### SMS-with-Landing-Page Marketing Marketing teams send SMS messages that include a short link to a hosted, personalised landing page via POST /landingsms. The landing page captures clicks and conversions tied back to the campaign, which lets Altiria report on engagement without the team standing up tracking infrastructure of their own. Example prompt: POST /landingsms with destination phone, body text, and the landing-page template id, then read the campaign report to count clicks. ### AI Agent Messaging Workflows via Jentic An AI customer-care agent built on Jentic can take 'send an order confirmation by WhatsApp, fall back to SMS' and resolve it to the WhatsApp template send and SMS send in sequence. The HTTP Basic credential stays in your Jentic One instance and is injected only at call time. Example prompt: Search Jentic for 'send a WhatsApp template message', load the POST /whatsapp schema, execute it; on failure, fall back to POST /sms with the same body. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /sms | Send an SMS message | | GET | /sms/{id} | Get SMS delivery status by id | | POST | /mailing | Send a transactional email | | POST | /voice | Send a text-to-speech voice message | | POST | /voiceAudio | Send a voice message from a pre-recorded audio file | | POST | /landingsms | Send an SMS that links to a personalised landing page | | POST | /whatsapp | Send a WhatsApp template message | | POST | /whatsapp/conversations/{from}/{to}/messages | Send a message within an active WhatsApp conversation | ## Key resources - **SMS** — Send SMS messages and look up delivery status - **Email** — Send transactional emails - **Voice** — Send TTS and audio-file voice messages - **Landing SMS** — Send SMS that links to a hosted personalised landing page - **WhatsApp** — Send templates and manage two-way WhatsApp conversations ## Why Jentic - **Setup:** Wiring the Altiria API by hand means encoding its HTTP basic credentials, targeting www.altiria.net/api/rest, and handling SMS, email, voice, and WhatsApp send calls with your own retries. Through Jentic you install once, import the Altiria API from the API Directory, store the basic credential once, and your agent calls it. - **Permission scoping:** The Altiria API carries most send targets in the request body, though the WhatsApp conversation path pins the from and to numbers (/whatsapp/conversations/{from}/{to}/messages), so for the send operations limit the agent to the ones it needs, such as sending SMS or email. You choose the operations it may call, so voice or WhatsApp sends are not included unless you add them. - **Credential handling:** Your Altiria basic credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'send an SMS' or 'send a WhatsApp message', and Jentic returns the matching Altiria operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Twilio API** — Global multi-channel messaging with broader country coverage and richer programmable voice - **MessageBird API** — European multi-channel messaging with strong WhatsApp and Voice presence - **SendGrid API** — Dedicated transactional email at higher volume than Altiria's email channel ## FAQ ### Why is there no official OpenAPI spec for Altiria API? Altiria does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Altiria API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Altiria API use? Altiria uses HTTP Basic authentication with an account login and password issued from the Altiria dashboard. Through Jentic, those credentials are stored encrypted in your Jentic One instance and the Authorization header is injected at call time, so they never enter agent prompts. ### Can I send a WhatsApp template through the Altiria API? Yes. POST to /whatsapp with the destination number, the approved template id, and any template parameters. To follow up inside the 24-hour conversation window, POST to /whatsapp/conversations/{from}/{to}/messages. ### What are the rate limits for the Altiria API? Specific per-account limits are not in the spec. Treat the API as account-throttled and add retry-with-backoff for 429 responses. For high-volume SMS campaigns, contact Altiria to confirm your tier's burst and steady-state ceilings. ### How do I send an SMS through Jentic? Run pip install jentic, then search with 'send an SMS via Altiria'. Load the POST /sms schema, fill in destination, message body, and sender id, and execute. Jentic handles the Basic auth header from the vaulted credential. ### Does the Altiria API support delivery receipts for SMS? Yes. After POST /sms returns an id, call GET /sms/{id} to read the current delivery status. For high-volume use, configure delivery webhooks in the Altiria dashboard to avoid polling. ### Can I limit what my agent is allowed to do with the Altiria API? Yes. Because Jentic One is self-hosted, your own rules decide which Altiria operations the agent may call, so you can allow only the sends it needs, such as POST /sms or POST /mailing, and leave out voice (POST /voice) and WhatsApp (POST /whatsapp) unless you add them. The WhatsApp conversation endpoint pins the from and to numbers in its path (/whatsapp/conversations/{from}/{to}/messages), so scoping to it also fixes which conversation the agent can touch. Your HTTP Basic credential stays stored in your own instance and is injected at call time, so the agent can only exercise the operations you have granted.