Agentes

Retorna um agente

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

ID do agente

sync_authstringOpcional

Atualizar a senha do ramal do agente

Respostas

default

application/json

get

/pbx/agent

HTTPcURLJavaScriptPython

GET /pbx/agent?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Agente 1",
  "extension": "4040",
  "codename": "agente1",
  "email": "[email protected]",
  "begin": "08:00",
  "end": "18:00",
  "campaign": "642487adaf9690001f9e1651",
  "tech": "msteams",
  "country_code": "+55",
  "record_in": "on",
  "record_out": "on",
  "extension_lock": 0,
  "dtmf_mode": "rfc4733",
  "call_limit": 2,
  "user_password": 1234,
  "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
}

Cadastro de agente

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome do agente

Example: Agente 1

extensionstringObrigatório

Número do ramal do agente

Example: 4040

codenamestringObrigatório

codename do do agente

Example: agente1

emailstringObrigatório

E-mail do agente para onde será enviado o link para criação da senha

Example: [email protected]

beginstringObrigatório

Horário inicial de login do agente

Example: 08:00

endstringObrigatório

Horário final de login do agente

Example: 18:00

campaignstringObrigatório

ID da equipe do agente

Example: 642487adaf9690001f9e1651

techstringObrigatório

Tecnologia do ramal do agente

Example: msteams

country_codestringObrigatório

Código do país do ramal Microsoft Teams

Example: +55

record_instringObrigatório

Flag para gravar as chamadas recebidas pelo agente

Example: on

record_outstringObrigatório

Flag para gravar as chamadas realizadas pelo agente

Example: on

extension_locknumberObrigatório

Flag para solicitar senha ao discar ou não

Example: 0

dtmf_modestringObrigatório

Tipo de DTMF do ramal utilizado pelo agente

Example: rfc4733

call_limitnumberObrigatório

Número máximo de chamadas simultâneas suportadas pelo ramal do agente

Example: 2

user_passwordnumberObrigatório

Senha solicitada quando o campo extension_lock está 1

Example: 1234

allowed_ipsstringObrigatório

Lista de redes permitidas para autenticação no ramal do agente

Example: 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16

use_main_loginstringObrigatório

Usar login como e-mail de recuperação

Example: true

email_forgot_passwordstringObrigatório

E-mail para recuperar senha

Example: [email protected]

Respostas

default

application/json

post

/pbx/agent

HTTPcURLJavaScriptPython

POST /pbx/agent HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 437

{
  "name": "Agente 1",
  "extension": "4040",
  "codename": "agente1",
  "email": "[email protected]",
  "begin": "08:00",
  "end": "18:00",
  "campaign": "642487adaf9690001f9e1651",
  "tech": "msteams",
  "country_code": "+55",
  "record_in": "on",
  "record_out": "on",
  "extension_lock": 0,
  "dtmf_mode": "rfc4733",
  "call_limit": 2,
  "user_password": 1234,
  "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16",
  "use_main_login": "true",
  "email_forgot_password": "[email protected]"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Agente 1",
  "extension": "4040",
  "codename": "agente1",
  "email": "[email protected]",
  "begin": "08:00",
  "end": "18:00",
  "campaign": "642487adaf9690001f9e1651",
  "tech": "msteams",
  "country_code": "+55",
  "record_in": "on",
  "record_out": "on",
  "extension_lock": 0,
  "dtmf_mode": "rfc4733",
  "call_limit": 2,
  "user_password": 1234,
  "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
}

Atualiza um agente

put

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Corpo

application/json

namestringObrigatório

Nome do agente

Example: Agente 1

extensionstringObrigatório

Número do ramal do agente

Example: 4040

codenamestringObrigatório

codename do do agente

Example: agente1

emailstringObrigatório

E-mail do agente para onde será enviado o link para criação da senha

Example: [email protected]

beginstringObrigatório

Horário inicial de login do agente

Example: 08:00

endstringObrigatório

Horário final de login do agente

Example: 18:00

campaignstringObrigatório

ID da equipe do agente

Example: 642487adaf9690001f9e1651

techstringObrigatório

Tecnologia do ramal do agente

Example: msteams

country_codestringObrigatório

Código do país do ramal Microsoft Teams

Example: +55

record_instringObrigatório

Flag para gravar as chamadas recebidas pelo agente

Example: on

record_outstringObrigatório

Flag para gravar as chamadas realizadas pelo agente

Example: on

extension_locknumberObrigatório

Flag para solicitar senha ao discar ou não

Example: 0

