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

Textmagic Chats API

Manage two-way conversations.

Textmagic Chats API is one of 11 APIs that Textmagic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://rest.textmagic.com/api/v2.

4 operations 4 paths 9 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://rest.textmagic.com/api/v2
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

Textmagic Chats API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-TM-Username (TmUsername). An API key is passed in the header as X-TM-Key (TmKey). By default, every request must be authenticated.

  • TmUsername — Your Textmagic account username.
  • TmKey — Your Textmagic API key, generated in the account settings.

Paths & Operations 4

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

Chats 4

Manage two-way conversations.

GET
/chats
Get all chats
getChats 2 params → 200
GET
/chats/{id}
Get a single chat
getChat 1 param → 200404
GET
/chats/{id}/messages
Get chat messages
getChatMessages 3 params → 200
POST
/chats/status
Change chat status
updateChatStatus body → 204

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Message (12 properties), Contact (9 properties), Chat (6 properties), ContactListEntity (5 properties). Each schema is shown below with its type and property counts.

ChatStatusRequest
object
2 properties 2 required
Contact
object
9 properties
ChatList
object
4 properties
Country
object
2 properties
MessageList
object
4 properties
Chat
object
6 properties
ContactListEntity
object
5 properties
Message
object
12 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

textmagic-chats-api-openapi.yml Raw ↑

Other APIs Textmagic publishes across the network.

Textmagic Bulk API
Textmagic Contacts API
Textmagic Lists API
Textmagic Messages API
Textmagic Numbers API
Textmagic Replies API
Textmagic Schedules API
Textmagic Sender IDs API
Textmagic Stats API
Textmagic Templates API