Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
group-invitation-link
/
{groupId}
Obter link de convite
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/group-invitation-link/{groupId} \
  --header 'Client-Token: <api-key>'
{
  "phone": "<string>",
  "invitationLink": "<string>"
}

​
Conceituação

Este método permite que você obtenha o link de convite de um grupo.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Path

​
groupId
string
obrigatório
ID/Phone do grupo

​
Response

​
200

​
phone
string
ID/Phone do grupo
​
invitationLink
string
Link de convite do grupo
{
  "phone": "120363019502650977-group",
  "invitationLink": "https://chat.whatsapp.com/C1adgkdEGki7554BWDdMkd"
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.