Buscar listas

Endpoint: GET https://croncrm.com/api/v1/broadcast/get-all-broadcast-list

Retorna as suas listas de transmissões e participantes.

Header do request
Atributo Descrição Obrigatório Tipo

apiKey

Informe sua API Key gerada na interface do CRONCRM.

Sim

String

Body do request

Sem necessidade de passar parâmetros no body.

Request response
Atributo Descrição Tipo

success

Informa se a operação teve sucesso ou não.

  • TRUE = Informa se a consulta foi realizada com sucesso.
  • FALSE = Algo de errado aconteceu e não foi possível realizar a consulta.

Boolean

msg

Mensagem de retorno.

String

countBroadcasts

Informa a quantidade de listas encontradas.

Inteiro

broadcasts

Retorna um array com as listas de transmissões e os seus parâmetros, para cada lista será retornada em uma posição do array da seguinte forma:

wid: ID da lista em questão.
name: Nome da lista em questão.
participants: Array contendo os participantes da lista, neste caso será retornado um array contendo apenas o parâmetro wid para cada participante que é o número do participante.

Array

{
   "success": true,
   "msg": "Consulta realizada com sucesso.",
   "countBroadcasts": 1,
   "broadcasts": [
      {
         "wid": "ID da lista.",
         "name": "Nome da lista",
         "participants": [
            {"wid": "ID do participante."}
         ]
      }
   ]
}