curl -X GET "https://api.contactship.ai/v1/channels" \
-H "x-api-key: your-api-key"
curl -X GET "https://api.contactship.ai/v1/channels?type=WABA&status=active" \
-H "x-api-key: your-api-key"
const response = await fetch(
'https://api.contactship.ai/v1/channels?type=WABA',
{ headers: { 'x-api-key': 'your-api-key' } }
);
const { data, count } = await response.json();
console.log(`${count} channels found`);
data.forEach(ch => console.log(`${ch.name} (${ch.type}) — id: ${ch.id}`));
import requests
response = requests.get(
'https://api.contactship.ai/v1/channels',
headers={'x-api-key': 'your-api-key'},
params={'type': 'WABA', 'status': 'active'},
)
result = response.json()
for channel in result['data']:
print(f"{channel['name']} ({channel['type']}) — id: {channel['id']}")
{
"data": [
{
"id": "chn_w4b4e5x4mp1e0000000000",
"name": "WhatsApp Business",
"type": "WABA",
"status": "active",
"answer_method": "auto",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-01-15T10:00:00Z"
},
{
"id": "chn_a1b2c3d4e5f6g7h8i9j0k1l2",
"name": "Instagram DMs",
"type": "INSTAGRAM",
"status": "active",
"answer_method": "manual",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-02-01T09:00:00Z"
}
],
"count": 2
}
Canales y conversaciones
List Channels
Retrieve all messaging channels for your organization
GET
/
v1
/
channels
curl -X GET "https://api.contactship.ai/v1/channels" \
-H "x-api-key: your-api-key"
curl -X GET "https://api.contactship.ai/v1/channels?type=WABA&status=active" \
-H "x-api-key: your-api-key"
const response = await fetch(
'https://api.contactship.ai/v1/channels?type=WABA',
{ headers: { 'x-api-key': 'your-api-key' } }
);
const { data, count } = await response.json();
console.log(`${count} channels found`);
data.forEach(ch => console.log(`${ch.name} (${ch.type}) — id: ${ch.id}`));
import requests
response = requests.get(
'https://api.contactship.ai/v1/channels',
headers={'x-api-key': 'your-api-key'},
params={'type': 'WABA', 'status': 'active'},
)
result = response.json()
for channel in result['data']:
print(f"{channel['name']} ({channel['type']}) — id: {channel['id']}")
{
"data": [
{
"id": "chn_w4b4e5x4mp1e0000000000",
"name": "WhatsApp Business",
"type": "WABA",
"status": "active",
"answer_method": "auto",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-01-15T10:00:00Z"
},
{
"id": "chn_a1b2c3d4e5f6g7h8i9j0k1l2",
"name": "Instagram DMs",
"type": "INSTAGRAM",
"status": "active",
"answer_method": "manual",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-02-01T09:00:00Z"
}
],
"count": 2
}
Returns all messaging channels configured for your organization (WhatsApp WABA, Instagram, etc.). Use the
id from each channel as the channel_id parameter in messaging endpoints like Send WhatsApp Message.
Headers
Query Parameters
Response
Array of channel objects.
Mostrar Channel object
Mostrar Channel object
Error Codes
401 Unauthorized— Invalid or missing API key500 Internal Server Error— Server-side error
Code Examples
curl -X GET "https://api.contactship.ai/v1/channels" \
-H "x-api-key: your-api-key"
curl -X GET "https://api.contactship.ai/v1/channels?type=WABA&status=active" \
-H "x-api-key: your-api-key"
const response = await fetch(
'https://api.contactship.ai/v1/channels?type=WABA',
{ headers: { 'x-api-key': 'your-api-key' } }
);
const { data, count } = await response.json();
console.log(`${count} channels found`);
data.forEach(ch => console.log(`${ch.name} (${ch.type}) — id: ${ch.id}`));
import requests
response = requests.get(
'https://api.contactship.ai/v1/channels',
headers={'x-api-key': 'your-api-key'},
params={'type': 'WABA', 'status': 'active'},
)
result = response.json()
for channel in result['data']:
print(f"{channel['name']} ({channel['type']}) — id: {channel['id']}")
{
"data": [
{
"id": "chn_w4b4e5x4mp1e0000000000",
"name": "WhatsApp Business",
"type": "WABA",
"status": "active",
"answer_method": "auto",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-01-15T10:00:00Z"
},
{
"id": "chn_a1b2c3d4e5f6g7h8i9j0k1l2",
"name": "Instagram DMs",
"type": "INSTAGRAM",
"status": "active",
"answer_method": "manual",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-02-01T09:00:00Z"
}
],
"count": 2
}
