Ir al contenido

Referencia: Contactos ​

Generada desde el contrato OpenAPI

Esta referencia se genera directamente del contrato de la API, por lo que sus descripciones están en inglés. Puedes descargarlo en openapi.json. Las guías explican cómo usar estos endpoints.

Check which phones have WhatsApp​

POST
/instances/{instance}/contacts/check

Asks WhatsApp, through the connected number, which of up to 50 phones have WhatsApp, so you only write to numbers that can receive it. One answer per phone, in the order given (duplicates once), each phone normalized to digits. Every phone counts against the instance's daily quota (Developer Trial 30, paid plan 1,000, reset at 00:00 UTC); a batch that does not fit is refused whole with CONTACT_CHECK_LIMIT and Retry-After, and checks WhatsApp could not answer are not counted. Not billed as messages.

Autorizaciones​

bearerAuth

An API key created in the dashboard (Authorization: Bearer ). The scopes listed on each operation must be granted to the key: instances:read, instances:write, messages:read, messages:send, webhooks:read, webhooks:write.

Tipo
HTTP (bearer)

Cuerpo de la petición​

application/json
JSON
{
  
"phones": [
  
  
"string"
  
]
}

Respuestas​

Which phones have WhatsApp, and what is left of today's quota.

application/json
JSON
{
  
"data": {
  
  
"results": [
  
  
  
{
  
  
  
  
"phone": "5215500000000",
  
  
  
  
"exists": true
  
  
  
}
  
  
],
  
  
"daily_limit": 0,
  
  
"remaining_today": 0
  
}
}

Ejemplos​


Show typing or recording in a chat​

POST
/instances/{instance}/presence

Shows "typing…" (typing) or "recording audio…" (recording) in one chat, a direct chat by phone or a group, or clears it (paused). WhatsApp clears it by itself after a few seconds, so send it again while you keep writing. Nothing is stored, billed or announced by webhook. The instance must be connected.

Autorizaciones​

bearerAuth

An API key created in the dashboard (Authorization: Bearer ). The scopes listed on each operation must be granted to the key: instances:read, instances:write, messages:read, messages:send, webhooks:read, webhooks:write.

Tipo
HTTP (bearer)

Cuerpo de la petición​

application/json
JSON
{
  
"phone": "string",
  
"group": "string",
  
"state": "string"
}

Respuestas​

The presence was shown (or cleared).

application/json
JSON
{
  
"data": {
  
  
"state": "string"
  
}
}

Ejemplos​


Get a contact's profile​

GET
/instances/{instance}/contacts/{phone}

What WhatsApp shows of a phone, asked through a connected instance - whether it has WhatsApp, its "about", its business profile (business accounts) and whether it shows a profile picture (picture_url, served through ZAPPIO). Anything the contact hides by privacy is null. name is the contact's WhatsApp name as ZAPPIO last saw it in a chat with this number (WhatsApp does not answer it). Each call spends 1 of the instance's daily phone checks.

Autorizaciones​

bearerAuth

An API key created in the dashboard (Authorization: Bearer ). The scopes listed on each operation must be granted to the key: instances:read, instances:write, messages:read, messages:send, webhooks:read, webhooks:write.

Tipo
HTTP (bearer)

Respuestas​

The profile.

application/json
JSON
{
  
"data": {
  
  
"phone": "string",
  
  
"exists": true,
  
  
"name": "string",
  
  
"about": "string",
  
  
"about_updated_at": "string",
  
  
"business": {
  
  
  
"category": "string",
  
  
  
"description": "string",
  
  
  
"email": "string",
  
  
  
"website": "string",
  
  
  
"address": "string"
  
  
},
  
  
"picture_url": "string",
  
  
"daily_limit": 0,
  
  
"remaining_today": 0
  
}
}

Ejemplos​


Get a contact's profile picture​

GET
/instances/{instance}/contacts/{phone}/picture

The profile picture of a phone, through ZAPPIO (never a WhatsApp link, which expires). ZAPPIO keeps it 24 hours - asking again within that time does not ask WhatsApp nor spend a check; otherwise it spends 1 of the instance's daily phone checks. 404 PICTURE_NOT_AVAILABLE when the phone has no picture, hides it, or has no WhatsApp (also kept 24 hours).

Autorizaciones​

bearerAuth

An API key created in the dashboard (Authorization: Bearer ). The scopes listed on each operation must be granted to the key: instances:read, instances:write, messages:read, messages:send, webhooks:read, webhooks:write.

Tipo
HTTP (bearer)

Respuestas​

The image (image/jpeg, image/png or image/webp).

image/jpeg

Ejemplos​