Get App

Retrieve a specific SFVoPI application by its ID.

Authentication Required

Requires X-API-Key header. See Authentication for details.

HTTP Request

GET /sfvopi/apps/:app_id

Path Parameters

Parameter	Type	Required	Description
app_id	string	Yes	Unique app identifier (format: sfv_app_xxxxxxxxxxxx)

Code Examples

cURL

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

JavaScript

const appId = 'sfv_app_abc123xyz456';

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

const result = await response.json();
console.log(result.data);

TypeScript

interface SfvopiApp {
  app_id: string;
  org_id: number;
  name: string;
  answer_url: string;
  answer_method: 'POST' | 'GET';
  hangup_url: string | null;
  hangup_method: 'POST' | 'GET';
  fallback_answer_url: string | null;
  fallback_answer_method: 'POST' | 'GET';
  status: 'ACTIVE' | 'INACTIVE';
  created_by: number | null;
  created_at: string;
  updated_at: string | null;
}

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

const appId = 'sfv_app_abc123xyz456';

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

const result: ApiResponse<SfvopiApp> = await response.json();
console.log(result.data);

Python

import requests

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

response = requests.get(url, headers=headers)
result = response.json()
print(result['data'])

Success Response

Status Code: 200 OK

{
  "data": {
    "app_id": "sfv_app_abc123xyz456",
    "org_id": 12345,
    "name": "My Voice App",
    "answer_url": "https://example.com/webhook/answer",
    "answer_method": "POST",
    "hangup_url": "https://example.com/webhook/hangup",
    "hangup_method": "POST",
    "fallback_answer_url": null,
    "fallback_answer_method": "POST",
    "status": "ACTIVE",
    "created_by": 67890,
    "created_at": "2026-02-02T10:30:00.000Z",
    "updated_at": "2026-02-02T14:15:00.000Z"
  },
  "message": "success"
}

Response Fields

Field	Type	Description
app_id	string	Unique identifier for the app (format: sfv_app_xxxxxxxxxxxx)
org_id	number	Organization ID that owns this app
name	string	App name
answer_url	string	Webhook URL for answered calls
answer_method	string	HTTP method for answer webhook (POST or GET)
hangup_url	string | null	Webhook URL for call hangup events
hangup_method	string	HTTP method for hangup webhook
fallback_answer_url	string | null	Fallback webhook URL
fallback_answer_method	string	HTTP method for fallback webhook
status	string	App status (ACTIVE or INACTIVE)
created_by	number | null	User ID who created the app
created_at	string	ISO 8601 timestamp of creation
updated_at	string | null	ISO 8601 timestamp of last update

Error Responses

Status Code	Message	When It Occurs
404	SFVoPI app not found	App with the specified app_id does not exist or does not belong to your organization
401	UnAuthorized, Please Provide Valid API Key	Missing or invalid X-API-Key header
500	Failed to get SFVoPI app: {error}	Server error while fetching the app

Example Error Response

{
  "message": "SFVoPI app not found"
}

Use Cases

Verify App Configuration

const appId = 'sfv_app_abc123xyz456';

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

const result = await response.json();
const app = result.data;

console.log(`App: ${app.name}`);
console.log(`Status: ${app.status}`);
console.log(`Answer URL: ${app.answer_url}`);

Check if App Exists

async function appExists(appId) {
  try {
    const response = await fetch(`https://prod-api.superfone.co.in/superfone/sfvopi/apps/${appId}`, {
      headers: { 'X-API-Key': 'your_api_key_here' }
    });
    
    if (response.status === 404) {
      return false;
    }
    
    return response.ok;
  } catch (error) {
    return false;
  }
}

const exists = await appExists('sfv_app_abc123xyz456');
console.log(`App exists: ${exists}`);

Related Endpoints

• Create App — Create a new app
• List Apps — Get all apps for your organization
• Update App — Modify app configuration
• Delete App — Remove an app