Referencia (endpoints)Números

Editar un número

Sirve para cambiar los datos de un número: su alias, su color, su imagen o tu external_reference. Lo que no mandas no cambia.

PUT
/devices/{device}

Escritura · requiere Números de WhatsApp → Editar.

Cambia los datos del número, por ejemplo alias, color, image, tu external_reference. Los campos que no envíes no cambian.

Conectar un número oficial con esta ruta (mandar el code del alta de Meta, con waba_id y phone_number_id) da el control de un WhatsApp: con una clave pide además Números de WhatsApp → Crear, conectar y borrar, y sin ese permiso responde 403 permission_denied sin tocar nada. waba_id y phone_number_id sin code no conectan nada y no lo piden.

Autorización

http
headerAuthorizationBearer <clave>

Parámetros de la ruta

device*string

The device ID

Patrón^dev_[A-Za-z0-9]{23}$

Cuerpo del pedido

application/json
  1. body
alias?string|null
color?string|null
image?|
Formatouri
number?string|null
first_conecction_at?|
Formatodate-time
is_business?boolean
phone_number_id?string
waba_id?string
code?string
whatsApp_business_app?boolean
capi_consent?boolean

Solo en un número oficial, al conectarlo: el consentimiento para activar la Conversions API de Meta. Sin efecto si la Conversions API no está habilitada para la cuenta.

external_reference?|

Tu propia referencia para este número (por ejemplo, el id de tu cliente). Con null se borra. Se guarda solo si la edición sale bien.

Largolength <= 255

Cuerpo de la respuesta

El número editado.

application/json
  1. response
id*string

Id opaco: un texto que empieza con dev_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^dev_[A-Za-z0-9]{23}$
alias*string
image*string
color*string
number*string
normalized_number*string

number en formato internacional normalizado, para reconocer el mismo teléfono conectado por QR y como oficial. null mientras el número no está conectado.

first_conecction_at*string
user_id*string

Id opaco: un texto que empieza con usr_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^usr_[A-Za-z0-9]{23}$
provider*WhatsAppProviderEnum
Valor en1234
waba_id*string
phone_number_id*|

El identificador del número en Meta (phone_number_id) de un número oficial; null en los números por QR.

whatsapp_username*string|null
is_business*integer
connected*integer
active*integer|null
health*string

El resumen del estado de salud de un número oficial, el mismo health de GET devices/{device}/health. null si el número no es oficial.

number_key*|

La identidad del teléfono de este número: se mantiene aunque se desconecte, y es el último teléfono para mostrar cuando number está vacío.

number_key_confirmed*string

true cuando ese teléfono ya se conectó en este número; false si number_key es solo el teléfono que se espera conectar.

is_coexistence*boolean
slot_state*string

El estado del lugar del plan que ocupa: held (tiene o tuvo un teléfono), pending (todavía sin teléfono, pero ya ocupa un lugar), reserved (vacío y reservado por un alta en curso) o free (vacío, no ocupa lugar).

pool_suspended*boolean

Si el número está suspendido por el plan (por ejemplo, porque el plan tiene menos lugares que números); pool_suspension_reason dice por qué, pool_keep si la cuenta eligió conservarlo y qr_allowed si se puede conectar por QR.

pool_suspension_reason*string|null
pool_keep*boolean
qr_allowed*boolean
can_change_to_meta*boolean

true si este número por QR puede pasar a ser oficial en el mismo lugar, con el alta oficial del mismo teléfono.

connected_by_user_id*|

Quién de la cuenta hizo la conexión actual (connected_by_name es su nombre), o null si no se sabe; abilities dice qué puede hacer con este número quien llama. Id opaco: un texto que empieza con usr_. Se usa tal como llega; no se arma ni se interpreta.

Patrón^usr_[A-Za-z0-9]{23}$
connected_by_name*string|null
abilities*
capabilities*

Qué se puede hacer con este número por la API, según cómo está conectado.

connection*|

Cómo está conectado el número: qr, coexistence, dedicated, o null si todavía no se sabe. external_reference es tu propia referencia.

Valor en"qr""coexistence""dedicated"null
external_reference*string|null
overloaded*boolean

El número está sobrecargado (muchos grupos / conversaciones); false si nunca se evaluó.

overloaded_computed_at*|
Formatodate-time
overloaded_groups_count*|

En la última evaluación, cuántos grupos tenía el número; null si nunca se evaluó.

overloaded_one_to_one_count*integer|null
overloaded_has_pending_broadcast*boolean
overloaded_has_active_flow*boolean
overloaded_has_active_ai_agent*boolean
overloaded_alert_level*string

El evento de número sobrecargado: loud (sin descartar), latent (descartado en este episodio) o none (no está sobrecargado o nunca se evaluó).

overloaded_dismissed_at*|
Formatodate-time
sync_all_groups*boolean

true si el dueño activó "Sincronizar todos mis grupos y mensajes" para este número.

curl -X PUT "https://example.com/devices/dev_Ac7Ku7iIZDXJTjdCu0UB1mX" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "dev_Ac7Ku7iIZDXJTjdCu0UB1mX",  "alias": "string",  "image": "string",  "color": "string",  "number": "string",  "normalized_number": "string",  "first_conecction_at": "string",  "user_id": "usr_AdaVCroxOubVJxQ0exvtano",  "provider": 1,  "waba_id": "string",  "phone_number_id": "string",  "whatsapp_username": "string",  "is_business": 0,  "connected": 0,  "active": 0,  "health": "string",  "number_key": "string",  "number_key_confirmed": "string",  "is_coexistence": true,  "slot_state": "string",  "pool_suspended": true,  "pool_suspension_reason": "string",  "pool_keep": true,  "qr_allowed": true,  "can_change_to_meta": true,  "connected_by_user_id": "usr_AdaVCroxOubVJxQ0exvtano",  "connected_by_name": "string",  "abilities": {    "connect": true,    "disconnect": true,    "delete": true,    "update": true  },  "capabilities": {    "messages": {      "text": true,      "media": true,      "buttons": true,      "lists": true,      "templates": true,      "location": true,      "voice_note": true,      "polls": true,      "events": true,      "contact_card": true,      "reactions": true    },    "groups": {      "create": true,      "add_participants": true,      "remove_participants": true,      "admins": true,      "photo": true,      "settings": true,      "invite_link": true,      "send": true,      "join_requests": true    },    "statuses": [      "string"    ]  },  "connection": "qr",  "external_reference": "string",  "overloaded": true,  "overloaded_computed_at": "2019-08-24T14:15:22Z",  "overloaded_groups_count": 0,  "overloaded_one_to_one_count": 0,  "overloaded_has_pending_broadcast": true,  "overloaded_has_active_flow": true,  "overloaded_has_active_ai_agent": true,  "overloaded_alert_level": "string",  "overloaded_dismissed_at": "2019-08-24T14:15:22Z",  "sync_all_groups": true}

Esto es lo que se copia para tu IA

Cargando…