Consultar um contato

GET

api

contacts

{contactId}

Get a contact

curl --request GET \
  --url https://levios.app/api/v1/contacts/{contactId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://levios.app/api/v1/contacts/{contactId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": {
    "code": "api_invalid_content_length",
    "message": "Invalid Content-Length.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unauthorized",
    "message": "Authentication required.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_account_not_granted",
    "message": "This credential is not authorized for the request.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_not_found",
    "message": "The requested contact was not found.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_body_too_large",
    "message": "The JSON request body exceeds 1 MiB.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unsupported_media_type",
    "message": "Content-Type must be application/json.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_invalid_cursor",
    "message": "The contact timeline cursor is invalid.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_internal_error",
    "message": "The request could not be completed.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_account_resolution_unavailable",
    "message": "The reachable account set could not be read.",
    "correlation_id": "<string>"
  }
}

Este endpoint retorna o registro completo de um contato e uma página de sua linha do tempo de atividades. Use o UUID do contato obtido em Listar contatos como contactId.

Acesso

Sua chave de API precisa do escopo contacts:read_pii. O parâmetro de consulta account_id deve identificar uma conta do Instagram que a chave possa acessar, e contactId deve pertencer a essa conta. Este endpoint inclui informações de identificação pessoal (PII) e passa por auditoria. Se a API não conseguir registrar a entrada de auditoria obrigatória, ela falhará sem retornar o contato.

Dados retornados

O objeto contact contém todos os campos retornados pela lista de contatos, incluindo email, phone, biography, website, tags, attributes, instagram_profile_url e send_instagram_dm_url. Ele também contém um objeto timeline. Consulte Listar contatos para ver todos os grupos de campos e os significados dos enums. O array timeline.items pode conter estes tipos de evento:

first_contact: a levios registrou a primeira atividade do contato.
dm_sent: uma mensagem direta foi enviada.
dm_failed: o envio de uma mensagem direta falhou.
tag_applied: uma tag foi adicionada ao contato.
attribute_captured: um atributo do contato foi capturado.

Cada item da linha do tempo inclui id, type e timestamp.

Exemplo de requisição

curl --get \
  --url "https://levios.app/api/v1/contacts/${LEVIOS_CONTACT_ID}" \
  --header "Authorization: Bearer ${LEVIOS_API_KEY}" \
  --data-urlencode "account_id=${LEVIOS_ACCOUNT_ID}" \
  --data-urlencode 'timeline_limit=25'

Paginação da linha do tempo

Defina timeline_limit com um valor de 1 a 50. Quando contact.timeline.next_cursor não for null, envie-o sem alterações como timeline_cursor junto com o mesmo account_id e contactId. Pare quando o cursor for null. Trate os cursores da linha do tempo como opacos. Não reutilize um cursor para outro contato ou outra conta. Como esta resposta inclui dados pessoais, evite registrar o payload completo em logs, eventos de analytics ou relatórios de erro.

Autorizações

Authorization

string

header

obrigatório

Levios API key sent as a Bearer token.

Parâmetros de caminho

contactId

string<uuid>

obrigatório

Parâmetros de consulta

account_id

string<uuid>

obrigatório

timeline_cursor

string

Required string length: 1 - 2048

timeline_limit

string

Resposta

Successful response.

Get a contact

curl --request GET \
  --url https://levios.app/api/v1/contacts/{contactId} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://levios.app/api/v1/contacts/{contactId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "error": {
    "code": "api_invalid_content_length",
    "message": "Invalid Content-Length.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unauthorized",
    "message": "Authentication required.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_account_not_granted",
    "message": "This credential is not authorized for the request.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_not_found",
    "message": "The requested contact was not found.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_body_too_large",
    "message": "The JSON request body exceeds 1 MiB.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unsupported_media_type",
    "message": "Content-Type must be application/json.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_invalid_cursor",
    "message": "The contact timeline cursor is invalid.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_internal_error",
    "message": "The request could not be completed.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_account_resolution_unavailable",
    "message": "The reachable account set could not be read.",
    "correlation_id": "<string>"
  }
}

Referência

Automações

Contas

Contatos

Tags de contato

Métricas

Consultar um contato

Acesso

Dados retornados

Exemplo de requisição

Paginação da linha do tempo

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta

​Acesso

​Dados retornados

​Exemplo de requisição

​Paginação da linha do tempo

Autorizações

Parâmetros de caminho

Parâmetros de consulta

Resposta

Acesso

Dados retornados

Exemplo de requisição

Paginação da linha do tempo