Server-to-server WhatsApp integration. Authenticate with X-API-Key. These routes are the only public integration surface for API keys — they do not accept JWT.

Create a key in API Keys, then call /api/external. Successful sends return HTTP 202 with the queued message. Phone numbers must include the country code (digits only or leading +).

Authentication and limits

Pass the full key in the X-API-Key header. Missing, revoked, or wrong-scope keys return 401 or 403. Each call is counted against your plan’s API request quota and is visible in API key analytics.

sessions:read — GET /api/external/sessions
messages:send — POST send-text, send, send-image
messages:read — GET /api/external/messages/{id}
contacts:read — GET /api/external/contacts
numbers:check — POST /api/external/number-check and /bulk

POST /api/external/messages/send is an alias of send-text. The body field is phone (not to).

GET/api/external/sessions

List sessions

WhatsApp sessions the key may use for sending.

URL: https://api.actiwapi.com/api/external/sessions

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Code examples

curl -X GET "https://api.actiwapi.com/api/external/sessions" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/sessions", {
    method: "GET",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/sessions", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
});
const data = await res.json();
console.log(data);

import requests

response = requests.get(
    "https://api.actiwapi.com/api/external/sessions",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/sessions")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/sessions");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->get("https://api.actiwapi.com/api/external/sessions");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/sessions";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapGet("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.actiwapi.com/api/external/sessions");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.actiwapi.com/api/external/sessions", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/sessions"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": [{ "id": "uuid", "name": "Sales Line 1", "status": "connected", "phoneNumber": "919876543210" }]
}

Try in Swagger UI

POST/api/external/messages/send-text

Send text

Queue a WhatsApp text message. Requires messages:send.

URL: https://api.actiwapi.com/api/external/messages/send-text

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Request example

{
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/external/messages/send-text" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"
  -d '{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/messages/send-text", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
    body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/messages/send-text", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/external/messages/send-text",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
    json={
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/messages/send-text")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"
request.body = "{  \"sessionId\": \"uuid\",  \"phone\": \"919876543210\",  \"text\": \"Hello from ActiWAPI!\"}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/messages/send-text");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_POSTFIELDS => '{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/external/messages/send-text", json_decode('{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/messages/send-text";
var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/external/messages/send-text")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/external/messages/send-text", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/messages/send-text"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"sessionId\": \"uuid\",  \"phone\": \"919876543210\",  \"text\": \"Hello from ActiWAPI!\"}"))
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example202

{ "success": true, "data": { "id": "uuid", "status": "queued", "direction": "outbound" } }

Try in Swagger UI

POST/api/external/messages/send

Send text (alias)

Same as send-text. Kept for older clients.

URL: https://api.actiwapi.com/api/external/messages/send

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Request example

{
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/external/messages/send" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"
  -d '{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/messages/send", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
    body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/messages/send", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/external/messages/send",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
    json={
  "sessionId": "uuid",
  "phone": "919876543210",
  "text": "Hello from ActiWAPI!"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/messages/send")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"
request.body = "{  \"sessionId\": \"uuid\",  \"phone\": \"919876543210\",  \"text\": \"Hello from ActiWAPI!\"}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/messages/send");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_POSTFIELDS => '{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/external/messages/send", json_decode('{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/messages/send";
var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/external/messages/send")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{  "sessionId": "uuid",  "phone": "919876543210",  "text": "Hello from ActiWAPI!"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/external/messages/send", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/messages/send"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"sessionId\": \"uuid\",  \"phone\": \"919876543210\",  \"text\": \"Hello from ActiWAPI!\"}"))
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example202

{ "success": true, "data": { "id": "uuid", "status": "queued" } }

Try in Swagger UI

POST/api/external/messages/send-image

Send image

Send an image by public mediaUrl (JSON). Requires messages:send.

URL: https://api.actiwapi.com/api/external/messages/send-image

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Request example

