Skip to content
ZapSim

Referência Rápida

Referência Rápida — Endpoints Mais Usados

Section titled “Referência Rápida — Endpoints Mais Usados”

Autenticação

Section titled “Autenticação”
Authorization: Bearer {seu_token}

Mensagens

Section titled “Mensagens”
# Enviar mensagem de texto
POST /v2/api/external/{ApiID}
Body: { "number": "55...", "body": "texto" }


# Enviar arquivo
POST /v2/api/external/{ApiID}/url
Body: { "number": "55...", "mediaUrl": "https://...", "fileName": "arquivo.pdf" }

Tickets

Section titled “Tickets”
# Criar ticket
POST /v2/api/external/{ApiID}/createTicket
Body: { "contactId": N, "queueId": N }


# Fechar ticket
POST /v2/api/external/{ApiID}/updateticketinfo
Body: { "ticketId": N, "status": "closed" }


# Listar tickets abertos
GET /v2/api/external/{ApiID}/listTickets?status=open&pageNumber=1

Contatos

Section titled “Contatos”
# Buscar contato
POST /v2/api/external/{ApiID}/showcontact
Body: { "number": "55..." }


# Criar contato
POST /v2/api/external/{ApiID}/createContact
Body: { "name": "Nome", "number": "55..." }

Canais

Section titled “Canais”
# Listar canais
GET /v2/api/external/{ApiID}/listChannels


# Listar filas
GET /v2/api/external/{ApiID}/listQueues

Formato de Número

Section titled “Formato de Número”

Sempre use: DDI + DDD + número

Exemplo: 5511999999999 (Brasil, DDI=55, DDD=11, número=999999999)

Precisa de Ajuda?

Section titled “Precisa de Ajuda?”