Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
broadcast
Listar listas de transmissão
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/broadcast \
  --header 'Client-Token: <api-key>'

​
Conceituação

Neste método você pode listar todas as listas de transmissão associadas à sua instância, com suporte a paginação.
Atente-se às limitações e regras do uso de listas de transmissão. Para mais detalhes, consulte a introdução.

​
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.

​
Query params (Opcionais)

​
page
number
Número da página a ser retornada. Começa em 1
​
pageSize
number
Quantidade de itens por página. Padrão: 20

​
Response

​
200

[
  {
    "broadcastId": "1779395073@broadcast",
    "name": "Teste broadcast 44",
    "phones": [
      "5511999999999",
      "5511888888888"
    ]
  },
  {
    "broadcastId": "1779395075@broadcast",
    "name": "Teste broadcast 45",
    "phones": [
      "5511999999999",
      "5511888888888"
    ]
  }
]

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o 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”.