conversas-v2-contacts

Obter contato por telefone

Obter contato por telefone. Os campos retornados em data estão definidos no schema da resposta.

get/v2/contacts/{cel_phone}/exists

Request

  • Base URL
    https://api.tallos.com.br
  • URL
    https://api.tallos.com.br/v2/contacts/{cel_phone}/exists
  • Auth
    HTTP bearer

Path parameters

cel_phonestring required

Número do telefone do contato no formato E.164.

Formato: [CC][NDC][SN]

  • CC = código do país
  • NDC = DDD (código de área)
  • SN = número do assinante

Exemplo (Brasil): 5511999998888

Query parameters

channel'email' | 'instagram' | 'megasac' | 'messenger' | 'telegram' | 'whatsapp'

Canal de comunicação.

country_codeinteger

Código do país.

Response

Contato encontrado

messagestring

Mensagem de sucesso.

Example response

{
  "data": {
    "_id": "507f191e810c19729de860ea",
    "address": {
      "city": "Fortaleza",
      "complement": "5º andar",
      "country": "Brazil",
      "district": "Centro",
      "number": "1234",
      "state": "Ceará",
      "street": "Av. Principal",
      "zip_code": "12345-600"
    },
    "customizable_field": [
      {
        "info": "123456",
        "label": "CRM"
      }
    ],
    "employee": "507f191e810c19729de860ea"
  },
  "message": "Contact already exists"
}

Changes

No recorded changes to this operation across all 1 revision of this API.