List App Numbers

Retrieve all phone numbers currently linked to a specific SFVoPI application.

Authentication

Requires X-API-Key header with a valid API key. See Authentication for details.

Endpoint

GET /sfvopi/apps/:app_id/numbers

Path Parameters

Parameter	Type	Required	Description
app_id	string	Yes	The unique identifier of the SFVoPI app

No request body required.

Code Examples

cURL

curl -X GET https://prod-api.superfone.co.in/superfone/sfvopi/apps/app_abc123/numbers \
  -H "X-API-Key: your_api_key_here"

JavaScript

const appId = 'app_abc123';
const response = await fetch(`https://prod-api.superfone.co.in/superfone/sfvopi/apps/${appId}/numbers`, {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
});

const data = await response.json();
console.log(data.data); // Array of linked numbers

TypeScript

interface SfvopiAppNumber {
  app_id: string;
  voip_number: string;
  org_id: number;
  status: string;
  created_at: string;
  updated_at: string | null;
}

interface ApiResponse<T> {
  data: T;
  message: string;
}

const appId = 'app_abc123';
const response = await fetch(`https://prod-api.superfone.co.in/superfone/sfvopi/apps/${appId}/numbers`, {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here'
  }
});

const result: ApiResponse<SfvopiAppNumber[]> = await response.json();
console.log(result.data); // Array of linked numbers

Python

import requests

app_id = 'app_abc123'
url = f'https://prod-api.superfone.co.in/superfone/sfvopi/apps/{app_id}/numbers'
headers = {
    'X-API-Key': 'your_api_key_here'
}

response = requests.get(url, headers=headers)
data = response.json()
print(data['data'])  # List of linked number objects

Success Response

Status Code: 200 OK

{
  "data": [
    {
      "app_id": "app_abc123",
      "voip_number": "+918000000001",
      "org_id": 456,
      "status": "ACTIVE",
      "created_at": "2026-02-02T10:30:00.000Z",
      "updated_at": null
    },
    {
      "app_id": "app_abc123",
      "voip_number": "+918000000002",
      "org_id": 456,
      "status": "ACTIVE",
      "created_at": "2026-02-01T14:20:00.000Z",
      "updated_at": null
    }
  ],
  "message": "success"
}

Response Fields

Field	Type	Description
data	array	Array of linked number objects
data[].app_id	string	The SFVoPI app ID this number is linked to
data[].voip_number	string	The phone number in E.164 format (e.g., +918000000001)
data[].org_id	number	Your organization ID
data[].status	string	Link status (typically ACTIVE)
data[].created_at	string	ISO 8601 timestamp when the link was created
data[].updated_at	string | null	ISO 8601 timestamp of last update, or null if never updated
message	string	Response message (always "success" on success)

Error Responses

Status Code	Message	When It Occurs
404	App not found	The specified app_id doesn't exist or doesn't belong to your organization
401	UnAuthorized, Please Provide Valid API Key	Missing or invalid X-API-Key header
500	Failed to get numbers: <error>	Server error while fetching numbers

Notes

• Empty array: If no numbers are linked to the app, data will be an empty array []
• Active links only: Only numbers with status: "ACTIVE" are returned
• E.164 format: All phone numbers are returned in E.164 format with country code
• Use this endpoint to verify which numbers are currently routing calls to your app

Next Steps

• Link Number — Add a phone number to this app
• Unlink Number — Remove a number from this app
• Get Available Numbers — Find numbers available to link
• Get App — View app details and webhook configuration