Numaraları yönetme

GET /numbers/list ve POST /numbers/release, projenizdeki her numara üzerinde, sağlayıcısı ne olursa olsun çalışır. provider parametresi yoktur: numaranın kendisi hangisi olduğunu söyler.

Listeleme

curl https://api.clearance.rest/numbers/list \
  -H "X-API-Key: $CLEARANCE_REST_API_KEY"

Yanıt, projenize eklenmiş her numarayı listeler; yalnızca kullanılabilir olanları değil. Projenizden ayrılan bir numara listede kalır ve status alanı nedenini söyler. Kullanabileceğiniz numaraları almak için status === "ACTIVE" ile filtreleyin.

Her numaranın şu alanları vardır:

Alan
sid	Numaranın id’si. release ile kullanılır.
providerSid	Sağlayıcının kendi id’si: Twilio’nun PN… SID’i ya da Hero SMS aktivasyon id’si. Mobil numaralarda yoktur.
provider	twilio, mobile ya da herosms.
phoneNumber	E.164 formatında.
status, statusReason	Aşağıya bakın.
assignedAt, endedAt	Projenize eklendiği ve ayrıldığı an, Unix epoch’tan bu yana milisaniye.
mobile	Yalnızca mobil numaralarda: carrierName, present, lastSeenAt, online ve daha fazlası.
herosms	Yalnızca Hero SMS numaralarında: serviceCode, operator, cost, expiresAt ve daha fazlası.

friendlyName, sağlayıcıdaki bir etiket değil, projenizin id’sidir.

Durum

status	Anlamı
ACTIVE	Kullanılabilir.
OFFLINE	Yalnızca mobil. Telefondan 30+ dakikadır ya da hiç sinyal yok. Teslimatı engellemez.
SIM_REMOVED	Yalnızca mobil. SIM telefonda değil.
MOVED	Numara başka bir projeye eklendi. Diğer proje asla adlandırılmaz.
RELEASED	Bir Twilio numarası silindi ya da bir Hero SMS aktivasyonu tamamlandı ya da iptal edildi.
EXPIRED	Yalnızca Hero SMS. Kiralama süresi doldu ve numara RELEASED olmak üzere.
UNASSIGNED	Projenizden ayrıldı ya da hiç eklenmedi.

statusReason, ACTIVE dışındaki her durum için insanın okuyabileceği bir açıklama verir.

Yalnızca ACTIVE numaralar (mobilde SIM takılıyken) GET /sms/wait’i çözer.

Bir numara aynı anda yalnızca tek bir projede ACTIVE olabilir.

Senkronizasyon

Düz bir GET /numbers/list yalnızca okur. Önce sağlayıcılarla uzlaşmak için sync=true ekleyin: Twilio SMS webhook’larını onarır, henüz hiçbir projeye eklenmemiş Twilio numaralarını alır ve sona ermiş Hero SMS aktivasyonlarını kapatır. Yanıt bu durumda bir sync özeti içerir. Senkronizasyon başarısız olursa liste yine döner ve sync.error dolu olur.

curl "https://api.clearance.rest/numbers/list?sync=true" \
  -H "X-API-Key: $CLEARANCE_REST_API_KEY"

sync=true, projenize sahipsiz bir Twilio numarası ekleyebilir ve sağlayıcı hesaplarınıza dokunur; bu yüzden bilerek kullanın.

Bırakma

curl -X POST https://api.clearance.rest/numbers/release \
  -H "X-API-Key: $CLEARANCE_REST_API_KEY" \
  -H "content-type: application/json" \
  -d '{ "sid": "c1aaeac1-ec52-44e2-b00a-d1350fb6bee6" }'

GET /numbers/list’ten gelen sid’i gönderin. Twilio’nun PN… providerSid’i de kabul edilir. Ne olacağı numaraya bağlıdır:

Sağlayıcı	Etkisi
Twilio	Numara Twilio hesabından silinir.
Hero SMS	SMS geldiyse aktivasyon tamamlanır, gelmediyse iptal edilir ve iade yapılır. İptal, kiralamadan sonra yaklaşık iki dakika reddedilir; sonra tekrar deneyin.
Mobil	Yalnızca projenizin ataması kaldırılır. SIM etkilenmez.

Projenizde olmayan bir numara 404 döndürür.