instantKOM API Examples

Ready-to-use code examples for the instantKOM REST API in multiple programming languages.

Languages

Language	Folder	Prerequisites
cURL	/curl	curl
JavaScript	/javascript	Node.js 14+
PHP	/php	PHP 7.4+
Python	/python	Python 3.7+

Authentication

All API requests require authentication via API Key:

Authorization: Bearer YOUR_API_KEY

The API key is found in your instantKOM dashboard under Settings > API Keys.

Examples

Send a Message

Send a 1:1 text message to a contact by their internal recipientId. Use GET /v1/contacts to look up the recipient ID.

• cURL
• JavaScript
• PHP
• Python

List Channels

List all configured messaging channels.

• cURL
• JavaScript
• PHP
• Python

Create Broadcast

Send a message to all contacts in a channel (or a segment). Broadcasts target stored contacts — not raw phone numbers. Use segmentId to restrict the audience.

• JavaScript
• PHP
• Python

Base URL

https://api.instantkom.app

API Documentation

Full API reference: api.instantkom.app/api-docs

Public Repository

These examples are also available at: github.com/instantKOM/api-examples

License

MIT License - see LICENSE