Ajustes de llamada
Last update: 17 minutes ago by Irais Aguirre
Configurar ajustes de llamada
Configurar los ajustes de llamadas de WhatsApp Business Calling API.
Petición
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/phone-number/{waba}/{phone_number}/call-settings |
| Método | POST |
| Tipo | application/json |
Encabezados
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| Authorization | Token de Autenticación devuelto por el servicio token | String | Obligatorio |
| Content-Type | application/json | String | Obligatorio |
Parámetros
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| waba | WhatsApp Business Account Id | String | Obligatorio |
| phone_number | Número de teléfono a configurar | String | Obligatorio |
Cuerpo
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| status | Estado del servicio de llamadas. Valores: ENABLED o DISABLED | String | Opcional |
| call_icon_visibility | Controla la visibilidad del ícono de llamada en la interfaz del usuario. Valores: DEFAULT o DISABLE_ALL | String | Opcional |
| callback_permission_status | Permite o restringe las llamadas de retorno por parte del usuario. Valores: ENABLED o DISABLED | String | Opcional |
| call_hours | Configuración de horarios de operación | Objeto call_hours | Opcional |
Objeto call hours
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| status | Habilita o deshabilita el control de horarios. Valores: ENABLED y DISABLED | String | Opcional |
| timezone_id | Zona horaria del negocio (por ejemplo America/Mexico_City) | String | Obligatorio si status es ENABLED |
| weekly_operating_hours | Lista de días y horarios de atención | Array objeto weekly_operating_hours | Opcional |
| holiday_schedule | Fechas especiales no laborables. Si se actualiza la configuración del número de teléfono y no se incluye el parámetro holiday_schedule, el holiday_schedule existente se eliminará y se reemplazará por un calendario vacío. Se puede especificar hasta 20 fechas | Array objeto holiday_schedule | Opcional |
Objeto weekly operating hours
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| day_of_week | Día de la semana. Valores: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" | String | Obligatorio |
| open_time | Hora de apertura. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. m | Integer |
|
| close_time | Hora de cierre. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. m | Integer |
|
Objeto holiday shedule
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| date | Fecha donde se van a anular las llamadas | String | Obligatorio |
| open_time | Hora de apertura. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. m | Integer |
|
| close_time | Hora de cierre. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. m | Integer |
|
Respuesta
| Nombre | Descripción | Tipo |
|---|---|---|
| success | Describe si la operación fue exitosa o fallida | Boolean |
Ejemplo respuesta
{"success": true}
Obtener ajustes de llamada
Obtener los ajustes de llamadas de WhatsApp Business Calling API
Petición
| URL | https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/phone-number/{waba}/{phone_number}/call-settings |
| Método | GET |
Encabezados
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| Authorization | Token de Autenticación devuelto por el servicio token | String | Obligatorio |
| Content-Type | application/json | String | Obligatorio |
Parámetros
| Nombre | Descripción | Tipo | Requerimientos |
|---|---|---|---|
| waba | WhatsApp Business Account Id | String | Obligatorio |
| phone_number | Número de teléfono a configurar | String | Obligatorio |
Respuesta
| Nombre | Descripción | Tipo |
|---|---|---|
| status | Estado del servicio de llamadas | String |
| call_icon_visibility | Controla la visibilidad del ícono de llamada en la interfaz del usuario | String |
| callback_permission_status | Permite o restringe las llamadas de retorno por parte del usuario | String |
| call_hours | Configuración de horarios de operación | Objeto call_hours |
Objeto call hours
| Nombre | Descripción | Tipo |
|---|---|---|
| status | Habilita o deshabilita el control de horarios | String |
| timezone_id | Zona horaria del negocio (por ejemplo America/Mexico_City) | String |
| weekly_operating_hours | Lista de días y horarios de atención | Array objeto weekly_operating_hours |
| holiday_schedule | Fechas especiales no laborables | Array objeto holiday_schedule |