dtmf_modestringObrigatório

Tipo de DTMF do ramal utilizado pelo agente

Example: rfc4733

call_limitnumberObrigatório

Número máximo de chamadas simultâneas suportadas pelo ramal do agente

Example: 2

user_passwordnumberObrigatório

Senha solicitada quando o campo extension_lock está 1

Example: 1234

allowed_ipsstringObrigatório

Lista de redes permitidas para autenticação no ramal do agente

Example: 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16

use_main_loginstringObrigatório

Usar login como e-mail de recuperação

Example: true

email_forgot_passwordstringObrigatório

E-mail para recuperar senha

Example: [email protected]

Respostas

default

application/json

put

/pbx/agent

HTTPcURLJavaScriptPython

PUT /pbx/agent?id=text HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 437

{
  "name": "Agente 1",
  "extension": "4040",
  "codename": "agente1",
  "email": "[email protected]",
  "begin": "08:00",
  "end": "18:00",
  "campaign": "642487adaf9690001f9e1651",
  "tech": "msteams",
  "country_code": "+55",
  "record_in": "on",
  "record_out": "on",
  "extension_lock": 0,
  "dtmf_mode": "rfc4733",
  "call_limit": 2,
  "user_password": 1234,
  "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16",
  "use_main_login": "true",
  "email_forgot_password": "[email protected]"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "Agente 1",
  "extension": "4040",
  "codename": "agente1",
  "email": "[email protected]",
  "begin": "08:00",
  "end": "18:00",
  "campaign": "642487adaf9690001f9e1651",
  "tech": "msteams",
  "country_code": "+55",
  "record_in": "on",
  "record_out": "on",
  "extension_lock": 0,
  "dtmf_mode": "rfc4733",
  "call_limit": 2,
  "user_password": 1234,
  "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
}

Deleta um agente

delete

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

delete

/pbx/agent

HTTPcURLJavaScriptPython

DELETE /pbx/agent?id=text HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "count": 1
}

Cadastro de múltiplos agentes

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome do agente

Example: Agente 1

extensionstringObrigatório

Número do ramal do agente

Example: 4040

codenamestringObrigatório

codename do do agente

Example: agente1

emailstringObrigatório

E-mail do agente para onde será enviado o link para criação da senha

Example: [email protected]

beginstringObrigatório

Horário inicial de login do agente

Example: 08:00

endstringObrigatório

Horário final de login do agente

Example: 18:00

campaignstringObrigatório

ID da equipe do agente

Example: 642487adaf9690001f9e1651

techstringObrigatório

Tecnologia do ramal do agente

Example: msteams

country_codestringObrigatório

Código do país do ramal Microsoft Teams

Example: +55

record_instringObrigatório

Flag para gravar as chamadas recebidas pelo agente

Example: on

record_outstringObrigatório

Flag para gravar as chamadas realizadas pelo agente

Example: on

extension_locknumberObrigatório

Flag para solicitar senha ao discar ou não

Example: 0

dtmf_modestringObrigatório

Tipo de DTMF do ramal utilizado pelo agente

Example: rfc4733

call_limitnumberObrigatório

Número máximo de chamadas simultâneas suportadas pelo ramal do agente

Example: 2

user_passwordnumberObrigatório

Senha solicitada quando o campo extension_lock está 1

Example: 1234

allowed_ipsstringObrigatório

Lista de redes permitidas para autenticação no ramal do agente

Example: 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16

use_main_loginstringObrigatório

Usar login como e-mail de recuperação

Example: true

email_forgot_passwordstringObrigatório

E-mail para recuperar senha

Example: [email protected]

Respostas

default

application/json

post

/pbx/agent/multi

HTTPcURLJavaScriptPython

POST /pbx/agent/multi HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 437

{
  "name": "Agente 1",
  "extension": "4040",
  "codename": "agente1",
  "email": "[email protected]",
  "begin": "08:00",
  "end": "18:00",
  "campaign": "642487adaf9690001f9e1651",
  "tech": "msteams",
  "country_code": "+55",
  "record_in": "on",
  "record_out": "on",
  "extension_lock": 0,
  "dtmf_mode": "rfc4733",
  "call_limit": 2,
  "user_password": 1234,
  "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16",
  "use_main_login": "true",
  "email_forgot_password": "[email protected]"
}

default

