Equipes

Retorna uma equipe

get

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

get

/pbx/campaigns

HTTPcURLJavaScriptPython

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

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "dev",
  "extension": "200",
  "ring_time": 30,
  "ring_type": "linear",
  "allow_internal": true,
  "dialing_permissions": [
    "63d7d9476648050011dc5d92"
  ],
  "capture_permissions": [
    "63b703156648050011dc5d73"
  ],
  "ring_group": [
    {
      "agent_id": "64039e61388735a60f299876",
      "forwarding": false,
      "priority": 1,
      "order": 1
    }
  ],
  "max_waiting_time": 30,
  "transhipment_by_time": "63b703156648050011dc5d72",
  "service_meta": 100,
  "answered_within_seconds": 10,
  "abandoned_within_seconds": 20
}

Cadastro de equipe

post

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da equipe

Example: dev

extensionstringObrigatório

Número da equipe

Example: 200

ring_timenumberObrigatório

Tempo de toque

Example: 30

ring_typestringObrigatório

Tipo de toque

Example: linear

allow_internalbooleanObrigatório

Permite ou não chamadas entre agentes

Example: true

dialing_permissionsstring[]Obrigatório

Array dos IDs de rotas de saída

Example: ["63d7d9476648050011dc5d92"]

capture_permissionsstring[]Obrigatório

Array dos IDs das campanhas

Example: ["63b703156648050011dc5d73"]

gogenier_integrationbooleanObrigatório

Indica se há integração ativa com o sistema GOgenier

Example: true

gogenier_pipelinestringObrigatório

ID de uma pipeline do Gogenier

Example: f3842498-94ce-435e-9a52-c70d10b75806

gogenier_ai_idstringObrigatório

Representa o ID da IA cadastrada no Voice referente ao GOgenier

Example: 675af3c364175500018bb3f0

max_waiting_timenumberObrigatório

Tempo máximo de espera permitido (em segundos) de uma ligação.

Example: 30

transhipment_by_timestringObrigatório

Indica o ID da equipe para onde a chamada vai ser desviada.

Example: 63b703156648050011dc5d72

service_metanumberObrigatório

Meta de serviço

Example: 100

answered_within_secondsnumberObrigatório

Respondido em segundos

Example: 10

abandoned_within_secondsnumberObrigatório

Abandonado em segundos

Example: 20

Respostas

default

application/json

post

/pbx/campaigns

HTTPcURLJavaScriptPython

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

{
  "name": "dev",
  "extension": "200",
  "ring_time": 30,
  "ring_type": "linear",
  "allow_internal": true,
  "dialing_permissions": [
    "63d7d9476648050011dc5d92"
  ],
  "capture_permissions": [
    "63b703156648050011dc5d73"
  ],
  "ring_group": [
    {
      "agent_id": "64039e61388735a60f299876",
      "forwarding": false,
      "priority": 1,
      "order": 1
    }
  ],
  "gogenier_integration": true,
  "gogenier_pipeline": "f3842498-94ce-435e-9a52-c70d10b75806",
  "gogenier_ai_id": "675af3c364175500018bb3f0",
  "max_waiting_time": 30,
  "transhipment_by_time": "63b703156648050011dc5d72",
  "service_meta": 100,
  "answered_within_seconds": 10,
  "abandoned_within_seconds": 20
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "dev",
  "extension": "200",
  "ring_time": 30,
  "ring_type": "linear",
  "allow_internal": true,
  "dialing_permissions": [
    "63d7d9476648050011dc5d92"
  ],
  "capture_permissions": [
    "63b703156648050011dc5d73"
  ],
  "ring_group": [
    {
      "agent_id": "64039e61388735a60f299876",
      "forwarding": false,
      "priority": 1,
      "order": 1
    }
  ],
  "max_waiting_time": 30,
  "transhipment_by_time": "63b703156648050011dc5d72",
  "service_meta": 100,
  "answered_within_seconds": 10,
  "abandoned_within_seconds": 20
}

Atualiza uma equipe

put

Autorizações

basic

AuthorizationstringObrigatório

Corpo

application/json

namestringObrigatório

Nome da equipe

Example: dev

extensionstringObrigatório

Número da equipe

Example: 200

ring_timenumberObrigatório

Tempo de toque

Example: 30

ring_typestringObrigatório

Tipo de toque

Example: linear

allow_internalbooleanObrigatório

Permite ou não chamadas entre agentes

Example: true

dialing_permissionsstring[]Obrigatório

