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

Cellulant Engagement API

Outbound SMS notifications and OTPs.

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

This API exposes 2 JSON Schema definitions.

Tagged areas include Engagement. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 1 operation across 1 path, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against 2 base URLs: https://api.tingg.africa, https://api-approval.tingg.africa.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Servers
https://api.tingg.africa
https://api-approval.tingg.africa
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

Cellulant Engagement API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as apikey (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Merchant apiKey issued in the Tingg integration dashboard.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Engagement 1

Outbound SMS notifications and OTPs.

POST
/api/v2/engagement
Send Engagement Message
sendEngagement body → 2004XX

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are EngagementRequest (5 properties), SmsDto (4 properties), EngagementResponse (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

SmsDto
object
4 properties 2 required
Error
object
2 properties
EngagementRequest
object
5 properties 4 required
EngagementResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cellulant-engagement-api-openapi.yml Raw ↑

Other APIs Cellulant publishes across the network.

Cellulant Acknowledgement API
Cellulant Authentication API
Cellulant Custom Checkout API
Cellulant Express Checkout API
Cellulant Payments API