API Reference
Channels API
View your voice and messaging channels and their configuration.
Channels represent your communication endpoints—phone numbers for voice calls and WhatsApp Business accounts for messaging. The Channels API provides read access to view channel status and configuration.
Voice Channels
Phone numbers for AI-powered voice calls with ultra-human TTS.
WhatsApp Channels
WhatsApp Business accounts for messaging automation.
Available Endpoints
/api/v1/channels— List all channels/api/v1/channels/:id— Get channel detailsList Channels
/api/v1/channelsRetrieves a paginated list of all channels in your workspace.
Query Parameters
Parameters
| Name | Type | Description |
|---|---|---|
limit | integer | Number of channels to return (1-100, default: 20) |
offset | integer | Number of channels to skip (default: 0) |
type | string | Filter by type: voice, whatsapp, or sms |
status | string | Filter by status: active, inactive, pending, suspended |
Example Request
curl -X GET "https://dev.nutalk.ai/v1/channels?type=voice&status=active" \ -H "Authorization: Bearer YOUR_API_KEY"Response
{
"success": true,
"data": [
{
"id": "ch_abc123",
"name": "Main Support Line",
"type": "voice",
"status": "active",
"health": "healthy",
"phone_number": "+18005550100",
"inbound_enabled": true,
"voicemail_enabled": true,
"messages_monthly": 0,
"active_conversations": 2,
"connected_at": "2024-01-10T08:00:00Z",
"created_at": "2024-01-10T08:00:00Z",
"updated_at": "2024-01-25T12:00:00Z"
},
{
"id": "ch_def456",
"name": "WhatsApp Business",
"type": "whatsapp",
"status": "active",
"health": "healthy",
"phone_number": "+14155551234",
"inbound_enabled": true,
"voicemail_enabled": false,
"messages_monthly": 1250,
"active_conversations": 15,
"connected_at": "2024-01-15T10:00:00Z",
"created_at": "2024-01-15T10:00:00Z",
"updated_at": "2024-01-25T14:00:00Z"
}
],
"pagination": {
"total": 3,
"limit": 20,
"offset": 0,
"has_more": false
}
}Get Channel
/api/v1/channels/:idRetrieves detailed information about a specific channel, including its configuration and connected agents.
Path Parameters
Parameters
| Name | Type | Description |
|---|---|---|
idRequired | uuid | The channel's unique identifier |
Example Request
curl -X GET "https://dev.nutalk.ai/v1/channels/ch_abc123" \ -H "Authorization: Bearer YOUR_API_KEY"Response
{
"success": true,
"data": {
"id": "ch_abc123",
"name": "Main Support Line",
"type": "voice",
"status": "active",
"health": "healthy",
"phone_number": "+18005550100",
"inbound_enabled": true,
"voicemail_enabled": true,
"voicemail_message": "Thanks for calling. Please leave a message.",
"block_anonymous_callers": false,
"auto_evaluate_enabled": true,
"evaluation_sample_rate": 0.5,
"retry_enabled": true,
"retry_config": {
"max_attempts": 3,
"delay_minutes": 60
},
"callbacks_enabled": true,
"messages_monthly": 0,
"active_conversations": 2,
"connected_at": "2024-01-10T08:00:00Z",
"created_at": "2024-01-10T08:00:00Z",
"updated_at": "2024-01-25T12:00:00Z",
"agents": [
{
"id": "agent_xyz789",
"name": "Support Agent"
}
]
}
}Channel Types
| Type | Description | Features |
|---|---|---|
| voice | Phone number for voice calls | Inbound/outbound calls, voicemail, recording |
| WhatsApp Business account | Templates, media, conversation threads | |
| sms | SMS messaging number | Text messaging (coming soon) |
Channel Statuses
| Status | Description |
|---|---|
| active | Channel is connected and handling communications |
| inactive | Channel is disabled and not accepting communications |
| pending | Channel is being provisioned or verified |
| suspended | Channel has been suspended due to policy violation |
Health Indicators
The health field indicates the operational status of the channel:
| Health | Description |
|---|---|
| healthy | Channel is operating normally |
| degraded | Channel is experiencing some issues |
| unhealthy | Channel is not functioning properly |
Channel Configuration
Channel configuration is managed through the dashboard. The API provides read-only access to view channel settings and status.