{
  "sessionId": "uuid",
  "phone": "919876543210",
  "mediaUrl": "https://cdn.example.com/offer.jpg",
  "caption": "This week’s offer"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/external/messages/send-image" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"
  -d '{  "sessionId": "uuid",  "phone": "919876543210",  "mediaUrl": "https://cdn.example.com/offer.jpg",  "caption": "This week’s offer"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/messages/send-image", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
    body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "919876543210",
  "mediaUrl": "https://cdn.example.com/offer.jpg",
  "caption": "This week’s offer"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/messages/send-image", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "919876543210",
  "mediaUrl": "https://cdn.example.com/offer.jpg",
  "caption": "This week’s offer"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/external/messages/send-image",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
    json={
  "sessionId": "uuid",
  "phone": "919876543210",
  "mediaUrl": "https://cdn.example.com/offer.jpg",
  "caption": "This week’s offer"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/messages/send-image")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"
request.body = "{  \"sessionId\": \"uuid\",  \"phone\": \"919876543210\",  \"mediaUrl\": \"https://cdn.example.com/offer.jpg\",  \"caption\": \"This week’s offer\"}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/messages/send-image");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_POSTFIELDS => '{  "sessionId": "uuid",  "phone": "919876543210",  "mediaUrl": "https://cdn.example.com/offer.jpg",  "caption": "This week’s offer"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/external/messages/send-image", json_decode('{  "sessionId": "uuid",  "phone": "919876543210",  "mediaUrl": "https://cdn.example.com/offer.jpg",  "caption": "This week’s offer"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/messages/send-image";
var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "919876543210",  "mediaUrl": "https://cdn.example.com/offer.jpg",  "caption": "This week’s offer"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "919876543210",  "mediaUrl": "https://cdn.example.com/offer.jpg",  "caption": "This week’s offer"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/external/messages/send-image")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{  "sessionId": "uuid",  "phone": "919876543210",  "mediaUrl": "https://cdn.example.com/offer.jpg",  "caption": "This week’s offer"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/external/messages/send-image", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/messages/send-image"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"sessionId\": \"uuid\",  \"phone\": \"919876543210\",  \"mediaUrl\": \"https://cdn.example.com/offer.jpg\",  \"caption\": \"This week’s offer\"}"))
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example202

{ "success": true, "data": { "id": "uuid", "status": "queued" } }

Try in Swagger UI

GET/api/external/messages/{id}

Get message status

Delivery state for a message you queued. Requires messages:read.

URL: https://api.actiwapi.com/api/external/messages/{id}

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Path parameters

id — Message UUID

Code examples

curl -X GET "https://api.actiwapi.com/api/external/messages/{id}" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/messages/{id}", {
    method: "GET",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/messages/{id}", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
});
const data = await res.json();
console.log(data);

import requests

response = requests.get(
    "https://api.actiwapi.com/api/external/messages/{id}",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/messages/{id}")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/messages/{id}");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->get("https://api.actiwapi.com/api/external/messages/{id}");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/messages/{id}";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapGet("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.actiwapi.com/api/external/messages/{id}");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.actiwapi.com/api/external/messages/{id}", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/messages/{id}"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": { "id": "uuid", "status": "delivered", "direction": "outbound" }
}

Try in Swagger UI

GET/api/external/contacts

List contacts

Workspace contacts. Requires contacts:read.

URL: https://api.actiwapi.com/api/external/contacts

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Query parameters

page — Page number
limit — Items per page
search — Name, phone, or email

Code examples

curl -X GET "https://api.actiwapi.com/api/external/contacts" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/contacts", {
    method: "GET",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/contacts", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
});
const data = await res.json();
console.log(data);

import requests

