Campanhas
Campanhas: um template aprovado enviado a um público, com agendamento, janela de envio e controle de vazão. Os envios acontecem num processo à parte e não gastam o limite de envio da sua API key.
GETListar campanhasAs campanhas da conta, das mais novas às mais antigas. Uma API key restrita a alguns números só vê as campanhas desses números.POSTCriar campanhaCria um rascunho. Só name é obrigatório: número, template, variáveis e público podem vir depois, por PATCH. A campanha só é conferida por inteiro na…POSTSubir mídia do cabeçalho da campanhaSobe para a Meta, pelo número da campanha, a imagem, o vídeo ou o documento do cabeçalho do template. Mande os bytes do arquivo no corpo, com o nome em…GETConsultar uma campanhaConsultar uma campanhaPATCHEditar campanhaSó rascunhos e campanhas agendadas podem ser editados. Editar uma campanha agendada a devolve para rascunho — ela precisa ser lançada de novo.DELApagar campanhaSó rascunhos podem ser apagados. Para as outras, use o arquivamento.POSTEstimar alcance e custoConfere a campanha inteira e calcula quem ela alcançaria agora: quantos contatos, quantos ficam de fora e por quê, o teto de destinatários, a cota do plano,…POSTLançar campanhaCongela o público e põe a campanha para enviar — agora, ou em scheduledAt (até um ano à frente). Mais de 60 segundos no futuro, a campanha fica scheduled;…POSTEnviar teste da campanhaManda o template da campanha para um número, na hora, fora da fila e das métricas. As variáveis vêm do contato contactId, se você mandar; senão, dos valores…POSTPausar campanhaPausar campanhaPOSTRetomar campanhaRetomar campanhaPOSTCancelar campanhaPara a campanha de vez. Quem ainda não recebeu fica como pulado, com o motivo canceled.POSTDuplicar campanhaUm rascunho novo com a mesma configuração, sem o agendamento.POSTArquivar campanhaTira a campanha da lista principal (ou devolve, com archived: false). Uma campanha em andamento precisa ser cancelada ou terminar antes.POSTReenviar destinatários sem respostaDestinatários unknown são envios em que a Meta nunca respondeu. Eles não são repetidos sozinhos: a pessoa pode já ter recebido. Esta chamada os devolve à…GETMétricas da campanhaContadores, taxas, cliques por botão, falhas agrupadas, custo por país, latência de entrega e leitura, e a qualidade do número e do template antes e agora.…GETSérie temporal da campanhaEnvios, entregas, leituras, cliques, falhas e respostas por faixa de 15 minutos — ou de 1 hora, quando a campanha passa de dois dias.GETListar destinatáriosListar destinatáriosGETExportar destinatários em CSVOs destinatários, com os mesmos filtros da listagem e sem paginação, num CSV com BOM UTF-8.