Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kaleyra Messages API

Send SMS, WhatsApp, and RCS messages and read their status.

Kaleyra Messages API is one of 6 APIs that Kaleyra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Messages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against 4 base URLs: https://api.kaleyra.io, https://api.in.kaleyra.io, https://api.ap.kaleyra.io, https://api.eu.kaleyra.io.

3 operations 2 paths 4 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.kaleyra.io
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Kaleyra Messages API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key generated in the kaleyra.io console (e.g. "Ac4XXXXX21f").

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Messages 3

Send SMS, WhatsApp, and RCS messages and read their status.

POST
/v2/{sid}/messages
Send an SMS, WhatsApp, or RCS message
sendMessage 1 param body → 200400401
GET
/v2/{sid}/messages
Get message logs / delivery status
listMessages 4 params → 200401
GET
/v2/{sid}/messages/{message_id}
Get the delivery status of a single message
getMessageStatus 2 params → 200401

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SendMessageRequest (7 properties), MessageResponse (4 properties), Error (2 properties), MessageLogResponse (1 property). Each schema is shown below with its type and property counts.

Error
object
2 properties
MessageLogResponse
object
1 property
MessageResponse
object
4 properties
SendMessageRequest
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kaleyra-messages-api-openapi.yml Raw ↑

Other APIs Kaleyra publishes across the network.

Kaleyra Email API
Kaleyra Platform API
Kaleyra Verify API
Kaleyra Video API
Kaleyra Voice API