# QI Tech — Lending-as-a-Service › Notification Management Documentação da QI Tech em texto corrido, para colar em um LLM. Fonte: https://docs.qitech.com.br 6 página(s). Índice: - Do not disturb (/en/documentation/emissao_de_divida/nao_me_perturbe) - Notification Configuration (/en/documentation/notificacoes/configuracao_de_notificacao) - Template Configuration (/en/documentation/notificacoes/configuracao_template) - Custom Notification Management (/en/documentation/notificacoes/introducao) - Templates (/en/documentation/notificacoes/template) - Events (/en/documentation/notificacoes/tipos_de_evento) --- # Do not disturb URL: /en/documentation/emissao_de_divida/nao_me_perturbe "Do not disturb" is a platform that was created by telecommunications operators that allows consumers to register their phone number to not actively receive telemarketing content. In the consigned credit context, its utilization was incorporated as a measure of the 'Autoregulação do Crédito Consignado' (Consigned Credit Autoregulation) promoted by entities such as the Febraban, ABBC and CNF, with its goal to protect consumers against abusive practices in credit offers. As a financial institution that is adherant to the "Do not disturb", we have implemented a verification mechanism that guarantees that there are no unwanted calls to blacklisted telephone numbers. Through this API, it is possible to verify whether a specific number has requested to be inserted into the "Do not disturb" database prior to any active credit offers. This verification is essential to ensure compliance with good faith business practices respecting customers privacy. :::caution Caution Consulting the database prior to prospecting crucial. ::: ## Using guide To consult the database, one must send a phone number through the following endpoint. ENDPOINT /do_not_disturb?phone_number=11999999999 METHOD GET :::caution Caution The number must be formatted as DDD + Number, for example: 11999999999. ::: ### Response STATUS 200 - Number found on "Do not disturb" list STATUS 404 - Number not found on "Do not disturb" list :::caution Caution If the number is found on the "Do not disturb" list, a call is not to be followed through. ::: --- # Notification Configuration URL: /en/documentation/notificacoes/configuracao_de_notificacao Here we will demonstrate how you can choose which types of events will be notified and by which means the notification will occur. :::warning Warning If there is no notification configuration for an event, you will not receive notifications for it. ::: ## Creating a Notification Configuration ## Request ENDPOINT /notification/notification_configuration METHOD POST Request Body ```json { "callback": true, "email": true, "event_type": "account_transaction", "sms": true } ``` ## Response STATUS 201 Response Body ```json {"notification_configuration_key": "69850ae3-28bc-4779-a871-e73e1e883413"} ``` ## Listing Notifications Configurations ## Request ENDPOINT /notification/notification_configurations METHOD GET ## Response STATUS 200 Response Body ```json { "data": [{ "event_type": "account_request", "sms_template": "b35ed5fc-fdda-4618-84e6-b49876dabf23", "template_configuration_key": "480521cc-b0c9-4938-bd11-0000be11c66b" }], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 1 } } ``` ## Update Notifications configuration ## Request ENDPOINT /notification/notification_configuration/ NOTIFICATION_CONFIGURATION_KEY METHOD PUT Request Body ```json { "callback": true, "email": true, "event_type": "account_transaction", "sms": false } ``` ## Response STATUS 200 Response Body ```json {} ``` STATUS 4XX Response Body: Error ```json { "title": "titulo", "description": "description in English", "translation": "descrição em portugues", "code": "codigo", "extra_fields": {} } ``` | HTTP Code | QI Code
`code` | Title
`title` | Description (eng)
`Description` | Description (ptbr)
`translation` | |-------------|----------------------|---------------------------------------|-------------------------------------------------|----------------------------------------------------------------------| | 400 | PMB000026 | Invalid notification for event type | Invalid notification method for event type | Método de notificação inválido para tipo de evento | --- # Template Configuration URL: /en/documentation/notificacoes/configuracao_template This configuration allows you to set SMS and email templates for an event. ## Creating template configuration ## Request ENDPOINT /notification/template_configuration METHOD POST Request Body ```json { "event_type": "bank_slip", "email_template_key": "e5c337db-dacc-4f1d-8a3e-919628640dd5" } ``` ## Response STATUS 201 Response Body ```json {"template_configuration_key": "e5c337db-dacc-4f1d-8a3e-919628640d51"} ``` Response Body: Error ```json { "title": "titulo", "description": "description in English", "translation": "description in portuguese", "code": "codigo", "extra_fields": {} } ``` | HTTP Code | QI Code
`code` | Title
`title` | Description (eng)
`Description` | Description (ptbr)
`translation` | |-------------|----------------------|--------------------|-------------------------------------------------------------------------|--------------------------------------------------------------------| | 400 | PMB000023 | Bad Request | Already exists an template configuration to this person and event type | Já existe um template configuration para essa pessoa e event type | ## Listing template configuration ## Request ENDPOINT /notification/template_configurations METHOD GET ## Response STATUS 200 Response Body ```json { "data": [ { "event_type": "bank_slip", "sms_template": null, "template_configuration_key": "e5c337db-dacc-4f1d-8a3e-919628640d51", "email_template": "e5c337db-dacc-4f1d-8a3e-919628640dd5" }, { "event_type": "account_transaction", "sms_template": null, "template_configuration_key": "e5c337db-dacc-4f1d-8a3e-919628640ds1", "email_template": "e5c337db-dacc-4f1d-8a3e-919628640dd5" } ], "pagination": { "current_page": 0, "next_page": null, "rows_per_page": 10 } } ``` ## Updating template configuration ## Request ENDPOINT /notification/template_configuration/ TEMPLATE_CONFIGURATION_KEY METHOD PUT Request Body ```json { "event_type": "bank_slip", "email_template_key": "e5c337db-dacc-4f1d-8a3e-919628640dd5" } ``` ## Response STATUS 201 Response Body ```json {} ``` STATUS 4XX Response Body: Error ```json { "title": "titulo", "description": "description in English", "translation": "description in portuguese", "code": "codigo", "extra_fields": {} } ``` | HTTP Code | QI Code
`code` | Title
`title` | Description (eng)
`Description` | Description (ptbr)
`translation` | |-------------|----------------------|--------------------|------------------------------------------|--------------------------------------------------------| | 400 | PMB000022 | Bad Request | The event type (event type) is not valid | O tipo de evento (tipo de evento) enviado não é válido | | 404 | PMB000024 | Not Found | Template configuration not found | Configuração de template não encontrada | --- # Custom Notification Management URL: /en/documentation/notificacoes/introducao Our platform offers a comprehensive range of notification options, including emails, SMS messages, and webhooks, allowing users to select the channel that best suits their needs and preferences. Additionally, we provide customization capabilities through templates for emails and SMS, ensuring that notifications align with the user's identity and communication style. One of the most notable aspects of our system is the ability for users to define when they wish to receive notifications for specific events. This flexibility allows for more efficient management of the information flow, ensuring that users receive only the most relevant notifications at the most opportune time. In this section of the documentation, we will detail the various aspects of Custom Notification Management, from initial setup to advanced customization, providing users with a comprehensive understanding of how to make the most of this essential feature on our platform. --- # Templates URL: /en/documentation/notificacoes/template Here we will see how to create email and SMS templates. These templates will allow you to customize the text and email messages sent for each type of event. If not configured and the configuration is enabled, the default template from our platform will be sent. Note: To insert a custom variable in the text, simply add '[variable_name]'. ## Creation of SMS template ## Request ENDPOINT /notification/template METHOD POST Request Body ```json { "template_type": "sms", "template": "Olá seu token e [name]" } ``` ## BODY PARAMS | Field | Type | Description | Characters | |----------------|--------|------------------------------|------------| | `template_type` * | string | Type of template -> Default value `sms` | - | | `template` * | string | SMS text | 160 | ## Response STATUS 201 Response Body ```json { "template_key": "17f49953-29a1-439c-a6be-db37a32e2746" } ``` ## Creation of e-mail template :::warning Warning The email template is an HTML document compatible with email HTML formatting. It must be encoded in base64. ::: ## Request ENDPOINT /notification/template METHOD POST Request Body ```json { "template_type": "email", "subject": "Título do email", "template": "<!DOCTYPE html>
<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" lang="en">
  <head>
    <title></title>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <!--[if mso]>
				<xml>
					<o:OfficeDocumentSettings>
						<o:PixelsPerInch>96</o:PixelsPerInch>
						<o:AllowPNG/>
					</o:OfficeDocumentSettings>
				</xml>
				<![endif]-->
    <!--[if !mso]>
				<!-->
    <link href="https://fonts.googleapis.com/css?family=Montserrat" rel="stylesheet" type="text/css">
    <!--
					<![endif]-->
    <style>
      * {
        box-sizing: border-box;
      }

      body {
        margin: 0;
        padding: 0;
      }

      a[x-apple-data-detectors] {
        color: inherit !important;
        text-decoration: inherit !important;
      }

      #MessageViewBody a {
        color: inherit;
        text-decoration: none;
      }

      p {
        line-height: inherit
      }

      @media (max-width:620px) {
        .row-content {
          width: 100% !important;
        }

        .stack .column {
          width: 100%;
          display: with;
        }
      }
    </style>
  </head>
  <body style="background-color: #fff; margin: 0; padding: 0; -webkit-text-size-adjust: none; text-size-adjust: none;">
    <table class="nl-container" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #fff;">
      <tbody>
        <tr>
          <td>
            <table class="row row-1" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #000000; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-top: 5px; padding-bottom: 5px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="image_block" width="100%" border="0" cellpadding="20" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td>
                                  <div align="center" style="line-height:10px">
                                    <img src="https://9o37.mjt.lu/tplimg/9o37/b/1yz7i/hk3sp.png" style="display: block; height: auto; border: 0; width: 120px; max-width: 100%;" width="120" alt="placeholder logo" title="placeholder logo">
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
            <table class="row row-2" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #000000; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-top: 5px; padding-bottom: 5px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="heading_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td style="padding-bottom:20px;padding-left:20px;padding-right:20px;padding-top:60px;text-align:center;width:100%;">
                                  <h1 style="margin: 0; color: #000000; direction: ltr; font-family: Montserrat, Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Lucida Sans, Tahoma, sans-serif; font-size: 25px; font-weight: normal; letter-spacing: normal; line-height: 120%; text-align: center; margin-top: 0; margin-bottom: 0;">
                                    <strong>MANUTENÇÃO PROGRAMADA</strong>
                                    <br>
                                  </h1>
                                </td>
                              </tr>
                            </table>
                            <table class="text_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; word-break: break-word;">
                              <tr>
                                <td style="padding-bottom:80px;padding-left:20px;padding-right:20px;padding-top:60px;">
                                  <div style="font-family: sans-serif">
                                    <div style="font-size: 16px; mso-line-height-alt: 16.8px; color: #000000; line-height: 1.2; font-family: Montserrat, Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Lucida Sans, Tahoma, sans-serif;">
                                      <p style="margin: 0; font-size: 18px; text-align: left;">
                                        <br>Informamos que no dia <b>18 de fevereiro (domingo)</b>, a QI Tech realizará uma manutenção geral em todos os seus sistemas e serviços. Esta manutenção terá uma duração de três horas, tendo seu <strong>início às 02:00 (2AM)</strong> e seu <strong>término às 05:00 (5AM)</strong>.
                                      </p>
                                      <p style="margin: 0; font-size: 18px; text-align: left;">
                                        <br>
                                      </p>
                                      <p> Serviços <strong>indisponíveis</strong> durante a mannutenção: </p>
                                      </p>
                                      <ul>
                                        
                                        <li>Todos serviços relacionados ao Pix[name]</li>
                                        <li>Plataforma <strong>qitech.app</strong></li>
                                        <li>Todas as APIs</li>
                                        <li>APP Qi Conta</li>
                                      </ul>
                                      <p style="margin: 0; font-size: 16px; text-align: left; mso-line-height-alt: 16.8px;">&nbsp;</p>
                                      <p style="margin: 0; font-size: 16px; text-align: left;">Atenciosamente,</p>
                                    </div>
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
            <table class="row row-3" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #fff;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #fff; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-left: 20px; padding-right: 20px; padding-top: 0px; padding-bottom: 10px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="image_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td style="width:100%;padding-right:0px;padding-left:0px;">
                                  <div align="center" style="line-height:10px">
                                    <img src="https://9o37.mjt.lu/tplimg/9o37/b/1yz7i/hk3sp.png" style="display: block; height: auto; border: 0; width: 126px; max-width: 100%;" width="126">
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
            <table class="row row-4" align="center" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
              <tbody>
                <tr>
                  <td>
                    <table class="row-content stack" align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; color: #fff; width: 600px;" width="600">
                      <tbody>
                        <tr>
                          <td class="column" width="100%" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-weight: 400; text-align: left; vertical-align: top; padding-top: 5px; padding-bottom: 5px; border-top: 0px; border-right: 0px; border-bottom: 0px; border-left: 0px;">
                            <table class="html_block" width="100%" border="0" cellpadding="0" cellspacing="0" role="presentation" style="mso-table-lspace: 0pt; mso-table-rspace: 0pt;">
                              <tr>
                                <td>
                                  <div style="font-family:Montserrat, Trebuchet MS, Lucida Grande, Lucida Sans Unicode, Lucida Sans, Tahoma, sans-serif;text-align:center;" align="center">
                                    <div style="height:30px;">&nbsp;</div>
                                  </div>
                                </td>
                              </tr>
                            </table>
                          </td>
                        </tr>
                      </tbody>
                    </table>
                  </td>
                </tr>
              </tbody>
            </table>
          </td>
        </tr>
      </tbody>
    </table>
    <!-- End -->
    <div style="background:#ffffff;background-color:#ffffff;margin:0px auto;max-width:600px;">
      <table align="center" border="0" cellpadding="0" cellspacing="0" role="presentation" style="background:#ffffff;background-color:#ffffff;width:100%;">
        <tbody>
          <tr>
            <td style="border:0px solid #ffffff;direction:ltr;font-size:0px;padding:0px 30px 25px 30px;padding-bottom:25px;padding-left:30px;padding-right:30px;padding-top:0px;text-align:center;">
              <!--[if mso | IE]>
															<table role="presentation" border="0" cellpadding="0" cellspacing="0">
																<tr>
																	<td class="" style="vertical-align:top;width:540px;" >
																		<![endif]-->
              <div class="mj-column-per-100 mj-outlook-group-fix" style="font-size:0px;text-align:left;direction:ltr;display:inline-block;vertical-align:top;width:100%;">
                <table border="0" cellpadding="0" cellspacing="0" role="presentation" style="vertical-align:top;" width="100%">
                  <tr>
                    <td align="left" style="font-size:0px;padding:10px 25px;padding-top:0px;padding-bottom:0px;word-break:break-word;">
                      <div style="font-family:Arial, sans-serif;font-size:14px;letter-spacing:normal;line-height:1;text-align:left;color:#000000;">
                        <p class="text-build-content" style="text-align: center; margin: 10px 0; margin-top: 10px;" data-testid="24Y_bMRIoI">
                          <span style="color:#19247E;font-family:Roboto;font-size:14px;"></span>
                        </p>
                        <p class="text-build-content" style="text-align: center; margin: 10px 0; margin-bottom: 10px;" data-testid="24Y_bMRIoI">
                          <span style="color:#19247E;font-family:Roboto;font-size:14px;">
                            <a href="[[UNSUB_LINK_EN]]">
                              <br />
                              <br />
                            </a>
                          </span>
                        </p>
                      </div>
                    </td>
                  </tr>
                </table>
              </div>
              <!--[if mso | IE]>
																	</td>
																</tr>
															</table>
															<![endif]-->
            </td>
          </tr>
        </tbody>
      </table>
    </div>
    <!--[if mso | IE]>
									</td>
								</tr>
							</table>
							<![endif]-->
  </body>