response = requests.get(
    "https://api.actiwapi.com/api/external/contacts",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/contacts")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Get.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/contacts");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->get("https://api.actiwapi.com/api/external/contacts");

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/contacts";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapGet("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.actiwapi.com/api/external/contacts");
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, err := http.NewRequest("GET", "https://api.actiwapi.com/api/external/contacts", nil)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/contacts"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": [{ "id": "uuid", "phone": "919876543210", "name": "John Smith" }],
  "pagination": { "page": 1, "limit": 20, "total": 142 }
}

Try in Swagger UI

POST/api/external/number-check

Check one number

WhatsApp registration lookup. Requires numbers:check and a connected session.

URL: https://api.actiwapi.com/api/external/number-check

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Request example

{
  "sessionId": "uuid",
  "phone": "+919876543210"
}

Code examples

curl -X POST "https://api.actiwapi.com/api/external/number-check" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"
  -d '{  "sessionId": "uuid",  "phone": "+919876543210"}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/number-check", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
    body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "+919876543210"
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/number-check", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  body: JSON.stringify({
  "sessionId": "uuid",
  "phone": "+919876543210"
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/external/number-check",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
    json={
  "sessionId": "uuid",
  "phone": "+919876543210"
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/number-check")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"
request.body = "{  \"sessionId\": \"uuid\",  \"phone\": \"+919876543210\"}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/number-check");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_POSTFIELDS => '{  "sessionId": "uuid",  "phone": "+919876543210"}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/external/number-check", json_decode('{  "sessionId": "uuid",  "phone": "+919876543210"}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/number-check";
var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "+919876543210"}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "sessionId": "uuid",  "phone": "+919876543210"}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/external/number-check")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{  "sessionId": "uuid",  "phone": "+919876543210"}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/external/number-check", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/number-check"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"sessionId\": \"uuid\",  \"phone\": \"+919876543210\"}"))
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": {
    "sessionId": "uuid",
    "result": { "phone": "919876543210", "exists": true, "whatsappRegistered": true }
  }
}

Try in Swagger UI

POST/api/external/number-check/bulk

Bulk check numbers

Up to 500 numbers per request. Use phones[] or multiline text.

URL: https://api.actiwapi.com/api/external/number-check/bulk

Auth: API Key

Headers

Header	Value	Required
X-API-Key	{apiKey}	Yes
Content-Type	application/json	Yes*

Request example

{
  "sessionId": "uuid",
  "phones": ["+14155552671", "+919876543210"]
}

Code examples

curl -X POST "https://api.actiwapi.com/api/external/number-check/bulk" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: {apiKey}"
  -d '{  "sessionId": "uuid",  "phones": ["+14155552671", "+919876543210"]}'

async function callActiwapi() {
  const res = await fetch("https://api.actiwapi.com/api/external/number-check/bulk", {
    method: "POST",
    headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
    body: JSON.stringify({
  "sessionId": "uuid",
  "phones": ["+14155552671", "+919876543210"]
}),
  });

  if (!res.ok) {
    throw new Error(await res.text());
  }

  const data = await res.json();
  console.log(data);
}

callActiwapi();

import fetch from "node-fetch";

const res = await fetch("https://api.actiwapi.com/api/external/number-check/bulk", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "X-API-Key": "{apiKey}"
  },
  body: JSON.stringify({
  "sessionId": "uuid",
  "phones": ["+14155552671", "+919876543210"]
}),
});
const data = await res.json();
console.log(data);

import requests

response = requests.post(
    "https://api.actiwapi.com/api/external/number-check/bulk",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": "{apiKey}",
    },
    json={
  "sessionId": "uuid",
  "phones": ["+14155552671", "+919876543210"]
},
)
print(response.json())

require "net/http"
require "uri"

uri = URI("https://api.actiwapi.com/api/external/number-check/bulk")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["X-API-Key"] = "{apiKey}"
request.body = "{  \"sessionId\": \"uuid\",  \"phones\": [\"+14155552671\", \"+919876543210\"]}"

response = http.request(request)
puts response.body

