Posta Guvercini klientinin API Reference-i¶
Note
İstifadəsi göstərilən bütün sorğular sinxrondur. Asinxron versiyasaları istifadə etmək üçün
bu importu edin və eyni-adlı funksiyaları await ilə çağırın:
from integrify.postaguvercini import PostaGuverciniAsyncClient
module-attribute
¶
PostaGuverciniClient = PostaGuverciniClientClass(sync=True)
module-attribute
¶
PostaGuverciniAsyncClient = PostaGuverciniClientClass(sync=False)
Note
Bunlar artıq hazır yaradılmış klass obyektləridir, birbaşa istifadə üçün nəzərdə tutulub. Əks halda
bütün sorğuları PostaGuverciniClientClass().send_single_sms() kimi istifadə etməlisiniz.
PostaGuverciniClientClass(name='PostaGuvercini', base_url=BASE_URL, default_handler=None, sync=True, dry=False)
Bases: APIClient
Posta Guvercini sorğular üçün baza class
send_single_sms(message, receivers, send_date=_UNSET, expire_date=_UNSET, channel=OTP, originator=_UNSET, username=POSTA_GUVERCINI_USERNAME, password=POSTA_GUVERCINI_PASSWORD)
Tək SMS göndərilməsi
Endpoint: /api_json/v1/Sms/Send_1_N
Example
from integrify.postaguvercini import PostaGuverciniClient
PostaGuverciniClient.send_single_sms(
message="Test SMS",
receivers=["905320000000"],
)
Cavab formatı: SendSMSResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq SMS göndərilməsi haqqında məlumat gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
message
|
SMS mətnini göstərir. Boş ola bilməz.
TYPE:
|
receivers
|
SMS qəbul edənləri göstərir. Boş ola bilməz.
TYPE:
|
send_date
|
SMS göndərilmə vaxtını göstərir. Boş olduqda dərhal sms göndəriləcək. Format:
TYPE:
|
expire_date
|
Sonuncu dəfə SMS göndərilməyə cəhd ediləcəyini göstərir. Boş olduqda, sistem tərəfindən müəyyən edilmiş vaxt etibarlı olacaq. Format:
TYPE:
|
channel
|
SMS-in göndərən ilə hansı platformada (OTP və ya BULK) göndəriləcəyini göstərir. Misal: OTP.
TYPE:
|
originator
|
Bu, tək hesabla müxtəlif göndəricilər altında sms göndərmək istənildikdə istifadə ediləcək bir sahədir. Göndəriləcək məlumat müştəri xidmətləri nümayəndəsi tərəfindən veriləcək və 11 simvol dəyərindədir.
TYPE:
|
username
|
Posta Guvercini hesabı adı. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
Posta Guvercini hesabı şifrəsi. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
send_multiple_sms(messages, send_date=_UNSET, expire_date=_UNSET, channel=OTP, originator=_UNSET, username=POSTA_GUVERCINI_USERNAME, password=POSTA_GUVERCINI_PASSWORD)
Çoxlu SMS göndərilməsi
Endpoint: /api_json/v1/Sms/Send_N_N
Example:
from integrify.postaguvercini import PostaGuverciniClient
PostaGuverciniClient.send_multiple_sms(
messages=[
{"receiver": "905320000000", "message": "Test SMS 1"},
{"receiver": "905320000001", "message": "Test SMS 2"},
],
)
Cavab formatı: SendSMSResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq SMS göndərilməsi haqqında məlumat gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
messages
|
SMS mətnini və qəbul edəni göstərir. Boş ola bilməz.
TYPE:
|
send_date
|
SMS göndərilmə vaxtını göstərir. Boş olduqda dərhal sms göndəriləcək. Format:
TYPE:
|
expire_date
|
Sonuncu dəfə SMS göndərilməyə cəhd ediləcəyini göstərir. Boş olduqda, sistem tərəfindən müəyyən edilmiş vaxt etibarlı olacaq. Format:
TYPE:
|
channel
|
SMS-in göndərən ilə hansı platformada (OTP və ya BULK) göndəriləcəyini göstərir. Misal: OTP.
TYPE:
|
originator
|
Bu, tək hesabla müxtəlif göndəricilər altında sms göndərmək istən
TYPE:
|
username
|
Posta Guvercini hesabı adı. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
Posta Guvercini hesabı şifrəsi. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
get_status(message_ids, username=POSTA_GUVERCINI_USERNAME, password=POSTA_GUVERCINI_PASSWORD)
SMS status sorğusu
Endpoint: /api_json/v1/Sms/Status
Example:
from integrify.postaguvercini import PostaGuverciniClient
PostaGuverciniClient.get_status(message_ids=["123456"])
Cavab formatı: StatusResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq SMS statusu haqqında məlumat gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
message_ids
|
SMS mesajlarının ID-ləri. Boş ola bilməz.
TYPE:
|
username
|
Posta Guvercini hesabı adı. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
Posta Guvercini hesabı şifrəsi. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
credit_balance(username=POSTA_GUVERCINI_USERNAME, password=POSTA_GUVERCINI_PASSWORD)
Kredit balans sorğusu
Endpoint: /api_json/v1/Sms/CreditBalance
Example:
from integrify.postaguvercini import PostaGuverciniClient
PostaGuverciniClient.credit_balance()
Cavab formatı: CreditBalanceResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq kredit balans məlumatı gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
username
|
Posta Guvercini hesabı adı. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
Posta Guvercini hesabı şifrəsi. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|