LSIM Bulk 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 LSIMBulkSMSAsyncClient

integrify.lsim.bulk.client.LSIMBulkSMSClient `module-attribute` ¶

LSIMBulkSMSClient = LSIMBulkSMSClientClass()

integrify.lsim.bulk.client.LSIMBulkSMSAsyncClient `module-attribute` ¶

LSIMBulkSMSAsyncClient = LSIMBulkSMSClientClass(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ı LSIMBulkSMSClientClass().check_balance() kimi istifadə etməlisiniz.

integrify.lsim.bulk.client.LSIMBulkSMSClientClass ¶

LSIMBulkSMSClientClass(name='LSIM-BulkSMS', base_url=BASE_URL, default_handler=None, sync=True, dry=False)

Bases: APIClient

bulk_send_one_message ¶

bulk_send_one_message(controlid, msisdns, bulkmessage, scheduled='NOW', login=LSIM_LOGIN, password=LSIM_PASSWORD, title=LSIM_SENDER_NAME)

Bir SMS-i toplu şəkildə bir çox nəfərə göndərmək sorğusu

Endpoint: /smxml/api

Example

from integrify.lsim import LSIMBulkSMSClient

LSIMBulkSMSClient.bulk_send_one_message(controlid=1, msisdns=['99450XXXXXXX'], bulkmessage='Hello world')

Cavab formatı: SendBulkSMSResponseSchema

PARAMETER	DESCRIPTION
`controlid`	Unikal sorğu id-si. Siz tərəfdən generasiya olunur. TYPE: `int`
`msisdns`	SMS göndəriləcək nömrələr listi. Hər nömrə bu formatda olmalıdır: ölkə kodu + operator kodu + nömrə: 99450XXXXXXX TYPE: `list[str]`
`bulkmessage`	Bu nömrələrə göndəriləcək mesaj məzmunu TYPE: `str`
`scheduled`	Öncədən SMS göndərilməsi üçün seçilmiş zaman. Zamanı `2023-05-19 15:40:05` formatında verməlisiniz. Sahə boş qaldıqda, SMS sorğu atdığınız an gedəcək. TYPE: `str` DEFAULT: `'NOW'`
`login`	LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_LOGIN`
`password`	LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_PASSWORD`
`title`	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: `str` DEFAULT: `LSIM_SENDER_NAME`

bulk_send_different_messages ¶

bulk_send_different_messages(controlid, msisdns, messages, scheduled='NOW', login=LSIM_LOGIN, password=LSIM_PASSWORD, title=LSIM_SENDER_NAME)

Toplu şəkildə bir çox nəfərə fərqli SMS göndərmək sorğusu

Endpoint: /smxml/api

Example

from integrify.lsim import LSIMBulkSMSClient

LSIMBulkSMSClient.bulk_send_one_message(controlid=1, msisdns=['99450XXXXXXX', '99451XXXXXXX'],
                                        messages=['Hello world 1', 'Hello world 2'])

Cavab formatı: SendBulkSMSResponseSchema

PARAMETER	DESCRIPTION
`controlid`	Unikal sorğu id-si. Siz tərəfdən generasiya olunur. TYPE: `int`
`msisdns`	SMS göndəriləcək nömrələr listi. Hər nömrə bu formatda olmalıdır: ölkə kodu + operator kodu + nömrə: 99450XXXXXXX TYPE: `list[str]`
`messages`	Bu nömrələrə göndəriləcək mesajların düzgün ardıcıllıqla məzmunu TYPE: `list[str]`
`scheduled`	Öncədən SMS göndərilməsi üçün seçilmiş zaman. Zamanı `2023-05-19 15:40:05` formatında verməlisiniz. Sahə boş qaldıqda, SMS sorğu atdığınız an gedəcək. TYPE: `str` DEFAULT: `'NOW'`
`login`	LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_LOGIN`
`password`	LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_PASSWORD`
`title`	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: `str` DEFAULT: `LSIM_SENDER_NAME`

get_report ¶

get_report(taskid, login=LSIM_LOGIN, password=LSIM_PASSWORD)

Toplu göndərilmiş SMSlərin report sorğusu

Endpoint: /smxml/api

Example

from integrify.lsim import LSIMBulkSMSClient

LSIMBulkSMSClient.get_report(taskid=1)

Cavab formatı: GetBulkSMSReportResponseSchema

PARAMETER	DESCRIPTION
`taskid`	Uğurlu toplu SMS göndərdikdə alınmış taskid. TYPE: `int`
`login`	LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_LOGIN`
`password`	LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_PASSWORD`

get_detailed_report ¶

get_detailed_report(taskid, login=LSIM_LOGIN, password=LSIM_PASSWORD)

Toplu göndərilmiş SMSlərin detallı report sorğusu

Endpoint: /smxml/api

Example

from integrify.lsim import LSIMBulkSMSClient

LSIMBulkSMSClient.get_detailed_report(taskid=1)

Cavab formatı: GetBulkSMSDetailedReportResponseSchema

PARAMETER	DESCRIPTION
`taskid`	Uğurlu toplu SMS göndərdikdə alınmış taskid. TYPE: `int`
`login`	LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_LOGIN`
`password`	LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_PASSWORD`

get_detailed_report_with_dates ¶

get_detailed_report_with_dates(taskid, login=LSIM_LOGIN, password=LSIM_PASSWORD)

Toplu göndərilmiş SMSlərin detallı report (+ tarix) sorğusu

Endpoint: /smxml/api

Example

from integrify.lsim import LSIMBulkSMSClient

LSIMBulkSMSClient.get_detailed_report_with_dates(taskid=1)

Cavab formatı: GetBulkSMSDetailedReportResponseSchema

PARAMETER	DESCRIPTION
`taskid`	Uğurlu toplu SMS göndərdikdə alınmış taskid. TYPE: `int`
`login`	LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_LOGIN`
`password`	LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_PASSWORD`

check_balance ¶

check_balance(login=LSIM_LOGIN, password=LSIM_PASSWORD)

Balansı öyrənmək sorğusu

Endpoint: /smxml/api

Example

from integrify.lsim import LSIMBulkSMSClient

LSIMBulkSMSClient.check_balance()

Cavab formatı: GetBalanceResponseSchema

PARAMETER	DESCRIPTION
`login`	LSIM logininiz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_LOGIN`
`password`	LSIM parolunuz. Mühit dəyişəni kimi təyin olunmayıbsa, burada parametr kimi ötürülməlidir. TYPE: `str` DEFAULT: `LSIM_PASSWORD`

LSIM Bulk SMS klientinin API Reference-i¶

integrify.lsim.bulk.client.LSIMBulkSMSClient module-attribute ¶

integrify.lsim.bulk.client.LSIMBulkSMSAsyncClient module-attribute ¶

integrify.lsim.bulk.client.LSIMBulkSMSClientClass ¶

bulk_send_one_message ¶

bulk_send_different_messages ¶

get_report ¶

get_detailed_report ¶

get_detailed_report_with_dates ¶

check_balance ¶

integrify.lsim.bulk.client.LSIMBulkSMSClient `module-attribute` ¶

integrify.lsim.bulk.client.LSIMBulkSMSAsyncClient `module-attribute` ¶