Documentación de Actualizar un agente (v2)
Actualizar un agente (v2)
Actualizar un agente (v2)
Actualizar un agente (v2)
Inicio y cierre de sesión, pausas y cambios de perfil
Descripción general
Endpoints disponibles
/api/v2/agentsParámetros clave
agent_number(String)El número de teléfono actual del agente. Envíe este campo o agent_sip, no ambos.
agent_sip(String)La extensión SIP del agente. Envíe este campo o agent_number, no ambos.
status(Integer)0 inicia la sesión del agente (Disponible). 2 la cierra (Desconectado) o, con un break_id, lo pone en esa pausa. No se aceptan otros valores.
break_id(Integer)En qué pausa poner al agente. Debe ser una pausa habilitada para su servicio. Enviar break_id implica el estado 2 y no se puede combinar con el estado 0. Con el estado 2 y sin break_id se usa la pausa predeterminada 7 (Desconectado), que cierra la sesión del agente.
number(String)Nuevo número de teléfono: de 4 a 15 dígitos, sin +, espacios ni guiones. No debe pertenecer a otro agente del servicio. No se puede cambiar mientras el agente está en una llamada.
country_code(String)De 1 a 4 dígitos sin +, sin empezar por 0, por ejemplo 91 o 971.
Escenarios de uso
Iniciar sesión de un agente
Establezca status en 0. El agente pasa a Disponible y empieza a recibir llamadas de sus colas. Esto también saca al agente de cualquier pausa.
Cerrar sesión de un agente
Establezca status en 2 sin break_id. El agente pasa a Desconectado (pausa 7) y deja de recibir llamadas. Enviar el estado 2 con break_id 7 hace lo mismo.
Poner a un agente en pausa
Envíe el break_id; el estado 2 queda implícito. El agente deja de recibir llamadas hasta que vuelva a iniciar sesión. Aquí el agente se selecciona por su número de teléfono en lugar de por su extensión SIP.
Cambiar de una pausa a otra
Un agente no puede pasar directamente de una pausa a otra; esa llamada devuelve 409. Inicie primero su sesión (estado 0) y luego envíe el nuevo break_id. Ambas llamadas se pueden reintentar sin riesgo.
Actualizar los datos del perfil
Cambie el nombre, el número de teléfono y el código de país a la vez. Los campos de perfil se pueden enviar en la misma llamada que status o break_id, pero el número no se puede cambiar mientras el agente está en una llamada.
Ejemplo rápido
Prueba esta API con un sencillo comando cURL
curl -X PUT 'https://telephonycloud.co.in/api/v2/agents' \
-H 'Authorization: Bearer <YOUR_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{"agent_sip": "10114", "status": 0}'Vista previa de la respuesta
Respuesta de ejemplo de esta API
{"status":"success","changed":["status","break_id"],"agent":{"id":735,"name":"Priya Sharma","number":"9876500000","country_code":"91","sip":"10114","status":2,"break_id":3}}