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

Termii Campaigns API

Send, list, and manage SMS campaigns.

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

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

This API exposes 4 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.ng.termii.com/api.

4 operations 3 paths 7 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.ng.termii.com/api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Termii Campaigns API declares 1 security scheme for authenticating requests. An API key is passed in the query as api_key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Termii authenticates every request with an apikey. For GET requests it is passed as the apikey query parameter; for POST, PATCH, and DELETE requests it is incl…

Paths & Operations 4

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

Campaigns 4

Send, list, and manage SMS campaigns.

POST
/sms/campaigns/send
Send a campaign
sendCampaign body → 200400
GET
/sms/campaigns
Fetch campaigns
fetchCampaigns 1 param → 200401
GET
/sms/campaigns/{campaign_id}
Fetch campaign history
fetchCampaignHistory 2 params → 200401
PATCH
/sms/campaigns/{campaign_id}
Retry a campaign
retryCampaign 1 param body → 200400

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are SendCampaignRequest (11 properties), Campaign (9 properties), CampaignList (3 properties), CampaignHistory (3 properties). Each schema is shown below with its type and property counts.

ApiKeyBody
object
1 property 1 required
Campaign
object
9 properties
CampaignHistory
object
3 properties
CampaignList
object
3 properties
SendCampaignRequest
object
11 properties 9 required
ErrorResponse
object
1 property
GenericMessageResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

termii-campaigns-api-openapi.yml Raw ↑

Other APIs Termii publishes across the network.

Termii Contacts API
Termii Insights API
Termii Messaging API
Termii Sender IDs API
Termii Token API