Compte

Solde et estimations de coût

GET/v1/balance

Le solde actuel en USD.

curl https://bulksmsapi.cc/v1/balance \
  -H "Authorization: Bearer $BULKSMSAPI_KEY"
200 OKJSON
{
  "object": "balance",
  "balance": "184.32950",
  "currency": "USD"
}

Estimations

POST/v1/estimates

Prend le même corps que POST /v1/batches et retourne ce que cela coûterait. Rien n'est envoyé et rien n'est facturé.

curl https://bulksmsapi.cc/v1/estimates \
  -H "Authorization: Bearer $BULKSMSAPI_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Doors open at 18:00 tonight.", "to": ["+14155550123", "+447400123456", "+447400123456", "12"]}'
200 OKJSON
{
  "object": "estimate",
  "recipients": 2,
  "set_aside": [
    { "to": "+447400123456", "reason": "duplicate" },
    { "to": "12", "reason": "invalid_number" }
  ],
  "encoding": "GSM-7",
  "segments": 2,
  "max_segments": 1,
  "cost": "0.01294",
  "currency": "USD",
  "by_country": [
    { "country": "US", "recipients": 1, "segments": 1, "cost": "0.00507" },
    { "country": "GB", "recipients": 1, "segments": 1, "cost": "0.00787" }
  ]
}

Solde faible

Une requête qui coûte plus que le solde répond avec 402 top_up_required et les deux montants dans le message, et rien n'est envoyé. Vérifiez le solde avant un gros lot, ou estimez d'abord, et rechargez dans la console.

Solde et estimations de coût | Documentation BulkSMSAPI