[
  {
    "_id": "63724b92c0ef93903y24dc45",
    "name": "Agente 1",
    "extension": "4040",
    "codename": "agente1",
    "email": "[email protected]",
    "begin": "08:00",
    "end": "18:00",
    "campaign": "642487adaf9690001f9e1651",
    "tech": "msteams",
    "country_code": "+55",
    "record_in": "on",
    "record_out": "on",
    "extension_lock": 0,
    "dtmf_mode": "rfc4733",
    "call_limit": 2,
    "user_password": 1234,
    "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
  }
]

Retorna lista de agentes

get

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

get

/pbx/agent/all

HTTPcURLJavaScriptPython

GET /pbx/agent/all HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

[
  {
    "_id": "63724b92c0ef93903y24dc45",
    "name": "Agente 1",
    "extension": "4040",
    "codename": "agente1",
    "email": "[email protected]",
    "begin": "08:00",
    "end": "18:00",
    "campaign": "642487adaf9690001f9e1651",
    "tech": "msteams",
    "country_code": "+55",
    "record_in": "on",
    "record_out": "on",
    "extension_lock": 0,
    "dtmf_mode": "rfc4733",
    "call_limit": 2,
    "user_password": 1234,
    "allowed_ips": "10.0.0.0/8,172.16.0.0/12,192.168.0.0/16"
  }
]

Deleta todos os agentes

delete

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

delete

/pbx/agent/all

HTTPcURLJavaScriptPython

DELETE /pbx/agent/all HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

{
  "count": 1
}

Envia email para trocar a senha do agent

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

idstringObrigatório

ID do agente

Example: 63ffc05755cb70006aecf873

Respostas

default

application/json

post

/pbx/agent/reset_password

HTTPcURLJavaScriptPython

POST /pbx/agent/reset_password HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "id": "63ffc05755cb70006aecf873"
}

default

{
  "message": "Password reset link sent"
}

Pausa um agente

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

agent_idstringObrigatório

Id do agente

Example: 66c4ca591cfce41d1f0631e2

pause_idstringObrigatório

Id da pausa

Example: 6712eab84863beaa5eb003e8

metadataobjectObrigatório

Objeto de informações extras

Example: {"is_pause_personalized":true,"products":["chat","voice"]}

Respostas

default

application/json

post

/pbx/agent/pause

HTTPcURLJavaScriptPython

POST /pbx/agent/pause HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "agent_id": "66c4ca591cfce41d1f0631e2",
  "pause_id": "6712eab84863beaa5eb003e8",
  "metadata": {
    "is_pause_personalized": true,
    "products": [
      "chat",
      "voice"
    ]
  }
}

default

{
  "paused": 1,
  "cumulative_time": 300,
  "_id": "6718ff4995984c0011698796",
  "active": true,
  "productive": true,
  "cumulative": true,
  "supervisioned": true,
  "typeMessage": "",
  "name": "Almoço",
  "description": "Pausa para o almoço",
  "initialTime": "00:00",
  "maxTime": "60",
  "message": "",
  "created_at": "2022-11-25 14:34:26",
  "updated_at": "2022-11-25 14:34:26",
  "count_calls_in": "5",
  "count_calls_out": "5",
  "talk_time_average": "00:00:00",
  "total_talk_time": "00:00:00",
  "metadata": {
    "is_pause_personalized": true,
    "products": [
      "chat",
      "voice"
    ]
  }
}

Despausar um agente

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

agent_idstringObrigatório

Id do agente

Example: 66c4ca591cfce41d1f0631e2

Respostas

201Sucesso

post

/pbx/agent/unpause

HTTPcURLJavaScriptPython

POST /pbx/agent/unpause HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "agent_id": "66c4ca591cfce41d1f0631e2"
}

201Sucesso

Sem conteúdo

Aplica tabulação

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

tabulation_idstringObrigatório

Id da Tabulação

Example: 6717127f54d823d2299b7389

agent_idstringObrigatório

Id do agente

Example: 664f25672190f16d6dfd9eab

group_idstringObrigatório

Id do Grupo

Example: 664f33402190f16d6dfda1aa

protocolstringObrigatório

Protocolo

Example: 202410211255062682

contact_idstringObrigatório

Id do Contato

Example: 6421dc5c12b2cd388e01c4b1

Respostas

default

application/json

post

/pbx/agent/tabulation

HTTPcURLJavaScriptPython

POST /pbx/agent/tabulation HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "tabulation_id": "6717127f54d823d2299b7389",
  "agent_id": "664f25672190f16d6dfd9eab",
  "group_id": "664f33402190f16d6dfda1aa",
  "protocol": "202410211255062682",
  "contact_id": "6421dc5c12b2cd388e01c4b1"
}

default

{
  "count": 1
}