Kirimdev WhatsApp API

https://kirimdev.com/docs
Admin
Kirimdev is a multi-tenant WhatsApp Business Platform that allows developers to send messages,...
Tokens:3,086
Snippets:39
Trust Score:2.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### n8n Community Node Installation

Source: https://kirimdev.com

Install the `@kirimdev/n8n-nodes-kirim` package directly from n8n Community Nodes for drag-and-drop workflow automation. It includes action nodes for sending messages and managing contacts, and trigger nodes for incoming events.

```bash
npm install @kirimdev/n8n-nodes-kirim
```

--------------------------------

### customer.create()

Source: https://kirimdev.com

Enable multi-tenancy for agencies and platforms to manage multiple clients within a single account. Each client gets their own isolated WhatsApp Business Account, data, and a self-service onboarding link.

```APIDOC
## Multi-tenant Customer Management

### Description
Manage multiple clients or tenants within a single Kirimdev account.

### Features
- Isolated WhatsApp Business Accounts per customer.
- Data isolation across tenants.
- Self-service onboarding links for customers.
```

--------------------------------

### AI Agent Auto-Reply Configuration

Source: https://kirimdev.com

Integrate an AI agent to handle FAQs, qualify leads, or route customers. Handoff to a human agent is supported when necessary. The example shows assigning a chat to an agent.

```bash
curl -X POST https://api.kirim.dev/v1/inbox/assign \ 
-H "Authorization: Bearer YOUR_API_KEY" \ 
-H "Content-Type: application/json" \ 
-d '{ 
  "chat_id": "chat_xyz789", 
  "agent_id": "agent_b" 
}'
```

--------------------------------

### Multi-tenant Customer Management

Source: https://kirimdev.com

Manage multiple clients within a single account using the multi-tenant feature. Each customer gets an isolated WhatsApp Business Account, data isolation, and a self-service onboarding link.

```bash
curl -X POST https://api.kirim.dev/v1/customers \ 
-H "Authorization: Bearer YOUR_API_KEY" \ 
-H "Content-Type: application/json" \ 
-d '{ 
  "name": "Client Company", 
  "whatsapp_number": "6281000000001" 
}'
```

--------------------------------

### agent.respond()

Source: https://kirimdev.com

Build AI Agents for automated responses, such as answering FAQs, qualifying leads, or routing customers. Handoff to human agents is supported when necessary.

```APIDOC
## AI Agent Integration

### Description
Integrate AI agents for automated customer interactions.

### Usage
This functionality is typically integrated via webhooks or a dedicated SDK. When an incoming message is received, it can be processed by an AI agent before being sent to a human agent if required.
```

--------------------------------

### Receive Real-time Webhooks

Source: https://kirimdev.com

Configure an endpoint to receive incoming messages and delivery status updates via POST requests. Kirimdev automatically retries failed deliveries and provides HMAC signature verification for security.

```bash
curl -X POST https://your-webhook-endpoint.com/callback \ 
-H "Content-Type: application/json" \ 
-d '{ 
  "event": "message.sent", 
  "data": { 
    "message_id": "msg_abc123", 
    "to": "6281234567890", 
    "status": "delivered" 
  } 
}'
```

--------------------------------

### Send OTP WhatsApp for User Verification

Source: https://kirimdev.com

Utilize the template.otp feature to send 6-digit verification codes for sign-up, login, or transaction confirmation. This method offers higher delivery rates and lower costs compared to SMS.

```bash
curl -X POST https://api.kirim.dev/v1/templates/otp \ 
-H "Authorization: Bearer YOUR_API_KEY" \ 
-H "Content-Type: application/json" \ 
-d '{ 
  "to": "6281234567890", 
  "code": "123456" 
}'
```

--------------------------------

### Send Various Message Types via REST API

Source: https://kirimdev.com

Use the /v1 endpoint, compatible with Meta WhatsApp Cloud API, to send text, image, video, document, template, and interactive messages. Authentication is done via Bearer token.

```bash
curl -X POST https://api.kirim.dev/v1/messages \ 
-H "Authorization: Bearer YOUR_API_KEY" \ 
-H "Content-Type: application/json" \ 
-d '{ 
  "to": "6281234567890", 
  "type": "text", 
  "text": { 
    "body": "Hello, world!" 
  } 
}'
```