</html>" } ``` ## BODY PARAMS | Field | Type | Description | Characters | |----------------|--------|-------------------------------------|------------| | `template_type` * | string | Type of template -> Default value `email` | - | | `template` * | string | Base64 encoded template | - | | `subject` * | string | Email subject | 80 | ## Response STATUS 201 Response Body ```json { "template_key": "17f49953-29a1-439c-a6be-db37a32e2746" } ``` ## Templates listing ## Request ENDPOINT /notification/templates METHOD GET ## Response STATUS 200 Response Body ```json { "data": [{ "template_key": "b35ed5fc-fdda-4618-84e6-b49876dabf24", "template_type": "sms", "template_status": "480521cc-b0c9-4938-bd11-0000be11c66b", "template": "Seu código é [code]" }], "pagination": { "current_page": 1, "next_page": null, "rows_per_page": 1 } } ``` --- # Events URL: /en/documentation/notificacoes/tipos_de_evento Events trigger notifications. By reviewing the event list, you can gain understanding of the types of notifications you can receive and the means through which they are delivered (webhook, email, and SMS). Events have the attributes `allowed_sms`, `allowed_email`, and `allowed_callback` that indicate the possibility of sending SMS, emails, or callbacks respectively. Additionally, in cases where email and SMS sending is possible, they may contain `allowed_custom_vars` that indicate the variables that can be replaced in the template using the format `[allowed_custom_var]`, which will be replaced by its corresponding value during delivery. ## Events consult ## Request ENDPOINT /notification/event_types METHOD GET ### Query Params | Field | Type | Description | |------------|--------|------------------------------------------| | `page` | number | Page to be retrieved, default value is 0 | | `page_size`| number | Number of items to be retrieved, default is 10 | ## Response STATUS 200 Response Body: Event types list ```json { "data": [ { "event_type": "incoming_ted", "allow_sms": false, "allow_email": true, "allow_callback": true, "allowed_custom_vars": ["total_amount", "target_account_number", "target_document_number"] }, { "event_type": "outgoing_ted", "allow_sms": true, "allow_email": true, "allow_callback": false, "allowed_custom_vars": null } ], "pagination": { "current_page": 1, "next_page": 2, "rows_per_page": 2 } } ```