Clickatell Platform API
68
AI ReadinessAI-Aware (B+)68/100
Agent-ready OpenAPI document · curated by JenticCommunicationsSms MessagingapiKey2 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Send SMS or WhatsApp messages and query delivery status through Clickatell's unified messaging platform.
Use for: I need to send an SMS notification to a customer, Send a WhatsApp message through the Clickatell platform, Check whether a previously sent message was delivered, Send an OTP code to a phone number
Not supported: Does not handle voice calls, email delivery, or contact list management - use for sending SMS and WhatsApp messages and checking their delivery status only.
Jentic publishes the only available OpenAPI specification for Clickatell Platform API, keeping it validated and agent-ready. Clickatell's Platform API (One API) sends SMS and WhatsApp messages and queries the delivery status of those messages from a single unified surface. Authentication uses an API key passed in the Authorization header. The minimal endpoint set keeps integration simple while still covering the two operations that drive most messaging workflows: send and check status.
Install Jentic One Beta
Connect the Clickatell Platform API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Clickatell Platform API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fclickatell.com%2Fclickatell" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fclickatell.com%2Fclickatell" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with Clickatell Platform API.
Send a single SMS or WhatsApp message to a recipient phone number
Send the same message to multiple recipients in a single request
Query the delivery status of a previously sent message by message ID
Choose between SMS and WhatsApp channels on the same API call
Trigger transactional notifications such as OTPs and order updates
Use Cases
Patterns agents use Clickatell Platform API for, with concrete tasks.
★ Transactional SMS Notifications
Send transactional SMS messages such as order confirmations, shipping updates, or appointment reminders through Clickatell's Platform API. The send endpoint accepts the recipient number, message body, and channel selection, then returns a message ID that can be used to verify delivery later. This pattern fits inside webhook handlers, scheduled jobs, or AI agent flows.
Call POST /v1/message with the recipient number and the order confirmation message body, then store the returned message ID against the order record.
WhatsApp Customer Messaging
Send WhatsApp messages through the same unified endpoint by selecting the WhatsApp channel on the request. This avoids running two separate integrations for SMS and WhatsApp and produces consistent message records and IDs across both channels. Useful for customer support handoffs, marketing reactivations, and channels-of-record where WhatsApp is preferred.
Call POST /v1/message with the WhatsApp channel selected and the customer's phone number to deliver the support message via WhatsApp instead of SMS.
Delivery Status Verification
Query the delivery status of a previously sent message using its message ID to confirm successful delivery, retry on failure, or attribute campaign performance. The status endpoint returns the current state of the message and is safe to poll on a backoff schedule. Useful for audit logs, compliance evidence, and retry-on-failure flows.
Call GET /v1/message/{messageId} with the stored message ID and trigger a retry workflow if the response indicates failure.
AI Agent Notification Workflow
Allow an AI agent to dispatch transactional notifications and verify their delivery without storing API keys in its own context. Through Jentic the agent searches for the send-message intent, executes the operation, and polls status - Clickatell's API key stays in your Jentic One instance throughout.
Search Jentic for 'send SMS or WhatsApp message', execute POST /v1/message with the recipient and body, then poll GET /v1/message/{messageId} until status is delivered.
Key Endpoints
2 endpoints — jentic publishes the only available openapi specification for clickatell platform api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/v1/message
Send an SMS or WhatsApp message
GET
/v1/message/{messageId}
Query the delivery status of a message
POST
/v1/message
Send an SMS or WhatsApp message
GET
/v1/message/{messageId}
Query the delivery status of a message
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
C
Clickatell Platform API
- AI-Aware (B+)68/100
100
Foundational Compliance63
Developer Experience & Jentic Compatibility52
AI-Readiness & Agent Experience94
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
100
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A+Signals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
52
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: C-Signals: 4
57%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring Clickatell by hand means setting the Authorization API key header on every request to platform.clickatell.com and handling delivery-status polling yourself. Through Jentic you install once, import the Clickatell Platform API from the API Directory, store the API key once, and your agent calls it.
Permission scoping
Clickatell takes the recipient and channel in the request body of POST /v1/message, so scope the agent to the operations it needs, such as sending a message and checking its delivery status. You choose which operations are in the allowed set, and anything outside that set is not callable.
Credential isolation
Your Clickatell API key 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.
Intent-based discovery
Agents search Jentic by intent such as 'send an SMS notification' or 'check message delivery status', and Jentic returns the matching Clickatell operation with its input schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using Clickatell Platform API through Jentic.
Why is there no official OpenAPI spec for Clickatell Platform API?
Clickatell does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Clickatell Platform 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 Clickatell Platform API use?
Clickatell uses API key authentication. The key is sent in the Authorization header as a bearer-style value. When called via Jentic the key is stored encrypted in your Jentic One instance and is never exposed to the agent's prompt context.
Can I send WhatsApp messages with the Clickatell Platform API?
Yes. POST /v1/message accepts a channel selection so the same endpoint can deliver an SMS or a WhatsApp message. This means a single integration covers both channels and produces consistent message IDs for status lookups.
How do I confirm a message was delivered?
Call GET /v1/message/{messageId} with the message ID returned by the send call. The response indicates the current delivery state, so you can poll until the message reaches a terminal state and trigger retry or notification logic accordingly.
What are the rate limits for the Clickatell Platform API?
The OpenAPI spec does not declare rate limits explicitly. Throughput is governed by your Clickatell account plan and the destination carriers. For high volumes, batch recipients within a single send request rather than firing many sequential calls.
How do I send a message through Jentic?
Search Jentic for 'send an SMS or WhatsApp message'. Jentic returns the POST /v1/message operation with its input schema. Run pip install jentic, then await client.search, await client.load, await client.execute to send the message and capture the returned message ID.
Can I limit what my agent is allowed to do with the Clickatell Platform API?
Yes. Because Jentic One is self-hosted, you decide which Clickatell operations your agent can call and which credentials it may use. You can allow only sending a message with POST /v1/message and checking delivery status with GET /v1/message/{messageId}, and any operation outside that allowed set is not callable. Your Clickatell API key stays in your own instance and is injected at execution time rather than exposed to the agent.
GET STARTED