Get an SMS Channel

Agent Skill

Automate this endpoint with an AI agent using the 2chat-sms skill:

npx skills add 2ChatCo/agent-skills -s 2chat-sms

Get the details and status of a single SMS channel owned by your account. Returns 404 for a channel that doesn't exist or doesn't belong to you.

Endpoint

GET https://api.p.2chat.io/open/sms/channel/{channel_uuid}

Authentication

Include your API key in the X-User-API-Key header. Learn more about authentication.

Path parameters

Parameter	Description	Example
`channel_uuid`	The UUID of the SMS channel (prefixed `SMS`)	`SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13`

Invocation

cURL
Python
JavaScript
PHP

curl -L -G 'https://api.p.2chat.io/open/sms/channel/SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13' \
    --header 'X-User-API-Key: your_api_key_here'

import requests

url = "https://api.p.2chat.io/open/sms/channel/SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13"
headers = {
    "X-User-API-Key": "your_api_key_here"
}

response = requests.get(url, headers=headers)
print(response.json())

const axios = require('axios');

const response = await axios.get(
    'https://api.p.2chat.io/open/sms/channel/SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13',
    {
        headers: {
            'X-User-API-Key': 'your_api_key_here'
        }
    }
);

console.log(response.data);

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.p.2chat.io/open/sms/channel/SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'X-User-API-Key: your_api_key_here'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Response

Success (HTTP 200 OK)

{
    "success": true,
    "channel": {
        "uuid": "SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13",
        "account_uuid": "ACC7b2e9d41-3c8a-4f02-9b1d-6e5a4c3f2a10",
        "voip_number_setup_uuid": "DID3e1b7a90-2f64-4c8d-bb15-9a0e2d7f4c83",
        "phone_number": "+13057654321",
        "friendly_name": "Support line",
        "iso_country_code": "US",
        "supports_sms_in": true,
        "supports_sms_out": true,
        "enabled": true,
        "created_at": "2026-05-12T14:03:21Z",
        "updated_at": "2026-06-01T09:18:44Z"
    }
}

Field	Description	Example
`uuid`	Unique identifier of the SMS channel (prefixed `SMS`)	`SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13`
`account_uuid`	UUID of the account the channel belongs to	`ACC7b2e9d41-3c8a-4f02-9b1d-6e5a4c3f2a10`
`voip_number_setup_uuid`	UUID of the underlying virtual number setup (prefixed `DID`)	`DID3e1b7a90-2f64-4c8d-bb15-9a0e2d7f4c83`
`phone_number`	The channel's phone number in E.164 format	`+13057654321`
`friendly_name`	The friendly name you chose for the number	`Support line`
`iso_country_code`	Two-letter country code of the number	`US`
`supports_sms_in`	Whether the channel can receive inbound SMS	`true`
`supports_sms_out`	Whether the channel can send outbound SMS	`true`
`enabled`	Whether the channel is enabled on 2Chat	`true`
`created_at`	When the channel was created (UTC)	`2026-05-12T14:03:21Z`
`updated_at`	When the channel was last updated (UTC)	`2026-06-01T09:18:44Z`

Error

A channel that doesn't exist or doesn't belong to your account returns 404 Not Found.

{
    "error": true,
    "error_message": "SMS channel not found on your account: SMS9a3f1c20-4e7b-4d8a-9c61-2f5b8d0a4e13"
}

Field	Description
`error`	`true` when the request failed
`error_message`	A description of what went wrong

Get an SMS Channel

Endpoint​

Authentication​

Path parameters​

Invocation​

Response​

Success (HTTP 200 OK)​

Error​