logo

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

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/phone-number/{waba}/{phone_number}/call-settings
MétodoPOST
Tipoapplication/json

Encabezados

NombreDescripciónTipoRequerimientos
AuthorizationToken de Autenticación devuelto por el servicio tokenStringObligatorio
Content-Typeapplication/jsonStringObligatorio

Parámetros

NombreDescripciónTipoRequerimientos
wabaWhatsApp Business Account IdStringObligatorio
phone_numberNúmero de teléfono a configurarStringObligatorio

Cuerpo

NombreDescripciónTipoRequerimientos
statusEstado del servicio de llamadas. Valores: ENABLED o DISABLEDStringOpcional
call_icon_visibilityControla la visibilidad del ícono de llamada en la interfaz del usuario. Valores: DEFAULT o DISABLE_ALLStringOpcional
callback_permission_statusPermite o restringe las llamadas de retorno por parte del usuario. Valores: ENABLED o DISABLEDStringOpcional
call_hoursConfiguración de horarios de operaciónObjeto call_hoursOpcional

Objeto call hours

NombreDescripciónTipoRequerimientos
statusHabilita o deshabilita el control de horarios. Valores: ENABLED y DISABLEDStringOpcional
timezone_idZona horaria del negocio (por ejemplo America/Mexico_City)StringObligatorio si status es ENABLED
weekly_operating_hoursLista de días y horarios de atenciónArray objeto weekly_operating_hoursOpcional
holiday_scheduleFechas 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 fechasArray objeto holiday_scheduleOpcional

Objeto weekly operating hours

NombreDescripciónTipoRequerimientos
day_of_weekDía de la semana. Valores: "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"StringObligatorio
open_timeHora de apertura. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. mInteger
  • Obligatorio
  • Se permite un máximo de 2 entradas por día de la semana
  • La hora de apertura debe ser anterior a la hora de cierre
  • No se permiten participaciones simultáneas
close_timeHora de cierre. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. mInteger
  • Obligatorio
  • Se permite un máximo de 2 participaciones por día de la semana
  • La hora de apertura debe ser anterior a la hora de cierre
  • No se permiten participaciones simultáneas

Objeto holiday shedule

NombreDescripciónTipoRequerimientos
dateFecha donde se van a anular las llamadasStringObligatorio
open_timeHora de apertura. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. mInteger
  • Obligatorio
  • Se permite un máximo de 2 entradas por día de la semana
  • La hora de apertura debe ser anterior a la hora de cierre
  • No se permiten participaciones simultáneas
close_timeHora de cierre. Se muestran en formato de 24 horas, por ejemplo, "1130" = 11:30 a. mInteger
  • Obligatorio
  • Se permite un máximo de 2 participaciones por día de la semana
  • La hora de apertura debe ser anterior a la hora de cierre
  • No se permiten participaciones simultáneas

Respuesta

NombreDescripciónTipo
successDescribe si la operación fue exitosa o fallidaBoolean

Ejemplo respuesta

{
"success": true
}

Obtener ajustes de llamada

Obtener los ajustes de llamadas de WhatsApp Business Calling API

Petición

URLhttps://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/phone-number/{waba}/{phone_number}/call-settings
MétodoGET

Encabezados

NombreDescripciónTipoRequerimientos
AuthorizationToken de Autenticación devuelto por el servicio tokenStringObligatorio
Content-Typeapplication/jsonStringObligatorio

Parámetros

NombreDescripciónTipoRequerimientos
wabaWhatsApp Business Account IdStringObligatorio
phone_numberNúmero de teléfono a configurarStringObligatorio

Respuesta

NombreDescripciónTipo
statusEstado del servicio de llamadasString
call_icon_visibilityControla la visibilidad del ícono de llamada en la interfaz del usuarioString
callback_permission_statusPermite o restringe las llamadas de retorno por parte del usuarioString
call_hoursConfiguración de horarios de operaciónObjeto call_hours

Objeto call hours

NombreDescripciónTipo
statusHabilita o deshabilita el control de horariosString
timezone_idZona horaria del negocio (por ejemplo America/Mexico_City)String
weekly_operating_hoursLista de días y horarios de atenciónArray objeto weekly_operating_hours
holiday_scheduleFechas especiales no laborablesArray objeto holiday_schedule
Whatsapp — Anterior
Permisos de llamada de usuario
Siguiente — Whatsapp
Operaciones de negocio durante la llamada