Bemmelhor Wiki
  • Blog
    • Contato
      • Telefonia IP
        • Omnichannel
          • CRM
            • VOIP
              • FAQ
                • APIs

                  Qual é a sua dúvida?

                  • Página inicial do FAQ
                  • Bemmelhor Telecom
                  • BMTELECOM codigos de integração via REST

                  BMTELECOM codigos de integração via REST

                  Rotas e Sintaxe de Integração via REST

                  Status do Serviço

                  Recurso Descrição

                  URI

                  http://IP.SERVER:3040/bmtelecom/api/

                  Tipo de Requisição 

                  GET

                  Descrição 

                  Retorna dados básicos do servidor de integração.

                  {
                      "status": "200",
                      "description": "System Running",
                      "data": {
                          "app_name": "BmIntegracao - BmTelecom Integration",
                          "version": "1.3.5"
                      } 
                  }

                  Click to call (POST)

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/dialer/:RAMAL/:PHONE
                  Tipo de Requisição POST
                  Descrição Realiza uma ligação telefônica de um :RAMAL para um número externo (:PHONE) via POST
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)
                  :RAMAL Ramal do usuário que irá iniciar a ligacação.
                  :PHONE Telefone de destino do cliente, utilizando o mesmo padrão de discagem manual, ex: 01132103210

                  Click to call (GET)

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/dialer/:RAMAL/:PHONE
                  Tipo de Requisição GET
                  Descrição Realiza uma ligação telefônica de um :RAMAL para um número externo (:PHONE) via GET
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)
                  :RAMAL Ramal do usuário que irá iniciar uma ligacação.
                  :PHONE Telefone de destino do cliente, utilizando o mesmo padrão de discagem manual, ex: 01132103210

                  Desligar ligações ativas

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/hangup/:RAMAL
                  Tipo de Requisição GET
                  Descrição Desliga uma ligação ativa na telefonia
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)
                  :RAMAL Ramal do usuário que irá iniciar uma ligacação.

                  Baixa de Gravações

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/recorder/:FILE_ID
                  Tipo de Requisição GET
                  Descrição Baixa uma gravação através do seu ID
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)
                  :FILE_ID Identificador da gravação desejada, esta informação pode ser recuperada através da listagem de ligações ativas ou Informações sobre Agentes em campanha.

                  Informações sobre Agentes em campanha

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/agent/info/:RAMAL
                  Tipo de Requisição GET
                  Descrição Captura os dados do agente desejado dentro da telefonia, trazendo informações de ligações ativas durante uma campanha.
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)
                  :RAMAL Ramal do usuário que irá iniciar uma ligacação.

                  Retorno CONTENDO ligações ativas

                  {
                    "status":"200",
                    "data": {
                      "destination": "<Telefone de destino do cliente>",
                      "name": "<Nome do cliente>",
                      "cpf": "<CPF do cliente>",
                      "integration_code": "<Código do cliente informado na importação de dados>",
                      "created": "<Data/Hora em que a ligação foi criada>",
                      "dh_start": "<Data/Hora de atendimento da ligação>",
                      "agent": "<Agente conectado ao canal>",
                      "itemcampaign_id": "<Item de campanha que originou a ligação>",
                      "onlineid": "<Id da ligação online>",
                      "contact_id": "<Id do Contato no BmTelecom>",    
                      "phone_number": "<Telefone do cliente ativo>",
                    }
                  }

                  Retorno SEM ligações ativas

                  {
                    "status":"204",
                    "data":"No Result"
                  }

                  Ligações Ativas na Telefonia

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/calls/online
                  Tipo de Requisição GET
                  Descrição Retorna todas as ligações ativas na campanha, incluindo as que estão discando e ainda não foram atendidas
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)

                  Retorno CONTENDO ligações ativas

                  {
                    "status":"200",
                    "data": {
                      "destination": "<Telefone de destino do cliente>",
                      "name": "<Nome do cliente>",
                      "cpf": "<CPF do cliente>",
                      "integration_code": "<Código do cliente informado na importação de dados>",
                      "created": "<Data/Hora em que a ligação foi criada>",
                      "dh_start": "<Data/Hora de atendimento da ligação>",
                      "agent": "<Agente conectado ao canal>",
                      "itemcampaign_id": "<Item de campanha que originou a ligação>",
                      "onlineid": "<Id da ligação online>",
                      "contact_id": "<Id do Contato no BmTelecom>",    
                      "phone_number": "<Telefone do cliente ativo>",
                    }
                  }

                  Retorno SEM ligações ativas

                  {
                    "status":"204",
                    "data":"No Result"
                  }

                  Resumo Contendo Log de Baixa de Gravações

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/download/log/:PAGE
                  Tipo de Requisição GET
                  Descrição Retorna uma lista contendo log de baixa de gravações realizadas no BmTelecom
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)
                  :PAGE Página de resultados desejada, iniciando da página 1 (O resultado será em ordem crescente) com 20 itens por vez

                  Retorno CONTENDO ligações ativas

                  {
                    "status": "200",
                    "data": [
                      {
                        "id": 38,
                        "user_id": 1,
                        "file_name": "1543838722.257.mp3",
                        "created": "2019-03-21T13:00:32.000Z",
                        "uniqueid": "1543838722.257",
                        "call_id": 53604,
                        "download": false,
                        "destination": "s",
                        "peer": "6003",
                        "call_type": "INCOMING",
                        "queue": "suporte",
                        "calldate": "2018-12-03T12:05:22.000Z",
                        "origin": "032032032032"
                      },
                      ...
                    ]
                  }

                  Resumo Contendo Log de Baixa de Gravações (Apenas não lidas)

                  RecursoDescrição
                  URI http://IP.SERVER:3040/bmtelecom/api/:KEY/download/log/unread
                  Tipo de Requisição GET
                  Descrição Retorna uma lista de 20 elementos contendo log de baixa de gravações realizadas no BmTelecom. Porém retorna apenas aqueles registros que ainda não foram baixados pelo REST, após esta requisição os itens serão marcados como lidos.
                  :KEY Chave para acesso ao sistema, cadastrada com o auxílio do suporte técnico. (http://IP.DO.SERVIDOR/bmtelecom/admin/settings/prefix/Telecom - Nodejs: Chave Login)

                  Retorno CONTENDO ligações ativas

                  {
                    "status": "200",
                    "data": [
                      {
                        "id": 38,
                        "user_id": 1,
                        "file_name": "1543838722.257.mp3",
                        "created": "2019-03-21T13:00:32.000Z",
                        "uniqueid": "1543838722.257",
                        "call_id": 53604,
                        "download": false,
                        "destination": "s",
                        "peer": "6003",
                        "call_type": "INCOMING",
                        "queue": "suporte",
                        "calldate": "2018-12-03T12:05:22.000Z",
                        "origin": "032032032032"
                      },
                      ...
                    ]
                  }
                  Página inicial do FAQ

                  Bemmelhor SI

                  • Omnichannel
                  • Discador Preditivo
                  • Telefonia IP
                  • Bemmelhor CRM
                  • VOIP
                  • PABX Virtual

                  Produtos

                  • Bemmelhor SI
                    • A Empresa
                      • Blog
                        • Contato
                          • Abrir Ticket de Suporte
                            • FAQ
                              • Trabalhe Conosco

                                Social

                                Onde Estamos

                                   Rua José Lourenço Kelmer 02
                                Edifício do CRITT - Campus UFJF
                                São Pedro - Juiz de Fora - MG

                                Contatos

                                (32) 3211.0536

                                suporte@bemmelhor.com.br

                                Whatsapp

                                5532991450735

                                © Copyright 2022 Bemmelhor Soluções Inteligentes

                                Todos os direitos reservados.