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 Contacts API

Manage phonebooks and the contacts within them.

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

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

This API exposes 8 operations across 4 paths, and defines 11 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.

8 operations 4 paths 11 schemas 2 DELETE2 GET1 PATCH3 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 Contacts 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 8

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

Contacts 8

Manage phonebooks and the contacts within them.

GET
/phonebooks
List phonebooks
listPhonebooks 1 param → 200401
POST
/phonebooks
Create a phonebook
createPhonebook body → 200400
PATCH
/phonebooks/{phonebook_id}
Update a phonebook
updatePhonebook 1 param body → 200400
DELETE
/phonebooks/{phonebook_id}
Delete a phonebook
deletePhonebook 2 params → 200400
GET
/phonebooks/{phonebook_id}/contacts
List contacts in a phonebook
listContacts 2 params → 200401
POST
/phonebooks/{phonebook_id}/contacts
Add a contact to a phonebook
addContact 1 param body → 200400
DELETE
/phonebooks/{phonebook_id}/contacts
Delete a contact
deleteContact 2 params body → 200400
POST
/phonebooks/contacts/upload
Add contacts via file upload
uploadContacts body → 200400

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Contact (7 properties), AddContactRequest (7 properties), Phonebook (5 properties), UploadContactsRequest (4 properties). Each schema is shown below with its type and property counts.

Contact
object
7 properties
UploadContactsRequest
object
4 properties 4 required
CreatePhonebookRequest
object
3 properties 2 required
DeleteContactRequest
object
1 property
Phonebook
object
5 properties
ContactList
object
2 properties
UpdatePhonebookRequest
object
3 properties 3 required
ErrorResponse
object
1 property
PhonebookList
object
2 properties
GenericMessageResponse
object
1 property
AddContactRequest
object
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

termii-contacts-api-openapi.yml Raw ↑

Other APIs Termii publishes across the network.

Termii Campaigns API
Termii Insights API
Termii Messaging API
Termii Sender IDs API
Termii Token API