Contacts

Buscar contatos similares

get

Pesquisa contatos similares conforme critérios enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

contact_idstringObrigatórioExample: contact_123

searchstringOpcionalExample: Maria

per_pagenumber · mín: 1OpcionalExample: 10

pagenumber · mín: 1OpcionalExample: 1

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

422

Erro de validação.

application/json

get

/v4/contacts/merge/similar

GET /api/v4/contacts/merge/similar?contact_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": true,
  "message": "Sucesso"
}

Vincular contatos (merge)

post

Processa a solicitação de vincular contatos e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/contacts/merge/link

POST /api/v4/contacts/merge/link HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "main_contact_id": "contact_1",
  "merge_contact_id": "contact_2"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

get

Retorna contatos relacionados conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

contact_idstringObrigatórioExample: contact_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/related

GET /api/v4/contacts/related?contact_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Desvincular contato

post

Processa a solicitação de desvincular contato e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/contacts/unmerge

POST /api/v4/contacts/unmerge HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28

{
  "contact_id": "contact_123"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Listar mídias do contato

get

Retorna mídias do contato conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

contact_idstringObrigatórioExample: contact_123

typestring · enumOpcionalExample: imagesValores possíveis:

limitnumber · mín: 5 · máx: 50OpcionalExample: 5

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/agent/historic/medias

GET /api/v4/agent/historic/medias?contact_id=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Listar grupos de contatos

get

Retorna grupos de contatos conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/groups

GET /api/v4/contacts/groups HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Criar grupo de contatos

post

Cria grupo de contatos com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/contacts/groups

POST /api/v4/contacts/groups HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "name": "VIP"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Detalhar grupo de contatos

get

Recupera os dados de grupo de contatos identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: group_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/groups/{id}

GET /api/v4/contacts/groups/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Atualizar grupo de contatos

put

Atualiza grupo de contatos conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/contacts/groups/{id}

PUT /api/v4/contacts/groups/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "name": "VIP"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Remover grupo de contatos

delete

Remove grupo de contatos identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/contacts/groups/{id}

DELETE /api/v4/contacts/groups/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Listar grupos do contato

get

Retorna grupos do contato conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

contact_idstringObrigatórioExample: contact_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/groups/contact/{contact_id}

GET /api/v4/contacts/groups/contact/{contact_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Listar campos adicionais de contato

get

Retorna campos adicionais de contato conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/fields

GET /api/v4/contacts/fields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Criar campo adicional de contato

post

Cria campo adicional de contato com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

post

/v4/contacts/fields

POST /api/v4/contacts/fields HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "Empresa"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Atualizar campo adicional de contato

put

Atualiza campo adicional de contato conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesanyOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

put

/v4/contacts/fields/{id}

PUT /api/v4/contacts/fields/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "name": "Empresa"
}

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Remover campo adicional de contato

delete

Remove campo adicional de contato identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/contacts/fields/{id}

DELETE /api/v4/contacts/fields/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Pesquisar contatos

get

Processa a solicitação de pesquisar contatos e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

querystringOpcionalExample: Maria

limitstring · enumOpcionalExample: trueValores possíveis:

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/search

GET /api/v4/contacts/search HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Contatos recentes

get

Processa a solicitação de contatos recentes e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

searchstringOpcionalExample: Jo

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts/recents

GET /api/v4/contacts/recents HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Listar contatos

get

Retorna contatos conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de consulta

namestringOpcional

emailstringOpcional

platformstringOpcional

platform_idstringOpcional

start_created_atstring · dateOpcional

end_created_atstring · dateOpcional

updated_atstring · dateOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

get

/v4/contacts

GET /api/v4/contacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Criar contato

post

Cria contato com os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

namestringOpcional

emailstringOpcional

numberintegerOpcional

groupstring[]Opcional

groupsstring[]Opcional

WhatsappstringOpcional

InstagramstringOpcional

TelegramstringOpcional

MessengerstringOpcional

InstagramDirectstringOpcional

GoogleChatstringOpcional

ChatWebstringOpcional

EmailstringOpcional

MercadoLivrestringOpcional

WhatsappBusinessstringOpcional

SignalstringOpcional

SMSstringOpcional

ddiintegerOpcional

default_languagestringOpcional

final_numberintegerOpcional

opt_instringOpcional

optin_gupshupbooleanOpcional

Respostas

201

Sucesso.

application/json

412

Pré-condição falhou.

application/json

500

Erro interno.

application/json

post

/v4/contacts

POST /api/v4/contacts HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "Maria",
  "Whatsapp": "558899999999",
  "email": "[email protected]"
}

