Consultar cuenta

GET

api

profile

getAccount

:instance

Consultar cuenta

curl --request GET \
  --url https://api.example.com/api/profile/getAccount/:instance \
  --header 'token: <token>'

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

fetch('https://api.example.com/api/profile/getAccount/:instance', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Auth: TokenAccount o TokenInstance • Rate limit: Global (100/min) • Idempotente: sí (solo lectura)

Descripción

Devuelve los datos de perfil de la propia cuenta conectada (foto, nombre, estado, JID, LID). Opcionalmente, consulta el perfil de otro número vía ?number=. Sin el parámetro, devuelve el perfil de la propia instancia.

Ejemplos

Cuenta propia

Sin el parámetro de query: devuelve el perfil de la instancia conectada (foto, nombre, estado, JID y LID). Una forma directa de verificar quién está conectado en esa sesión.

curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/profile/getAccount/${process.env.Instance_Name}`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/profile/getAccount/{os.environ['Instance_Name']}",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getAccount/"+os.Getenv("Instance_Name"), nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Otro número

Consulta el perfil público de un tercero por número (?number=5511988887777). Útil para verificar que el número existe en WhatsApp y obtener su foto / nombre / estado visibles públicamente.

curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=5511988887777" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/profile/getAccount/${process.env.Instance_Name}?number=5511988887777`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/profile/getAccount/{os.environ['Instance_Name']}?number=5511988887777",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getAccount/"+os.Getenv("Instance_Name")+"?number=5511988887777", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Por LID

Consulta el perfil usando un LID (@lid) en lugar de un número. Útil cuando el evento de origen solo expone el LID anónimo (en comunidades / canales más recientes de WhatsApp), sin el número telefónico correspondiente.

curl -X GET "https://ryzeapi.cloud/api/profile/getAccount/$Instance_Name?number=52399087550579@lid" \
  -H "token: $Token_Instance"

await fetch(`https://ryzeapi.cloud/api/profile/getAccount/${process.env.Instance_Name}?number=52399087550579@lid`, {
  method: "GET",
  headers: {
    "token": process.env.Token_Instance
  }
});

import os, requests

requests.get(
    f"https://ryzeapi.cloud/api/profile/getAccount/{os.environ['Instance_Name']}?number=52399087550579@lid",
    headers={
        "token": os.environ["Token_Instance"]
    }
)

package main

import (
    "net/http"
    "os"
)

func main() {
    req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/profile/getAccount/"+os.Getenv("Instance_Name")+"?number=52399087550579@lid", nil)
    req.Header.Set("token", os.Getenv("Token_Instance"))
    http.DefaultClient.Do(req)
}

Respuesta exitosa

Devuelve profile con los datos del destino: profilePicture (URL del CDN de WhatsApp, siempre presente, queda en null si la cuenta no tiene foto o si la consulta excedió el tiempo), profileName (push name o nombre comercial), profileStatus (texto “Acerca de”), phoneNumber (solo dígitos), jid (<número>@s.whatsapp.net) y lid (formato @lid, cuando está disponible). Todos los campos excepto profilePicture usan omitempty y pueden no aparecer si WhatsApp no devolvió ese dato.

200 OK

{
  "success": true,
  "message": "Profile information retrieved successfully",
  "profile": {
    "profilePicture": "https://pps.whatsapp.net/...",
    "profileName": "João Silva",
    "profileStatus": "Disponível",
    "phoneNumber": "5511999999999",
    "jid": "5511999999999@s.whatsapp.net",
    "lid": "199789077627112@lid"
  }
}

200 OK (sin foto)

{
  "success": true,
  "message": "Profile information retrieved successfully",
  "profile": {
    "profilePicture": null,
    "profileName": "Cliente Teste",
    "phoneNumber": "5511988887777",
    "jid": "5511988887777@s.whatsapp.net"
  }
}

Parámetros de ruta

string

requerido

Nombre de la instancia.

Cabeceras

string

requerido

TokenAccount o TokenInstance.

Query

string

Número (5511999999999, +5511999999999, 5511999999999@s.whatsapp.net) o LID (52399087550579@lid). Si se omite, devuelve el perfil de la propia instancia.

Notas

Para números BR (55...), el servicio prueba automáticamente variaciones con y sin el noveno dígito.
Saneamiento automático de +, -, (, ) y espacios: (11) 99999-9999 se vuelve 11999999999.
profilePicture es el único campo que siempre aparece (puede ser null); los demás usan omitempty.
La URL de la foto es temporal (CDN de WhatsApp). Si la búsqueda supera 10s, el campo regresa null.
Para tu propia cuenta, prefiere number="", pasar tu propio número devuelve los datos “como otros te ven”.

Errores

HTTP	Mensaje
400	`Number not found or not registered on WhatsApp`
400	`invalid LID format`
400	`Instance is not connected to WhatsApp`
500	`timeout ao buscar foto (>10s)`

Envoltorio:

{
  "success": false,
  "error": { "message": "Number not found or not registered on WhatsApp" }
}

Introducción

Instancia

Eventos

Mensajes

Llamadas

Grupos

Comunidades

Newsletter

Perfil

Chat

Chatwoot

Typebot

Observabilidad

Consultar cuenta

Descripción

Ejemplos

Cuenta propia

Otro número

Por LID

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores

​Descripción

​Ejemplos

​Cuenta propia

​Otro número

​Por LID

​Respuesta exitosa

​Parámetros de ruta

​Cabeceras

​Query

​Notas

​Errores

Descripción

Ejemplos

Cuenta propia

Otro número

Por LID

Respuesta exitosa

Parámetros de ruta

Cabeceras

Query

Notas

Errores