---
title: Gupshup
slug: aura/gupshup
docTags: 
createdAt: 2025-07-07T20:39:55.890Z
---

A especificação abaixo serve como manual para a utilização do broker [Gupshup](https://www.gupshup.io/).

## Configuração

Para cadastrar o broker Gupshup é necessário um número de Whatsapp Busines, o nome do app registrado no Gupshup e uma chave de acesso do app. Para testes o Gupshup oferece um modo Sandbox com um número habilitado a enviar e receber mensagens.

### Criando uma conta

Basta acessar o [Gupshup](https://www.gupshup.io/) e acessar a tela de login clicando no botão superior esquerdo.

![Registro](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/CECRJFnqFBnADO9n5QsR0_gupshupregister.png)

### Criando um app

Para criar um app Gupshup é necessáro estar logado e acessar o dashboard e clicar no botão "Create App", nomear o app. Uma vez criado o app basta acessá-lo clicando em "Overview" ao lado direito do nome do app. Lá é possível obter informações do app como sua chave de api e acessar o modo Sandbox. **Para que seja possível receber e enviar mensagens de um número é necessário ir na aba "Opt-ins" e habilitar o número de Whatsapp.**

![Criar app](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/dbyrwx1vdGp6bU5UKQ62C_createapp.png)

![Abrir app](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/SmGox-q0invgUQW2Zn6gk_overview.png)

![opt in](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/vsPNdmx_jMBkwRLU7fRO__optin.png)

### Registrando o webhook

![Webhook](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/5r9t_3iGPYRNU8eIBTy0t_webhook.png)

Para cadastrar o endereço webhook basta acessar a aba "Webhook", inserir o endereço do webhook no campo "Callback URL" e clicar em "Set".

```text
https://{caminho_para_lunaris}/post/{nome_do_plugin}/webhook
```

## Campos Necessários

Para registar o broker Gupshup são necessários os seguintes campos:

```text
Número de telefone da conta
Canal do app
Nome do app gupshup
Chave da API
```

### Número de telefone

Caso esteja usando o modo Sandbox do Gupshup é fornecido um número para testes.

![Numero da conta](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/TQJR1ovSLtapoQktggvf1_numero.png)

É possível verificar o número da conta através do menu Sandbox dentro de um app

Caso não esteja usando o modo sandbox utilize o número registrado na conta Gupshup

### Canal do APP

O Gupshup possui diversos canais para envio e recebimento de texto por isso é necessário escolher em qual ele irá funcionar.

Para utilizar o Whatsapp como canal basta registar como "whatsapp"

### Nome do APP Gupshup

É o nome registrado do APP Gupshup feito nos passos anteriores.

### Chave da API

Para obter a chave API basta acessar o menu "Settings" dentro de um APP Gupshup ou clicar no avatar no canto superior direito

![Chave API](https://api.archbee.com/api/optimize/pu5VMc-2TW3GQX4ly5Xp7/iAQUgNewBKNEFAwnku9yu_apikey.png)