extension_add
Definición¶
Da de alta una nueva extensión en al centralita.
Más información sobre los distintos parámetros en la documentación oficial de FreeSWITCH.
El modificar parámetros erróneos en los opciones puede dar lugar a un mal funcionamiento de la extensión.
Parámetros de Entrada (POST)¶
- domain_uuid (obligatorio): UUID del dominio donde se dará de alta el agente
- extension (obligatorio): Número de la extensión
-
outbound_caller_id_number (obligatorio): Numeración a mostrar en llamadas externas
-
range (opcional): Numérico, dará de alta tantas extensiones consecutivas como se indique (para altas masivas por ejemplo)
- user_context (opcional): Contexto de la extensión dentro del directorio de FS. Por defecto es el dominio.
- number_alias (opcional): Alias numérico en caso de que la extensión sea alfanumérica.
- password (opcional): Password SIP de la extensión
- accountcode (opcional): Código para poder hacer búsquedas avanzadas/accuounting. Por defecto es el dominio.
- effective_caller_id_name (opcional): Nombre a mostrar en las llamadas internas
- effective_caller_id_number (opcional): Número a mostrar en las llamadas internas. Por defecto la propia extensión
- outbound_caller_id_name (opcional): Nombre a mostrar en las llamadas externas
- emergency_caller_id_name (opcional): Nombre a mostrar en las llamadas a servicios de emergencia (no utilizado)
- emergency_caller_id_number (opcional): Número a mostrar en las llamadas a servicios de emergencia (no utilizado)
- directory_full_name (opcional): Nombre de la extensión en el directorio
- directory_visible (opcional): Nombre visible en el direcotorio. Opciones posibles:
true
yfalse
, por defectotrue
- directory_exten_visible (opcional): Nombre visible en el direcotorio. Opciones posibles:
true
yfalse
, por defectotrue
- limit_max (opcional): Máximo nº de llamadas salientes. Por defecto
5
- limit_destination (opcional): Dialstring de donde irá la llamada en caso de de máximo de llamadas salientes, por defecto `error/user_busy``
- device_uuid (opcional): UUID del dispositivo físico si lo tuviese para la autoprovisión
- device_line (opcional): Nº de línea del dispositivo físico si lo tuviese para la autoprovisión
- voicemail_password (opcional): Contraseña del buzón de voz
- voicemail_enabled (opcional): Activación del buzón de voz. Posibles opciones
true
yfalse
, por defectofalse
- voicemail_mail_to (opcional): Dirección de email donde se enviaría el mensaje del buzón de voz
- voicemail_file (opcional): Modo de envío del email. Opciones posibles
attach
ylink
. Por defectoattach
- voicemail_local_after_email (opcional): Guardado del mensaje del buzón de voz tras su envío. Opciones posibles:
true
yfalse
, por defectotrue
- missed_call_app (opcional): Modo de envío del mensaje llamadas perdidas. Opciones posibles
email
o vacío, por defecto vacío - missed_call_data (opcional): Dirección de email donde se enviaría el mensaje de llamadas perdidas
- toll_allow (opcional): Para configuraciones en que se permite llamadar a ciertos destinos, los valores son los que se configurarían en
Outbound Routes
a nivel de centralita. - call_timeout (opcional): Tiempo máximo que sonará la llamada antes de ir al buzón de voz (en segundos). Por defecto son 30 segundos
- call_group (opcional): Grupo de captura, es necesario permanecer a un grupo de captura si se quieren hacer capturas indirectas de ese grupo. También funciona como grupo de salto de tipo
ring all
muy básico - call_screen_enabled (opcional): Habilitar call screen. Opciones posibles:
true
yfalse
, por defectofalse
- user_record (opcional): Grabación de llamadas, opciones posibles
all
,local
,inbound
,outbound
y vacío, por defecto sin definir - hold_music (opcional): Música en espera, por defecto la configurada por defecto a nivel global
- auth_acl (opcional): ACL de autenticación a matchear
- cidr (opcional): Limitación de la extensión a una dirección IP concreta
- sip_force_contact (opcional): Forzado del campo
contact
a nivel SIP - sip_force_expires (opcional): Sobreescribir el
expire
del registro del UA registrado o de la centralita - sip_bypass_media (opcional): Envío de audio punto a punto o pasando por la centralita. Opciones posibles
bypass-media
,bypass-media-after-bridge
,proxy-media
. Por defecto sin definir - absolute_codec_string (opcional): Listado de codecs admitidos por la extensión, para sobreescribir lo indicado por el UA o por la centralita
- force_ping (opcional): Para forzar un ping mediante
OPTION
en caso de problemas de NAT. Posibles opcionestrue
yfalse
, por defectofalse
- dial_string (opcional): Localización del UA
- description (opcional): Descripción de la extensión, por defecto la propia extensión
Ejemplo de petición¶
{
"key": "xxxxxxxxxxxxxxxxxx",
"domain_uuid": "yyyyyyyyyyyyyyy",
"extension": "1001",
"outbound_caller_id_number": "944209470"
}
Ejemplo de respuesta¶
Devuelve el número de extensiones dadas de alta correctamente
{
"status": "OK",
"total": 1
}