{
  "status": true,
  "message": "Sucesso"
}

Detalhar contato

get

Recupera os dados de contato identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: contact_123

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

get

/v4/contacts/{id}

GET /api/v4/contacts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": true,
  "message": "Sucesso"
}

Atualizar contato

put

Atualiza os dados cadastrais do contato.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

namestringOpcional

emailstringOpcional

numberintegerOpcional

groupstring[]Opcional

groupsstring[]Opcional

WhatsappstringOpcional

InstagramstringOpcional

TelegramstringOpcional

MessengerstringOpcional

InstagramDirectstringOpcional

GoogleChatstringOpcional

ChatWebstringOpcional

EmailstringOpcional

MercadoLivrestringOpcional

WhatsappBusinessstringOpcional

SignalstringOpcional

SMSstringOpcional

ddiintegerOpcional

default_languagestringOpcional

final_numberintegerOpcional

opt_instringOpcional

optin_gupshupbooleanOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

422

Erro de validação.

application/json

put

/v4/contacts/{id}

PUT /api/v4/contacts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "name": "Maria",
  "email": "[email protected]"
}

{
  "status": true,
  "message": "Sucesso"
}

Remover contato

delete

Remove contato identificado no caminho.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

delete

/v4/contacts/{id}

DELETE /api/v4/contacts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Sucesso.

{
  "status": true,
  "message": "Sucesso"
}

Salvar anotação do contato

post

Processa a solicitação de salvar anotação do contato e retorna o resultado.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Corpo

_idstringObrigatório

observationstring · anulávelOpcional

agent_idstringObrigatório

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

post

/v4/contacts/annotation

POST /api/v4/contacts/annotation HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "_id": "contact_123",
  "observation": "Contato VIP",
  "agent_id": "agent_123"
}

{
  "status": true,
  "message": "Sucesso"
}

Atualizar campos adicionais do contato

put

Atualiza campos adicionais do contato conforme os dados enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatório

Corpo

Other propertiesstringOpcional

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

400

Requisição inválida.

application/json

put

/v4/contacts/update_fields/{id}

PUT /api/v4/contacts/update_fields/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "custom_field_1": "valor"
}

{
  "status": true,
  "message": "Sucesso"
}

Listar atendimentos do contato

get

Retorna atendimentos do contato conforme filtros enviados.

Autorizações

AuthorizationstringObrigatório

Token JWT no header Authorization.

Parâmetros de rota

idstringObrigatórioExample: contact_123

Parâmetros de consulta

platformstringObrigatórioExample: Whatsapp

Respostas

200

Sucesso.

application/json

Other propertiesanyOpcional

404

Não encontrado.

application/json

get

/v4/contacts/{id}/attendances

GET /api/v4/contacts/{id}/attendances?platform=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "status": true,
  "message": "Sucesso"
}

AnteriorHSM PróximoAdmin

Atualizado há 1 mês

Isto foi útil?

Boa tarde

hashtagBuscar contatos similares

hashtagVincular contatos (merge)

hashtagListar contatos relacionados

hashtagDesvincular contato

hashtagListar mídias do contato

hashtagListar grupos de contatos

hashtagCriar grupo de contatos

hashtagDetalhar grupo de contatos

hashtagAtualizar grupo de contatos

hashtagRemover grupo de contatos

hashtagListar grupos do contato

hashtagListar campos adicionais de contato

hashtagCriar campo adicional de contato

hashtagAtualizar campo adicional de contato

hashtagRemover campo adicional de contato

hashtagPesquisar contatos

hashtagContatos recentes

hashtagListar contatos

hashtagCriar contato

hashtagDetalhar contato

hashtagAtualizar contato

hashtagRemover contato

hashtagSalvar anotação do contato

hashtagAtualizar campos adicionais do contato

hashtagListar atendimentos do contato

Buscar contatos similares

Vincular contatos (merge)

Listar contatos relacionados

Desvincular contato

Listar mídias do contato

Listar grupos de contatos

Criar grupo de contatos

Detalhar grupo de contatos

Atualizar grupo de contatos

Remover grupo de contatos

Listar grupos do contato

Listar campos adicionais de contato

Criar campo adicional de contato

Atualizar campo adicional de contato

Remover campo adicional de contato

Pesquisar contatos

Contatos recentes

Listar contatos

Criar contato

Detalhar contato

Atualizar contato

Remover contato

Salvar anotação do contato

Atualizar campos adicionais do contato

Listar atendimentos do contato