Verifica Crediti

Panoramica

Monitora il saldo del tuo account SMS in tempo reale. Interroga l'API Verifica Crediti per recuperare il tuo credito account rimanente in euro prima di inviare messaggi o campagne in massa. Questo è essenziale per prevenire invii falliti dovuti a fondi insufficienti.

Casi d'uso:

• Controlla il saldo prima di avviare campagne SMS
• Implementa notifiche automatiche quando il credito scende sotto una soglia
• Valida lo stato dell'account nei dashboard dell'applicazione
• Previeni fallimenti di sottomissioni in batch dovuti a credito basso

Effettuare una Richiesta

Endpoint

GET https://secure.agiletelecom.com/services/sms/credit

Autenticazione

Scegli uno di tre metodi supportati:

• Basic Auth: Fornisci il tuo nome utente e password codificati nell'header Authorization
• API Key: Includi la tua API key nell'header X-Api-Key
• OAuth 1.1: Usa autenticazione OAuth 1.1 nell'header Authorization

Esempi di Codice

cURL

# Usando l'autenticazione API Key
curl -X GET "https://secure.agiletelecom.com/services/sms/credit" \
  -H "X-Api-Key: YOUR_API_KEY"

# Usando l'autenticazione Basic Auth
curl -X GET "https://secure.agiletelecom.com/services/sms/credit" \
  -H "Authorization: Basic $(echo -n 'username:password' | base64)"

Python

import requests

# Usando API Key
headers = {
    "X-Api-Key": "YOUR_API_KEY"
}

response = requests.get(
    "https://secure.agiletelecom.com/services/sms/credit",
    headers=headers
)

data = response.json()
print(f"Your current credit: €{data['credit']}")

Node.js

const axios = require('axios');

// Usando API Key
const headers = {
  'X-Api-Key': 'YOUR_API_KEY'
};

axios.get('https://secure.agiletelecom.com/services/sms/credit', { headers })
  .then(response => {
    console.log(`Your current credit: €${response.data.credit}`);
  })
  .catch(error => {
    console.error('Error:', error.response?.data || error.message);
  });

PHP

<?php
$apiKey = 'YOUR_API_KEY';

$ch = curl_init('https://secure.agiletelecom.com/services/sms/credit');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-Api-Key: ' . $apiKey
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
$data = json_decode($response, true);

if (json_last_error() === JSON_ERROR_NONE) {
    echo "Your current credit: €" . $data['credit'];
} else {
    echo "Error decoding response";
}

curl_close($ch);
?>

Risposta di Successo (2XX)

Quando la richiesta ha successo, l'API restituisce il tuo saldo account in euro:

{
  "credit": 10.324
}

Campo	Tipo	Descrizione
credit	double	Credito account rimanente (in euro)

Risposta di Errore (5XX)

Quando si verifica un errore lato server:

{
  "status": "error",
  "message": "Number check service unavailable",
  "code": 9
}

Campo	Tipo	Descrizione
status	stringa	Sempre "error" per risposte 5XX
message	stringa	Descrizione leggibile dell'errore lato server
code	intero	Codice di errore personalizzato che indica il tipo di problema

Codici di Errore

Codice	Descrizione
1	Credenziali errate
2	Crediti insufficienti
8	Errore del server
9	Timeout
100	L'IP di origine non è consentito

Pro Tip

Implementa il monitoraggio dei crediti nella tua applicazione per avvisare automaticamente gli utenti quando il saldo scende al di sotto di una soglia configurabile. Questo previene interruzioni di servizio inaspettate per invio SMS ad alto volume.

Qual è il Prossimo?

• Protocollo SMPP – Protocollo di connessione persistente per messaggistica ad alto volume
• SMS in Ingresso – Ricevi SMS sul tuo numero dedicato
• MNP Lookup – Interroga informazioni sulla rete mobile