o lq i{@sdZddlZddlZddlZddlZddlZddlmm m Z ddl m Z ddl mZddlmZddlmZddlmZddlmZdd lmZdd lmZdd lmZdd lm Z dd lmZeeZddZ GdddeZ!dS)z. This module provides a client class for SMS. N)utils) bce_v1_signer) BceBaseClient)BceClientConfiguration)BceClientError)BceServerError)bce_http_client) http_headers) http_methods)sms)requiredcCs |jdtjjdkrtdd}|}|rpt|}d|vrQd|vrQd|vrQ|d}|dkr>t|d|d|dd}n?|j tj|t j dj | d S|jdtjjdkro|j tj|t j dj | d Sn |jdtjjdkr}d S|durt|j|jjd }|j|_|) Ndz#Can not handle 1xx http status codemessagecodeZ requestIdZ1000)r request_id) object_hookT)r)statushttpclientCONTINUErreadjsonloadsr__dict__updaterZdict_to_python_objectcloseOKreasonmetadataZbce_request_id status_code) http_responseresponseZbsebodydZr_coder$g/home/app/PaddleOCR-VL/.venv_paddleocr/lib/python3.10/site-packages/baidubce/services/sms/sms_client.py _parse_result,s> r&c@seZdZdZdAddZeedddZeeeeee d  dBd d Z eeeed  dCd dZ eeeeed  dBddZ eeddAddZ eeddAddZeeeeeeddAddZeeeeeeddDddZeeddAddZeeddAd d!ZdAd"d#Zeeeeeed$ dAd%d&ZedDd'd(ZedDd)d*Ze , dEd-d.Zd/d0Z  1dFd2d3Zeeed4dGd5d6Z  dHd7d8Zeed9dAd:d;Zeeed< > dId?d@ZdS)J SmsClientz Sms sdk client NcCs"|dur ||t||dSN)_check_config_typer__init__selfconfigr$r$r%r*Ss zSmsClient.__init__)r-cCsdS)NTr$r+r$r$r%r)XszSmsClient._check_config_type) signature_id template_idtypemobilecontent_var_dictc Cs0|||||||d} |jtjdt| |ddS)u Send message :param signature_id: The unique code identifying message signature, can be obtained from cloud.baidu.com :type signature_id: string or unicode :param template_id: The unique code identifying message content template, can be obtained from cloud.baidu.com :type template_id: string or unicode :param mobile: The target mobile, use "," as separators if you have multiple targets. :type mobile: string or unicode :param content_var_dict: A map like "{"template param name": "template param content"} :type content_var_dict: dict :param config: None :type config: BceClientConfiguration :param custom: The user-defined param :type custom: string or unicode :param user_ext_id: The user-defined channel code :type user_ext_id: string or unicode :param merchant_url_id: The id of callback url specified by user :type merchant_url_id: string or unicode :return: Object { "request_id": "5e6dacd5-8815-4183-8255-4ff079bf24e6", "code": "1000", "message": "成功", "data": [ { "code": "1000", "message": "成功", "mobile": "13800138000", "message_id": "e325ea68-02c1-47ad-8844-c7b93cafaeba_13800138000" } ] } ) signatureIdtemplater1Z contentVarcustomZ userExtIdZ merchantUrlIdZsendSms)r"r- api_version _send_requestr POSTrdumps) r,r.r/r1r2r-r5Z user_ext_idZmerchant_url_iddatar$r$r% send_message\s. zSmsClient.send_message)content content_type country_typeDOMESTICc Cs\|||d}|r ||d<|r||d<|r||d<t|jtjddtit||ddS) a$ Create signature :param content: Signature content, only Chinese and English characters and numbers are allowed. :type content: string or unicode :param content_type: Signature type, one of "Enterprise, MobileApp, Web, WeChatPublic, Brand, Else" :type content_type: string or unicode :param description: Description of the signature :type description: string or unicode :param country_type: The country or region in which the template can be used. Default value is "DOMESTIC". The value of countryType could be DOMESTIC or INTERNATIONAL or GLOBAL. DOMESTIC: the template can only be used in Mainland China. INTERNATIONAL: the template can only be used out of Mainland China. GLOBAL: the template can only be used all over the world. :type country_type: string or unicode :param signature_file_base_64: The base64 encoding string of the signature certificate picture :type signature_file_base_64: string or unicode :param signature_file_format: The format of the signature certificate picture, only one of JPG, PNG, JPEG allowed. :type signature_file_format: string or unicode :param config: None :type config: BceClientConfiguration :return: Object { "signature_id": "sms-sign-WWejWQ54455", "status": "SUBMITTED" } r>Z contentType countryType descriptionsignatureFileBase64signatureFileFormatsignatureApply clientTokenparamsr"r-r7) modelZCreateSignatureResponser9r r:uuiduuid4rr;) r,r>r?rDr@signature_file_base_64signature_file_formatr-r<r$r$r%create_signatures&  zSmsClient.create_signature)r>r?r@r.c CsN|||d} |r || d<|r|| d<|r|| d<|jtjd|t| |ddS)a Update signature :param content: Signature content :type content: string or unicode :param content_type: Signature type, one of "Enterprise, MobileApp, Web, WeChatPublic, Brand, Else" :type content_type: string or unicode :param signature_id: The unique code identifying the signature :type signature_id: string or unicode :param description: Description of the signature :type description: string or unicode :param country_type: The country or region in which the template can be used. The value of countryType could be DOMESTIC or INTERNATIONAL or GLOBAL. DOMESTIC: the template can only be used in Mainland China. INTERNATIONAL: the template can only be used out of Mainland China. GLOBAL: the template can only be used all over the world. :type country_type: string or unicode :param signature_file_base_64: The base64 encoding string of the signature certificate picture :type signature_file_base_64: string or unicode :param signature_file_format: The format of the signature certificate picture, only one of JPG, PNG, JPEG allowed. :type signature_file_format: string or unicode :param config: None :type config: BceClientConfiguration :return: Object { "content": "Baidu", "content_type": "Enterprise", "description": "test sdk", "country_type": "DOMESTIC", "signature_file_base64": "test-string-base64encoded", "signature_file_format": "png" } rBrDrErFrGrI)keyr"r-r7r9r PUTrr;) r,r>r?r@r.rDrOrPr-r<r$r$r%update_signatures,  zSmsClient.update_signature)r.c Ct|jtjd||ddS)an Get signature detail :param signature_id: The unique code identifying the signature :type signature_id: string or unicode :param config: None :type config: BceClientConfiguration :return: Object { "signature_id": "sms-sign-WWejWQ54455", "user_id": "bbede3f8c42e4113b6971fd09a57f494", "content": "Baidu", "content_type": "MobileApp", "description": "test sdk", "review": "", "status": "SUBMITTED", "country_type": "GLOBAL", } rGrIrRr-r7)rLZGetSignatureResponser9r GETr,r.r-r$r$r%get_signature_detailszSmsClient.get_signature_detailcC|jtjd||ddS)z Delete signature :param signature_id: The unique code identifying the signature :type signature_id: string or unicode :param config: None :type config: BceClientConfiguration :return: rGrIrWr9r DELETErYr$r$r%delete_signatures zSmsClient.delete_signature)namer>sms_typer@rDc Cs<|||||d}t|jtjddtit||ddS)a  Create template with specific name and content :param name: Template name :type name: string or unicode :param content: Template content like 'this is ${APP}, your code is ${VID}' :type content: string or unicode :param sms_type: Business type of the template content, can be obtained from cloud.baidu.com :type sms_type: string or unicode :param country_type: The country or region in which the template can be used. The value of countryType could be DOMESTIC or INTERNATIONAL or GLOBAL. DOMESTIC: the template can only be used in Mainland China. INTERNATIONAL: the template can only be used out of Mainland China. GLOBAL: the template can only be used all over the world. :type country_type: string or unicode :param description: Description of the template :type description: string or unicode :param config: None :type config: BceClientConfiguration :return: Object { "template_id": "sms-tmpl-wHoJXL09355", "status": "SUBMITTED", } :rtype: baidubce.bce_response.BceResponse )r_r>smsTyperCrDr4rHrIrJ) rLZCreateTemplateResponser9r r:rMrNrr;)r,r_r>r`r@rDr-r<r$r$r%create_template*s#  zSmsClient.create_template)r/r_r>r`r@c Cs8||||d}|r ||d<|jtjd|t||ddS)a Update template when audition failed. :param template_id: The unique code identifying the template :type template_id: string or unicode :param name: the name of template :type name: string or unicode :param content: the content of template,such as 'this is ${APP}, your code is ${VID}' :type content: string or unicode :param sms_type: The business type of the template content, can be obtained from cloud.baidu.com :type sms_type: string or unicode :param country_type: The country or region in which the template can be used. The value of countryType could be DOMESTIC or INTERNATIONAL or GLOBAL. DOMESTIC: the template can only be used in Mainland China. INTERNATIONAL: the template can only be used out of Mainland China. GLOBAL: the template can only be used all over the world. :type country_type: string or unicode :param description: Description of the template :type description: string or unicode :param config: None :type config: BceClientConfiguration :return: )r_r>rarCrDr4rI) http_method function_namerRr"r-r7rS) r,r/r_r>r`r@rDr-r<r$r$r%update_templateWs  zSmsClient.update_template)r/c CrV)u Get template detail :param template_id: The ID of message template :type template_id: string or unicode :param config: None :type config: BceClientConfiguration :return: { "template_id": "sms-tmpl-wHoJXL09355", "user_id": "bbede3f8c42e4113b6971fd09a57f494", "name": "TemplateNameTest", "content": "${code}", "sms_type": "CommonNotice", "description": "test modify", "review": "通过", "status": "APPROVED", "country_type": "INTERNATIONAL", } r4rI)rdrRr-r7)rLZGetTemplateResponser9r rXr,r/r-r$r$r%get_template_detailszSmsClient.get_template_detailcCr[)z Delete template :param template_id: The ID of message template :type template_id: string or unicode :param config: None :type config: BceClientConfiguration :return: r4rI)rcrdrRr-r7r\rfr$r$r%delete_templates zSmsClient.delete_templatec Cs t|jtjdddi|ddS)a Query quota and rate-limit detail :param config: None :type config: BceClientConfiguration :return: { "quota_oer_day": 100, "quota_per_month": 1000, "quota_remain_today": 100, "quota_remain_this_month": 1000, "apply_check_status": "PASS", "check_reply": "", "apply_quota_per_day": 10, "apply_quota_per_month": 10, "rate_limit_per_mobile_per_sign_by_minute": 5, "rate_limit_per_mobile_per_sign_by_hour": 10, "rate_limit_per_mobile_per_sign_by_day": 50, "rate_limit_white_list": true } quotaZ userQueryrIrdrKr-r7)rLZQueryQuotaResponser9r rXr+r$r$r%query_quota_rates zSmsClient.query_quota_rate) quota_per_dayquota_per_month(rate_limit_per_mobile_per_sign_by_minute&rate_limit_per_mobile_per_sign_by_hour%rate_limit_per_mobile_per_sign_by_daycCs,|||||d}|jtjdt||ddS)aj :param quota_per_day: Upper bound of the response-success request counts in one natural day. :type quota_per_day: int :param quota_per_month: Upper bound of the response-success request counts in one natural month. :type quota_per_month: int :param rate_limit_per_mobile_per_sign_by_minute: The limit with same mobile and signature in one minute :type rate_limit_per_mobile_per_sign_by_minute: int :param rate_limit_per_mobile_per_sign_by_hour: Hourly limit with same mobile and signature :type rate_limit_per_mobile_per_sign_by_hour: int :param rate_limit_per_mobile_per_sign_by_day: Daily rate limit with same mobile and signature :type rate_limit_per_mobile_per_sign_by_day: int :param config: None :type config: BceClientConfiguration :return: )Z quotaPerDayZ quotaPerMonthZ!rateLimitPerMobilePerSignByMinuteZrateLimitPerMobilePerSignByHourZrateLimitPerMobilePerSignByDayrirIrdr"r-r7rS)r,rmrnrorprqr-r<r$r$r%update_quota_rateszSmsClient.update_quota_ratecCttj||Sr()r append_urir Z URL_PREFIX_V3r-rdrRr$r$r% _get_path_v3zSmsClient._get_path_v3cCrtr()rrur ZURL_PREFIX_V3_2rvr$r$r%_get_path_v3_2rxzSmsClient._get_path_v3_2rc Csgd}|dust|dkr/g}|D]} | } | tjs$| |vr)|| q|n|D]} | } | tjrD|| q1|t ||||||||S)N)shosts content-md5scontent-lengths content-typer) lenstriplower startswithr Z BCE_PREFIXappendsortrsign) credentialsrcpathheadersrK timestampZexpiration_in_secondsZheaders_to_signZheaders_to_sign_listkZk_lowerr$r$r% _bce_sms_signs0      zSmsClient._bce_sms_signcCs2|dur|jS||t|j}|||Sr()r-r)copyZmerge_non_none_values)r,r-Z new_configr$r$r% _merge_configs    zSmsClient._merge_configr6c Cs^||}tjtjd| |||} |durt}|dur!ddd}t|tj|g|| |||S)N)r6rIs*/*sapplication/json;charset=utf-8)sAccepts Content-Type)rr'rwryr&r send_requestr) r,rcrdrRr"rrKr-Z body_parserr7rr$r$r%r9s  zSmsClient._send_request)r0phonecCs@|||d}|r ||d<|r||d<|jtjdt||ddS)a :param type: The value of type could be MerchantBlack or SignatureBlack :type type: str :param country_type: The value of countryType could be DOMESTIC or INTERNATIONAL :type country_type: str :param sms_type: Mobile of black, Support multiple mobile phone numbers, up to 200 maximum, separated by comma. :type sms_type: str :param signature_id_str: When the value of "type" is "SignatureBlack", this field is required. :type signature_id_str: str :param phone: When the value of "type" is "SignatureBlack", this field is required. :type phone: str :param config: None :type config: BceClientConfiguration )r0rrCrasignatureIdStr blacklistrIrrr8)r,r0rr@r`signature_id_strr-r<r$r$r%create_mobile_black'szSmsClient.create_mobile_blackc Csi} |r|| d<|r|| d<|r|| d<|r|| d<|r || d<|r&|| d<|r,|| d<|r2|| d<t|jtjd | | d d S) a> Get mobile black :param phone: Support multiple mobile phone numbers, up to 200 maximum, separated by comma. :type phone: str :param country_type: The value of countryType could be DOMESTIC or INTERNATIONAL :type country_type: str :param sms_type: smsType :type sms_type: str :param signature_id_str: signatureIdStr :type signature_id_str: str :param start_time: format is yyyy-MM-dd :type start_time: str :param end_time: format is yyyy-MM-dd :type end_time: str :param page_no: The current page number :type page_no: int :param page_size: The current page size, range from 1 to 99999 :type page_size: int :param config: None :type config: BceClientConfiguration :return: Object { "blacklists": [ { "phone": "17611111111", "type": "SignatureBlack", "smsType": "CommonNotice", "signatureIdStr": "1234", "updateDate": "2023-07-14 14:23:41" } ], "totalCount": 1, "pageNo": 1, "pageSize": 100 } rrCrar startTimeendTimeZpageNoZpageSizerrIrk)rLZGetMobileBlackResponser9r rX) r,rr@r`r start_timeend_timeZpage_noZ page_sizer- req_paramsr$r$r%get_mobile_blackLs(0zSmsClient.get_mobile_black)phonescCsd|i}|jtjd||ddS)a Delete mobile_black :param phones: Support multiple mobile phone numbers, up to 200 maximum, separated by comma. :type phones: string :param config: None :type config: BceClientConfiguration :return: rzblacklist/deleterIrcrdrKr-r7r\)r,rr-rr$r$r%delete_mobile_blacks  zSmsClient.delete_mobile_black)rralldomesticc CsV|d|d|dd}|r||d<|r||d<|r||d<t|jtjd||d d S) u Get messages statistics list :param start_time: The start of time condition, format: yyyy-MM-dd :type start_time: str :param end_time: The end of time condition, format: yyyy-MM-dd :type end_time: str :param sms_type: Queried message type, "all" as default :type sms_type: str :param signature_id: Queried signature id :type signature_id: str :param template_code: Queried template code, for instance: "sms-tmpl-xxxxxxxx" :type template_code: str :param country_type: Queried country type, available values: "domestic", "international" :type country_type: str :param config: None :type config: BceClientConfiguration :return: Object: { "statisticsResults": [ { "datetime": "合计", "countryAlpha2Code": "", "submitLongCount": "10", "submitCount": "100", "deliverSuccessCount": "99", "deliverSuccessLongCount": "10", "deliverFailureCount": "1", "unknownCount": "0", "deliverSuccessProportion": "0.99", "deliverFailureProportion": "0.01", "notExistCount": "0", "signatureOrTemplateCount": "0", "abnormalCount": "0", "overclockingCount": "0", "otherErrorCount": "0", "blacklistCount": "0", "routeErrorCount": "0", "issueFailureCount": "0", "parameterErrorCount": "0", "illegalWordCount": "0", "anomalyCount": "1", "unknownErrorCount": "0", "receiptProportion": "1.0", "unknownProportion": "0", "responseSuccessCount": "100", "responseTimeoutCount": "0", "responseSuccessProportion": "1.0" }, { "datetime": "2023-10-30", "countryAlpha2Code": "", "submitLongCount": "10", "submitCount": "100", "deliverSuccessCount": "99", "deliverSuccessLongCount": "10", "deliverFailureCount": "1", "unknownCount": "0", "deliverSuccessProportion": "0.99", "deliverFailureProportion": "0.01", "notExistCount": "0", "signatureOrTemplateCount": "0", "abnormalCount": "0", "overclockingCount": "0", "otherErrorCount": "0", "blacklistCount": "0", "routeErrorCount": "0", "issueFailureCount": "0", "parameterErrorCount": "0", "illegalWordCount": "0", "anomalyCount": "1", "unknownErrorCount": "0", "receiptProportion": "1.0", "unknownProportion": "0", "responseSuccessCount": "100", "responseTimeoutCount": "0", "responseSuccessProportion": "1.0" }, ] } z 00:00:00z 23:59:59day)rrra dimensionrCr3Z templateCodesummaryrIr)rLZListStatisticsResponser9r rX) r,rrr`r@r.Z template_coder-rr$r$r%list_statisticss\zSmsClient.list_statisticsr()NNNN)NrANNN)NN)rrzN)NNNNNNNr6)NNN) NNNNNNNNN)rrNNN) __name__ __module__ __qualname____doc__r*r rr)strdictr=rQrUrZr^rbrergrhrlintrs staticmethodrwryrrr9rrrrr$r$r$r%r'Nst   8 3 9   , '    "       $ L  r')"rrrloggingrM http.clientrZbaidubce.services.sms.modelZservicesr rLZbaidubcerZ baidubce.authrZbaidubce.bce_base_clientrZ!baidubce.bce_client_configurationrZbaidubce.exceptionrrZ baidubce.httprr r Zbaidubce.servicesZbaidubce.utilsr getLoggerrZ_loggerr&r'r$r$r$r%s*            "