Referência da API
Uma página por área do contrato público, gerada do openapi.json: o que cada rota recebe, o que devolve e um curl para começar.
- 125 operações
- URL base
https://api.messages.ccxcompany.co
O texto técnico abaixo vem do contrato público, o openapi.json, no idioma em que o contrato foi escrito.
As áreas do contrato
Cada área abre com uma introdução e lista as operações, com parâmetros, corpo, respostas e o exemplo em curl.
Mensagens de WhatsApp
Envie mensagens de WhatsApp (texto, template, mídia ou flow) por um número da sua conta, liste o histórico com filtros e consulte o status de cada envio.
GET/messagesPOST/messagesGET/messages/{id}3 operaçõesVer a referênciaSMS
Envie SMS com Idempotency-Key, calcule segmentos e preço antes de enviar, consulte cada mensagem e leia as respostas (MO) que os destinatários mandaram.
GET/v2/sms/messagesPOST/v2/sms/messagesPOST/v2/sms/preview6 operaçõesVer a referênciaRCS
Envie mensagens RCS com fallback para SMS, liste os envios do ambiente da sua chave e consulte por qual canal cada mensagem de fato saiu para o aparelho.
GET/v2/rcs/messagesPOST/v2/rcs/messagesGET/v2/rcs/messages/{id}3 operaçõesVer a referênciaE-mail
Envie e-mails com Idempotency-Key obrigatória, liste os envios do ambiente da sua chave e acompanhe o status de cada um: entregue, bounce ou reclamação.
GET/v2/email/messagesPOST/v2/email/messagesGET/v2/email/messages/{id}3 operaçõesVer a referênciaNotificações push
Registre os aparelhos do seu app, dispare push para um segmento ou para aparelhos específicos, veja alcance e custo antes e conte entregas e aberturas.
POST/v2/push/tokensPOST/v2/push/tokens/opt-outPOST/v2/push/dispatches/{id}/opened7 operaçõesVer a referênciaMídia
Suba imagens, áudios, vídeos e documentos para a Meta e receba um mediaId reutilizável nos envios, ou baixe a mídia que chegou numa mensagem recebida.
POST/numbers/{numberId}/mediaPOST/numbers/{numberId}/media/binaryGET/messages/{id}/media3 operaçõesVer a referênciaTemplates de WhatsApp
Liste os templates de WhatsApp da organização com o id, o idioma e as variáveis de cada um, leia um template pelo id e crie templates novos em rascunho.
GET/v2/templatesPOST/v2/templatesGET/v2/templates/{id}3 operaçõesVer a referênciaFlows do WhatsApp
Consulte os WhatsApp Flows da sua organização, com o flowJson de cada um, para enviar formulários e telas interativas pela API de mensagens de WhatsApp.
GET/v2/flowsGET/v2/flows/{id}2 operaçõesVer a referênciaNúmeros de WhatsApp
Liste os números de WhatsApp da organização, veja status, qualidade e limite de cada um direto na Meta e acompanhe o volume de envios por período.
GET/numbersGET/numbers/{id}GET/numbers/{id}/health5 operaçõesVer a referênciaWebhooks
Assine endpoints para receber eventos assinados com HMAC, valide a URL antes de assinar, pause ou apague uma assinatura e troque o segredo quando quiser.
GET/webhooksPOST/webhooksPOST/webhooks/validate7 operaçõesVer a referênciaContatos
Crie, atualize, importe em lote e apague contatos, registre quem pediu para não receber mensagens e consulte os campos disponíveis na sua base.
GET/contactsPOST/contactsGET/contacts/{id}8 operaçõesVer a referênciaListas estáticas
Mantenha listas estáticas de contatos pelo seu sistema: crie, renomeie e apague listas e adicione, substitua ou remova até 50 mil membros por chamada.
GET/v2/listsPOST/v2/listsGET/v2/lists/{id}8 operaçõesVer a referênciaSegmentos
Crie segmentos dinâmicos por tag, atributo, opt-in, canal ou última interação, veja a contagem e uma amostra antes de salvar e edite os já salvos.
GET/v2/segmentsPOST/v2/segmentsGET/v2/segments/{segmentId}6 operaçõesVer a referênciaAtributos de contato
Defina os atributos personalizados dos contatos da organização, com tipo e rótulo, e leia o dicionário que valida o campo attributes de cada contato.
GET/v2/organizations/me/custom-attribute-defsPUT/v2/organizations/me/custom-attribute-defs2 operaçõesVer a referênciaEventos do cliente
Registre compras e outras conversões do seu sistema, atribuídas à última mensagem enviada ao contato na janela (padrão de 7 dias), e liste os eventos.
GET/v2/eventsPOST/v2/events2 operaçõesVer a referênciaJornadas
Crie jornadas em rascunho, teste com um contato, ative, pause ou arquive, ponha contatos nelas e acompanhe as execuções e os números de cada passo.
GET/v2/journeysPOST/v2/journeysGET/v2/journeys/{id}15 operaçõesVer a referênciaCRM e funis de venda
Empresas, funis, etapas e cards: importe em lote, mova cards entre etapas, marque ganho ou perda e registre atividades, campos e arquivos de cada card.
GET/v2/companiesPOST/v2/companiesPOST/v2/companies/import35 operaçõesVer a referênciaImportação de conversas
Traga o histórico de conversas de outra ferramenta para o inbox, até 200 por chamada, sem enviar nenhuma mensagem, sem cobrança e sem duplicar conversas.
POST/conversations/import1 operaçãoVer a referênciaExportação de mensagens
Exporte as mensagens de WhatsApp, SMS, RCS e e-mail de um período de até 31 dias, com paginação por cursor e os metadados de correlação de cada envio.
GET/v2/exports/whatsappGET/v2/exports/smsGET/v2/exports/rcs4 operaçõesVer a referênciaSaldo da carteira
Consulte o saldo da carteira no ambiente da sua chave, de teste ou de produção, e o valor reservado em envios em andamento, para alarmar antes de faltar.
GET/wallet1 operaçãoVer a referênciaSaúde da plataforma
Endpoint público e sem autenticação para o seu monitor: diz numa só consulta se a plataforma está no ar e se o provedor de SMS está respondendo agora.
GET/health/deep1 operaçãoVer a referência
Travou em alguma rota? Fale com quem mantém a API.
Criando a conta pelo site, você ganha R$ 10 de crédito de teste.