The WhatsApp numbers this workspace can send from

curl --request GET \
  --url https://{subdomain}.mihu.ai/api/v1/whatsapp/senders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{subdomain}.mihu.ai/api/v1/whatsapp/senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.mihu.ai/api/v1/whatsapp/senders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{subdomain}.mihu.ai/api/v1/whatsapp/senders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/whatsapp/senders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "message": "WhatsApp senders retrieved successfully",
  "data": [
    {
      "phone_number": "13204296811",
      "display_name": "Serap",
      "agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_name": "<string>",
      "waba_id": "<string>",
      "status": "active",
      "sendable": true,
      "queues": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Support"
        }
      ]
    }
  ]
}

WhatsApp Senders

The WhatsApp numbers this workspace can send from

Every WhatsApp Business number configured on the workspace, with the agent that owns it, its WABA, and the queues it is routed to.

When to use it. Before starting a new outbound WhatsApp conversation, so the operator picks which number the customer sees. agent_uuid from the chosen entry is exactly what POST /whatsapp/template wants as agentId, and passing the same value to GET /whatsapp/templates?agent_uuid=… narrows the catalogue to the templates that number’s WABA has actually approved. Picking the number first and the template second is what stops a send failing at Meta.

Why the list exists. The same information can be assembled by paging GET /agents and filtering channels[], but that reads every agent record on the workspace to find a handful of numbers. This answers it directly.

sendable. True when the number can actually originate a message: it is active and reachable through an agent (agent_uuid present) with a Meta phone number id. A number that is configured for receiving but has no agent behind it comes back sendable: false with agent_uuid: null — show it disabled rather than hiding it, so the gap is visible to whoever administers the workspace.

queues. The queues this number is routed to, from the queue designer. Note that a queue’s channel also names an ai_agent — that is who answers on the number, which is not necessarily the agent that sends from it.

Who can call it, and how much of it they see. A workspace API token, or a per-user JWT holding loop.templates.send. A workspace token — and an admin or the workspace owner on a JWT — gets every number. Any other per-user JWT gets only the numbers routed to an ACTIVE queue that user is a member of, the same membership rule the inbox reads by; a number routed to no queue is workspace/admin-only.

GET

api

senders

The WhatsApp numbers this workspace can send from

curl --request GET \
  --url https://{subdomain}.mihu.ai/api/v1/whatsapp/senders \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{subdomain}.mihu.ai/api/v1/whatsapp/senders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.mihu.ai/api/v1/whatsapp/senders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{subdomain}.mihu.ai/api/v1/whatsapp/senders"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/whatsapp/senders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "message": "WhatsApp senders retrieved successfully",
  "data": [
    {
      "phone_number": "13204296811",
      "display_name": "Serap",
      "agent_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent_name": "<string>",
      "waba_id": "<string>",
      "status": "active",
      "sendable": true,
      "queues": [
        {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "Support"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Query Parameters

sendable_only

boolean

default:false

Return only numbers that can originate a message

queue_uuid

string<uuid>

Only numbers routed to this queue

Response

Senders retrieved

success

boolean

Example:

true

message

string

Example:

"WhatsApp senders retrieved successfully"

data

object[]

Show child attributes

API Documentation

API Reference

The WhatsApp numbers this workspace can send from

Authorizations

Query Parameters

Response