Array dos IDs de rotas de saída

Example: ["63d7d9476648050011dc5d92"]

capture_permissionsstring[]Obrigatório

Array dos IDs das campanhas

Example: ["63b703156648050011dc5d73"]

gogenier_integrationbooleanObrigatório

Indica se há integração ativa com o sistema GOgenier

Example: true

gogenier_pipelinestringObrigatório

ID de uma pipeline do Gogenier

Example: f3842498-94ce-435e-9a52-c70d10b75806

gogenier_ai_idstringObrigatório

Representa o ID da IA cadastrada no Voice referente ao GOgenier

Example: 675af3c364175500018bb3f0

max_waiting_timenumberObrigatório

Tempo máximo de espera permitido (em segundos) de uma ligação.

Example: 30

transhipment_by_timestringObrigatório

Indica o ID da equipe para onde a chamada vai ser desviada.

Example: 63b703156648050011dc5d72

service_metanumberObrigatório

Meta de serviço

Example: 100

answered_within_secondsnumberObrigatório

Respondido em segundos

Example: 10

abandoned_within_secondsnumberObrigatório

Abandonado em segundos

Example: 20

_idstringObrigatório

ID da rota da equipe

Example: 63724b92c0ef93903y24dc45

Respostas

default

application/json

put

/pbx/campaigns

HTTPcURLJavaScriptPython

PUT /pbx/campaigns HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 603

{
  "name": "dev",
  "extension": "200",
  "ring_time": 30,
  "ring_type": "linear",
  "allow_internal": true,
  "dialing_permissions": [
    "63d7d9476648050011dc5d92"
  ],
  "capture_permissions": [
    "63b703156648050011dc5d73"
  ],
  "ring_group": [
    {
      "agent_id": "64039e61388735a60f299876",
      "forwarding": false,
      "priority": 1,
      "order": 1
    }
  ],
  "gogenier_integration": true,
  "gogenier_pipeline": "f3842498-94ce-435e-9a52-c70d10b75806",
  "gogenier_ai_id": "675af3c364175500018bb3f0",
  "max_waiting_time": 30,
  "transhipment_by_time": "63b703156648050011dc5d72",
  "service_meta": 100,
  "answered_within_seconds": 10,
  "abandoned_within_seconds": 20,
  "_id": "63724b92c0ef93903y24dc45"
}

default

{
  "_id": "63724b92c0ef93903y24dc45",
  "name": "dev",
  "extension": "200",
  "ring_time": 30,
  "ring_type": "linear",
  "allow_internal": true,
  "dialing_permissions": [
    "63d7d9476648050011dc5d92"
  ],
  "capture_permissions": [
    "63b703156648050011dc5d73"
  ],
  "ring_group": [
    {
      "agent_id": "64039e61388735a60f299876",
      "forwarding": false,
      "priority": 1,
      "order": 1
    }
  ],
  "max_waiting_time": 30,
  "transhipment_by_time": "63b703156648050011dc5d72",
  "service_meta": 100,
  "answered_within_seconds": 10,
  "abandoned_within_seconds": 20
}

Deleta uma equipe

delete

Autorizações

basic

AuthorizationstringObrigatório

Parâmetros de consulta

idstringObrigatório

Respostas

default

application/json

delete

/pbx/campaigns

HTTPcURLJavaScriptPython

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

default

{
  "count": 1
}

Retorna lista de equipes

get

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

get

/pbx/campaigns/all

HTTPcURLJavaScriptPython

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

default

[
  {
    "_id": "63724b92c0ef93903y24dc45",
    "name": "dev",
    "extension": "200",
    "ring_time": 30,
    "ring_type": "linear",
    "allow_internal": true,
    "dialing_permissions": [
      "63d7d9476648050011dc5d92"
    ],
    "capture_permissions": [
      "63b703156648050011dc5d73"
    ],
    "ring_group": [
      {
        "agent_id": "64039e61388735a60f299876",
        "forwarding": false,
        "priority": 1,
        "order": 1
      }
    ],
    "max_waiting_time": 30,
    "transhipment_by_time": "63b703156648050011dc5d72",
    "service_meta": 100,
    "answered_within_seconds": 10,
    "abandoned_within_seconds": 20
  }
]

Deleta todas as equipes

delete

Autorizações

basic

AuthorizationstringObrigatório

Respostas

default

application/json

delete

/pbx/campaigns/all

HTTPcURLJavaScriptPython

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

default

{
  "count": 1
}