> [!WARNING] > É **estritamente proibido** utilizar [SMS transacionais](https://www.bulkgate.com/pt/centro-de-ajuda/informacoes-gerais/diferenca-sms-promocional-e-transacional/) para fins promocionais/de marketing. Devem ser utilizadas apenas para fins de notificação - como notificação SMS. ## URL da API URL utilizado para enviar os pedidos HTTP: ```url https://portal.bulkgate.com/api/1.0/simple/transactional ``` > [!NOTE] > Se o pedido não chegar ao destino, repita-o no [servidor de reserva](https://www.bulkgate.com/pt/documentacao/administracao-da-api/servidor-de-reserva/) `backup1.bulkgate.com`. ## Métodos HTTP suportados - `GET` - `POST` - `application/x-www-form-urlencoded` - `POST` - `application/json` Consulte os [métodos de pedido](https://www.bulkgate.com/pt/documentacao/simple-api/simple-transactional-metodos/) para ver exemplos de cada um. ## Tabela de parâmetros | NOME DO PARÂMETRO | VALOR | OBRIGATÓRIO | VALOR PREDEFINIDO | |:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------:|:-------------:| | application_id | [Identificador da aplicação](https://www.bulkgate.com/pt/documentacao/administracao-da-api/administracao-de-apis/) | **Sim** | - | | application_token | [Token de autenticação da aplicação](https://www.bulkgate.com/pt/documentacao/administracao-da-api/tokens-de-api/) | **Sim** | - | | number | Número do destinatário | **Sim** | - | | text | Texto da mensagem SMS (máx. 612 caracteres, ou 268 caracteres se for utilizado Unicode), codificação UTF-8 | **Sim** | - | | unicode | `Yes`/`true`/`1` para SMS Unicode, `no`/`false`/`0` para SMS de 7 bits | Não | `false` | | sender_id | ID do remetente, consulte [tipo de remetente](#tipo-de-remetente-sender-id) | Não | `gSystem` | | sender_id_value | Valor do remetente - `gOwn` (p. ex. "420 777 777 777"), `gText` (p. ex. "BulkGate"), `gProfile` (p. ex. "423"), `gMobile` ou `gPush` [CHAVE](https://www.bulkgate.com/pt/centro-de-ajuda/mobile-connect/instalacao-do-mobile-connect/) | Não | - | | country | Indique os números dos destinatários em formato internacional (com prefixo, p. ex. `420`) ou adicione o [código do país no formato ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) (`777777777` + `CZ` = `420777777777`). Consulte o exemplo de pedido com o país. Se for **`null`**, será utilizado o fuso horário que definiu para completar a informação | Não | `null` | | schedule | Agende a data e a hora de envio em [unix timestamp](https://en.wikipedia.org/wiki/Unix_time) ou [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). O valor `now` envia a mensagem imediatamente, tal como a omissão do parâmetro. | Não | Agora | | duplicates_check | Selecione **`on`** para evitar o envio de mensagens duplicadas para o mesmo número de telefone. As mensagens com o mesmo texto enviadas para o mesmo número serão removidas se o intervalo entre elas for inferior a 5 minutos. Com **`off`**, nenhum duplicado é removido. | Não | `off` | | tag | Etiqueta da mensagem para posterior pesquisa pelo utilizador. | Não | - | ### Tipo de remetente `sender_id` | VALOR | DESCRIÇÃO | |:-----------|:---------------------------------------------------------------------| | `gSystem` | Número do sistema | | `gShort` | Short Code | | `gText` | Remetente de texto | | `gMobile` | [Mobile Connect](https://www.bulkgate.com/pt/centro-de-ajuda/mobile-connect/instalacao-do-mobile-connect/) | | `gPush` | Mobile Connect push - Envia uma notificação para a aplicação Mobile Connect | | `gOwn` | Número próprio (requer verificação do número) | | `gProfile` | [ID de perfil BulkGate](https://www.bulkgate.com/pt/centro-de-ajuda/sms/perfil-de-remetente/) | ## Exemplo de pedido ```http-json POST /api/1.0/simple/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "777777777", "text": "test_sms", "unicode": true, "sender_id": "gText", "sender_id_value": "BulkGate", "country": "cz" } ``` ## Resposta **Em caso de sucesso:** ```json { "data": { "status": "accepted", "sms_id": "tmpde1bcd4b1d1", "part_id": [ "tmpde1bcd4b1d1_1", "tmpde1bcd4b1d1_2", "tmpde1bcd4b1d1" ], "number": "420777777777" } } ``` Em que: - **part_ID** é o array de ID das partes da mensagem longa original, que foi dividida por exceder o limite de 160 caracteres de uma única mensagem. Mais informações [aqui](https://www.bulkgate.com/pt/centro-de-ajuda/sms/concatenacao-de-mensagens/). **Em caso de erro:** ```json { "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null } ``` ```json { "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null } ``` Em que: - **type** e **error** (descrição do erro) encontram-se na [tabela de tipos de erros](https://www.bulkgate.com/pt/documentacao/administracao-da-api/tipos-de-erro-api/) - **code** representa o código de erro HTTP - **detail** contém informações adicionais sobre o erro Consulte todos os tipos de erros da Simple API e da Advanced API [aqui](https://www.bulkgate.com/pt/documentacao/administracao-da-api/tipos-de-erro-api/).