$ch = curl_init("https://api.actiwapi.com/api/external/number-check/bulk");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: {apiKey}"
    ],
    CURLOPT_POSTFIELDS => '{  "sessionId": "uuid",  "phones": ["+14155552671", "+919876543210"]}',
    CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

<?php

use Illuminate\Support\Facades\Http;

$headers = [
    'Content-Type' => 'application/json',
    'X-API-Key' => '{apiKey}',
];

$response = Http::withHeaders($headers)->post("https://api.actiwapi.com/api/external/number-check/bulk", json_decode('{  "sessionId": "uuid",  "phones": ["+14155552671", "+919876543210"]}', true));

$response->throw();
$data = $response->json();
dump($data);

using System.Net.Http;
using System.Text;

using var client = new HttpClient();
client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");

var url = "https://api.actiwapi.com/api/external/number-check/bulk";
var content = new StringContent("""
{  "sessionId": "uuid",  "phones": ["+14155552671", "+919876543210"]}
""", Encoding.UTF8, "application/json");
var response = await client.PostAsync(url, content);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);

// .NET 8 — IHttpClientFactory style
using System.Net.Http.Json;
using System.Text;
using System.Text.Json;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddHttpClient("Actiwapi", client =>
{
    client.DefaultRequestHeaders.TryAddWithoutValidation("X-API-Key", "{apiKey}");
});

var app = builder.Build();

app.MapPost("/proxy", async (IHttpClientFactory factory) =>
{
    var client = factory.CreateClient("Actiwapi");
    var content = new StringContent("""
{  "sessionId": "uuid",  "phones": ["+14155552671", "+919876543210"]}
""", Encoding.UTF8, "application/json");
    var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.actiwapi.com/api/external/number-check/bulk")
    {
        Content = content,
    };
    var response = await client.SendAsync(request);
    response.EnsureSuccessStatusCode();
    return Results.Content(await response.Content.ReadAsStringAsync(), "application/json");
});

app.Run();

package main

import (
	"bytes"
	"fmt"
	"io"
	"net/http"
)

func main() {
	payload := []byte(`{  "sessionId": "uuid",  "phones": ["+14155552671", "+919876543210"]}`)
	req, err := http.NewRequest("POST", "https://api.actiwapi.com/api/external/number-check/bulk", bytes.NewBuffer(payload))
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("X-API-Key", "{apiKey}")
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	data, _ := io.ReadAll(res.Body)
	fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.actiwapi.com/api/external/number-check/bulk"))
    .method("POST", HttpRequest.BodyPublishers.ofString("{  \"sessionId\": \"uuid\",  \"phones\": [\"+14155552671\", \"+919876543210\"]}"))
      .header("Content-Type", "application/json")
      .header("X-API-Key", "{apiKey}")
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response example200

{
  "success": true,
  "data": {
    "summary": { "total": 2, "registered": 1, "notRegistered": 1, "invalid": 0 },
    "results": [],
    "invalid": []
  }
}

Try in Swagger UI

Error codes

Failed requests return a JSON envelope with success: false and a human-readable message.

{
  "success": false,
  "message": "Validation failed",
  "errors": {
    "phone": "Valid phone number is required"
  }
}

HTTP	Code	Description
400	VALIDATION_ERROR	Request body or query failed validation.
401	UNAUTHORIZED	Missing or invalid JWT / API key.
403	FORBIDDEN	Authenticated but lacking permission or entitlement.
403	SUBSCRIPTION_INACTIVE	Action not allowed on the current plan (including Free after trial). Upgrade or wait for entitlements.
403	LIMIT_EXCEEDED	Plan limit reached (sessions, messages, API requests, etc.).
404	NOT_FOUND	Resource does not exist or is not in your account.
409	CONFLICT	Duplicate resource or invalid state transition.
429	RATE_LIMITED	Too many requests; retry after backoff.
500	INTERNAL_ERROR	Unexpected server error.
502	WHATSAPP_UNAVAILABLE	WhatsApp session disconnected or provider error.