İçeriğe geç

Kullanım

Şirketinizin güncel e-posta ve API kotalarını, ön ödemeli SMS ile WhatsApp kredi bakiyelerini okuyun.

Herkese açık API durumu

Burada anlatılan v1 API uygulanmış ve test edilmiştir, ancak api.remindcash.com henüz herkese açık değildir. Son kabul testlerinden sonra açılacak; o zamana kadar istekler 503 döner. Örneklerde yer tutucular kullanılır — gerçek bir anahtarı asla paylaşılan koda yapıştırmayın.

GET /v1/usage, RemindCash’in şu anda kanıtlayabildiği kullanımı döndürür. usage:read kapsamı gerektirir.

BASH
curl https://api.remindcash.com/v1/usage \
  --header "Authorization: Bearer $REMINDCASH_API_KEY"
JSON
{
    "data": {
        "as_of_utc": "2026-10-11T12:58:05.561343Z",
        "email": {
            "status": "unavailable",
            "source": null,
            "period_starts_at": null,
            "period_ends_at": null,
            "limit": 0,
            "reserved": 0,
            "consumed": 0,
            "remaining": 0
        },
        "api_requests": {
            "status": "unavailable",
            "period_starts_at": null,
            "period_ends_at": null,
            "limit": 0,
            "used": 0,
            "remaining": 0
        },
        "prepaid_credits": []
    },
    "request_id": "07e3c763-6ae6-4544-a864-ea96fccf953f"
}

E-posta kotası

Alan Açıklama
status Bir e-posta kota dönemi geçerliyse active, değilse unavailable.
source Geçerli kotanın kaynağı veya null.
period_starts_at, period_ends_at UTC cinsinden geçerli kota dönemi veya null.
limit Dönemde izin verilen e-posta sayısı.
reserved Süren gönderimler için ayrılmış e-postalar.
consumed Kullanılmış e-postalar.
remaining limit − reserved − consumed, sıfırın altına düşmez.

status değeri unavailable olduğunda bir kota geçerli olana kadar e-posta hatırlatması gönderilemez.

API istekleri

api_requests, API plan limitleri etkinse ve bağlı e-posta hak dönemi geçerliyse güncel plan dönemini gösterir. Bu durumda status değeri active; diğer durumlarda sıfır değerlerle unavailable olur. limit dönem içinde sayılabilen en fazla API isteği, used kalıcı kullanım sayısı, remaining ise max(0, limit − used) değeridir. Zamanlar UTC'dir. GET /v1/usage plan kotasını tüketmez; dolmuş kotayı incelemek için kullanılabilir. Ayrı belirteç hız sınırı yine 429 döndürebilir.

Ön ödemeli krediler

prepaid_credits, kanal ve para birimi başına bir kayıt listeler; her kayıtta channel, currency, available_minor ve reserved_minor bulunur. Krediler mesaj gönderilmeden önce ayrılır, ardından kesinleşir veya serbest bırakılır; bakiyeler asla eksiye düşmez. Boş liste henüz kredi hesabı olmadığı anlamına gelir.

Abonelik durumu ve faturalandırma henüz burada raporlanmaz.