--------------------------------

### template.otp

Source: https://kirimdev.com

Send OTP (One-Time Password) via WhatsApp templates for user verification. This method offers higher delivery rates and lower costs compared to SMS for sign-up, login, and transaction confirmation.

```APIDOC
## POST /v1/messages (with template type)

### Description
Send OTP verification codes via WhatsApp templates.

### Method
POST

### Endpoint
/v1/messages

### Request Body
- **to** (string) - Required - The recipient's phone number.
- **type** (string) - Required - Must be 'template'.
- **template** (object) - Required - Template details for OTP.
  - **name** (string) - Required - The name of the OTP template (e.g., 'otp_verification').
  - **language** (object) - Required - The template language.
    - **code** (string) - Required - The language code (e.g., 'en', 'id').
  - **components** (array) - Required - Template components.
    - **type** (string) - Required - Must be 'body'.
    - **parameters** (array) - Required - Parameters for the OTP template.
      - **type** (string) - Required - Must be 'otp'.
      - **otp** (string) - Required - The 6-digit OTP code.

### Request Example
```json
{
  "to": "6281234567890",
  "type": "template",
  "template": {
    "name": "otp_verification",
    "language": {
      "code": "en"
    },
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "otp",
            "otp": "123456"
          }
        ]
      }
    ]
  }
}
```
```

--------------------------------

### messages.send()

Source: https://kirimdev.com

Send various types of WhatsApp messages including text, images, videos, documents, templates, and interactive messages via a single REST API endpoint. This endpoint is compatible with the Meta WhatsApp Cloud API format and uses Bearer authentication.

```APIDOC
## POST /v1/messages

### Description
Send various types of WhatsApp messages.

### Method
POST

### Endpoint
/v1/messages

### Request Body
- **to** (string) - Required - The recipient's phone number.
- **type** (string) - Required - The type of message (e.g., 'text', 'image', 'document', 'template').
- **text** (object) - Optional - For text messages.
  - **body** (string) - Required - The message text.
- **image** (object) - Optional - For image messages.
  - **link** (string) - Required - The URL of the image.
- **document** (object) - Optional - For document messages.
  - **link** (string) - Required - The URL of the document.
  - **caption** (string) - Optional - The document caption.
- **template** (object) - Optional - For template messages.
  - **name** (string) - Required - The name of the template.
  - **language** (object) - Required - The template language.
    - **code** (string) - Required - The language code (e.g., 'en', 'id').
  - **components** (array) - Optional - Template components.

### Request Example
```json
{
  "to": "6281234567890",
  "type": "text",
  "text": {
    "body": "Hello from Kirimdev!"
  }
}
```

### Response
#### Success Response (200)
- **message_id** (string) - The ID of the sent message.

#### Response Example
```json
{
  "message_id": "message_abc123"
}
```
```

--------------------------------

### webhook.received

Source: https://kirimdev.com

Receive real-time messages and status updates via webhooks. Incoming messages and delivery statuses are POSTed to your specified endpoint with HMAC signature verification. Automatic retries (8 attempts) and stored delivery logs for replay are included.

```APIDOC
## POST /callback

### Description
Receive incoming messages and status updates via webhook.

### Method
POST

### Endpoint
/callback

### Headers
- **X-Hub-Signature-256** (string) - Required - HMAC signature for verification.

### Request Body
(Structure depends on the event type, e.g., message received, status update)

### Request Example
```json
{
  "event": "message",
  "data": {
    "from": "6281234567890",
    "message_id": "message_abc123",
    "text": {
      "body": "Hello!"
    }
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates successful receipt of the webhook.

#### Response Example
```json
{
  "status": "received"
}
```
```

--------------------------------

### inbox.assign()

Source: https://kirimdev.com

Manage a shared inbox for customer service teams, allowing automatic distribution of incoming chats, organization with labels and pipelines, and maintaining a unified chat history without passing phones.

```APIDOC
## Shared Inbox Management

### Description
Utilize a shared inbox for multi-agent customer service.

### Features
- Automatic chat distribution.
- Labeling and pipeline organization.
- Unified chat history.
- Seamless handoff between agents.
```
Tokens:
Raw