LSIM Single SMS 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.lsim import LSIMSingleSMSAsyncClient
module-attribute
¶
LSIMSingleSMSClient = LSIMSingleSMSClientClass()
module-attribute
¶
LSIMSingleSMSAsyncClient = LSIMSingleSMSClientClass(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ı LSIMSingleSMSClientClass().send_sms_post() kimi istifadə etməlisiniz.
LSIMSingleSMSClientClass(name='LSIM', base_url=BASE_URL, default_handler=None, sync=True, dry=False)
Bases: APIClient
send_sms_get(msisdn, text, login=LSIM_LOGIN, password=LSIM_PASSWORD, sender=LSIM_SENDER_NAME, unicode=False)
SMS göndərən GET sorğusu
Endpoint: /quicksms/v1/send
Example
from integrify.lsim import LSIMSingleSMSClient
LSIMSingleSMSClient.send_sms_get(msidn='99450XXXXXXX', text='test')
Cavab formatı: BaseGetResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq BaseGetResponseSchema formatında
cavab gəlir, və uğurlu olduqda, obj field-ində transaction_id dəyəri gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
msisdn
|
SMS göndəriləcək nömrə: ölkə kodu + operator kodu + nömrə: 99450XXXXXXX
TYPE:
|
text
|
Mesaj məzmunu
TYPE:
|
login
|
LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
sender
|
LSIM tərəfindən təyin olunmuş göndərən adınız. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
unicode
|
Mesajın unicode olub/olmaması. Əgər mesajda unikod simvollar (
TYPE:
|
send_sms_post(msisdn, text, login=LSIM_LOGIN, password=LSIM_PASSWORD, sender=LSIM_SENDER_NAME, unicode=False, scheduled='NOW')
SMS göndərən POST sorğusu
Endpoint: /quicksms/v1/smssender
Example
from integrify.lsim import LSIMSingleSMSClient
LSIMSingleSMSClient.send_sms_post(msidn='99450XXXXXXX', text='test')
Cavab formatı: BasePostResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq BasePostResponseSchema formatında
cavab gəlir, və uğurlu olduqda, obj field-ində transaction_id dəyəri gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
msisdn
|
SMS göndəriləcək nömrə: ölkə kodu + operator kodu + nömrə: 99450XXXXXXX
TYPE:
|
text
|
Mesaj məzmunu
TYPE:
|
login
|
LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
sender
|
LSIM tərəfindən təyin olunmuş göndərən adınız. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
unicode
|
Mesajın unicode olub/olmaması. Əgər mesajda unikod simvollar (
TYPE:
|
scheduled
|
Öncədən SMS göndərilməsi üçün seçilmiş zaman. Zamanı
TYPE:
|
check_balance(login=LSIM_LOGIN, password=LSIM_PASSWORD)
LSIM balans sorğusu
Endpoint: /quicksms/v1/balance
Example
from integrify.lsim import LSIMSingleSMSClient
LSIMSingleSMSClient.check_balance()
Cavab formatı: BaseGetResponseSchema
Bu sorğunu göndərdikdə, cavab olaraq BaseGetResponseSchema formatında
cavab gəlir, obj field-ində balans dəyəri gəlir.
| PARAMETER | DESCRIPTION |
|---|---|
login
|
LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
password
|
LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
get_report_get(trans_id, login=LSIM_LOGIN)
Göndərilmiş SMS-in reportunu alan GET sorğusu
Endpoint: /quicksms/v1/report
Example
from integrify.lsim import LSIMSingleSMSClient
LSIMSingleSMSClient.get_report_get(trans_id=1)
Cavab formatı: ReportGetResponseSchema
| PARAMETER | DESCRIPTION |
|---|---|
trans_id
|
Uğurlu SMS göndərildikdə alınan transaction id
TYPE:
|
login
|
LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|
get_report_post(trans_id, login=LSIM_LOGIN)
Göndərilmiş SMS-in reportunu alan POST sorğusu
Endpoint: /quicksms/v1/smsreporter
Example
from integrify.lsim import LSIMSingleSMSClient
LSIMSingleSMSClient.get_report_post(trans_id=1)
Cavab formatı: ReportPostResponseSchema
| PARAMETER | DESCRIPTION |
|---|---|
trans_id
|
Uğurlu SMS göndərildikdə alınan transaction id
TYPE:
|
login
|
LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir.
TYPE:
|