DOCUMENTAÇÃO API VERSÃO 1.0
\nRepositório:
https://integration.bvtelecom.com.br/api
Objetivo
\nA API SMS - Permite automatizar o
processo de envio de mensagens SMS de forma individual ou em multiplas.
Utilizamos o formato JSON para envolver os parâmetros em uma solicitação
HTTP/POST.
Credencias de acesso
\nFale com o seu gerente de contas para
gerar as credencias de acesso, você precisa de um nome de usuário e chave de
autenticação.
A requisição é do tipo HTTP/POST e
você precisa passar essas informações no Header.
Envio Individual de SMS
\nPermite apenas um único disparo:
POST https://integration.bvtelecom.com.br/api/delivery/single-sms
Content-Type: application/json
Header : ApiKey = {{TOKEN}}
Codigos de Status de Mensagens
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"47910","collectionId":"1b825db0-96e3-4536-bfab-46e32dd647ae","publishedId":"UVR7LoDo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-12-15T01:27:30.000Z"},"item":[{"name":"Multiple-SMS","event":[{"listen":"test","script":{"id":"2f2a4bc9-a569-4ca4-acb1-dc99e11c3714","exec":[""],"type":"text/javascript","packages":{}}}],"id":"d74f3700-a4bd-4f79-a56a-1f9be86be2b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dataAgendamento\":\"2025-03-31 11:00\",\n \"dataLimite\": \"2025-03-31 11:00\",\n \"bulk\": [\n {\n \"celular\": \"10969686389\",\n \"mensagem\": \"Teste 1\",\n \"parceiroId\": \"msg001\",\n \"carteiraId\": 123,\n \"campanhaId\": 123\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.bvtelecom.com.br/api/delivery/multiple-sms","description":"O envio em lote permite o envio de até mil mensagens por lote. Existe a opção de enviar mensagens de forma agendada. No payload existem duas propriedade opcionais que podem ser enviadas para agendar o envio de mensagens, conforme a regra abaixo:
\nDataAgendamento (opcional) - Possibilita determinar a data e horario que o lote deve ser enviado.
\nDataLimite(opcional) - Ao enviar esse parametro. O sistema ira calcular a quantidade de minutos entre a data de agendamento e a data limite e dividir a quantidade total do lote pela quantidade de minutos e usará esse valor para determinar quantas mensagens será enviada por minuto a fim de cadenciar os disparos de acordo com os parametros fornecidos. Exemplo:
\nLotes com 1000 telefones
DataAgendamento = \"2025-04-11 12:00\"
DataLimite = \"2025-04-11 12:50\"
1000 telefones / 50 minutos == 20 mensagens por minuto.
O envio individual permite até dez threads simultaneas disparando do mesmo ip de origem. Requisições simultaneas a esse limite recebera uma mensagem de erro.
\n","urlObject":{"protocol":"https","path":["webhook","api","delivery","single-sms"],"host":["integration","bvtelecom","com","br"],"query":[],"variable":[]}},"response":[{"id":"4b53c3a3-f451-4068-8dc4-23d96cdb0ea4","name":"Single-SMS-Success","originalRequest":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"celular\": \"10969686389\",\n \"mensagem\": \"Teste 1\",\n \"parceiroId\": \"102030\"\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.bvtelecom.com.br/api/delivery/single-sms"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Message sent successfully\"\n}"},{"id":"f8153742-4c80-4470-a9b6-34049f90c327","name":"Single-SMS-Bad","originalRequest":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"celular\": \"10969686389\",\n \"mensagem\": \"Teste 1\",\n \"parceiroId\": \"102030\"\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.bvtelecom.com.br/api/delivery/single-sms"},"status":"Bad Request","code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"Message\":\"Phone number and text is required\"\n}"},{"id":"77d88459-3403-41cc-a159-9f4de057fd66","name":"Single-SMS-Error","originalRequest":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"celular\": \"10969686389\",\n \"mensagem\": \"Teste 1\",\n \"parceiroId\": \"102030\"\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.bvtelecom.com.br/api/delivery/single-sms"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"hasErrors\": true,\n \"errors\": [\n {\n \"reference\": \"Kind of error\",\n \"message\": \"Error message describing error details\"\n }\n ]\n}"}],"_postman_id":"05182cc1-792e-4544-84dc-bda8524578d1"},{"name":"Carteira-List","id":"0a150aa0-699c-4bc0-9c38-ee5f6df27f19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"}],"url":"https://integration.bvtelecom.com.br/api/carteira","description":"Este endpoint permite lista todas as carteira criadas na plataforma para sua empresa. Lista os campos Id e Nome
\n","urlObject":{"protocol":"https","path":["api","carteira"],"host":["integration","bvtelecom","com","br"],"query":[],"variable":[]}},"response":[{"id":"07ebf321-f3f3-44d7-b573-f7a9c40024f0","name":"Carteira-List","originalRequest":{"method":"GET","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://integration.bvtelecom.com.br/api/carteira"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 14 Apr 2025 20:00:01 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:9669800e-a4f5-411a-a9dc-8dc7485dfe76"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Exemplo de Carteira\"\n }\n]"}],"_postman_id":"0a150aa0-699c-4bc0-9c38-ee5f6df27f19"},{"name":"Carteira-Create","id":"0a673c0f-33ce-4a0d-ad88-4e4b4b4e0334","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"nome\": \"Teste Api\"\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.bvtelecom.com.br/api/carteira","description":"Este endpoint permite a criação de novas carteiras na plataforma.
\n","urlObject":{"protocol":"https","path":["api","carteira"],"host":["integration","bvtelecom","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"0a673c0f-33ce-4a0d-ad88-4e4b4b4e0334"},{"name":"Campanha-List","id":"9cde2387-3e69-4b89-9f55-27cabc47a66b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"}],"url":"https://integration.bvtelecom.com.br/campanha","description":"Este endpoint permite a listagem de todas as campanhas da platafroma.
\n","urlObject":{"protocol":"https","path":["campanha"],"host":["integration","bvtelecom","com","br"],"query":[],"variable":[]}},"response":[{"id":"fd887802-b908-444f-a80f-4ec82196e4dd","name":"Campanha-List","originalRequest":{"method":"GET","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"},{"key":"","value":"","type":"text","disabled":true}],"url":"https://integration.bvtelecom.com.br/campanha"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Mon, 14 Apr 2025 19:57:35 GMT"},{"key":"Server","value":"Kestrel"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Request-Context","value":"appId=cid-v1:b95bb453-885c-421f-b180-a890100c5778"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"name\": \"Exemplo de Campanha\",\n \"message\": \"{{Mensagem}}\"\n }\n]"}],"_postman_id":"9cde2387-3e69-4b89-9f55-27cabc47a66b"},{"name":"Campanha-Create","id":"dc62f2d0-b299-4f66-b590-e8a0d5e5df53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"carteiraId\": 4111,\n \"nome\": \"Teste campanha APi\",\n \"mensagem\": \"Teste Campanha api Mensagem\"\n}","options":{"raw":{"language":"json"}}},"url":"https://integration.bvtelecom.com.br/api/campanha","description":"Este endpoint permite criar campanhas na plataforma.
\n","urlObject":{"protocol":"https","path":["api","campanha"],"host":["integration","bvtelecom","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc62f2d0-b299-4f66-b590-e8a0d5e5df53"},{"name":"Callback - Single","id":"432dd6cb-904b-4e91-85cb-93bb9f4aefa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ApiKey","value":"{{TOKEN}}","type":"text"},{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"{\n \"MensagemId\": \"123\",\n \"MensagemStatusId\": \"2\",\n \"Codigo\": \"123456\",\n \"MensagemTexto\": \"Teste 1\",\n \"Tipo\" : \"DLR / MO\",\n \"Data\" : \"2022-03-25T00:00:00\",\n \"Telefone\": \"11987654321\"\n}","options":{"raw":{"language":"json"}}},"url":"https://seudominio.com.br/api/callbacksingle","description":"Esse exemplo de requisição detalha como deve ser criada a api do lado cliente para receber os eventos de atualização de status e respostas.
\n","urlObject":{"protocol":"https","path":["api","callbacksingle"],"host":["seudominio","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"432dd6cb-904b-4e91-85cb-93bb9f4aefa6"},{"name":"Callback - Multiple","id":"77f84ee9-efdd-4d2e-9f26-e12618d2b165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"","value":"","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"MensagemId\": \"123\",\n \"MensagemStatusId\": \"2\",\n \"Codigo\": \"123456\",\n \"MensagemTexto\": \"Teste 1\",\n \"Tipo\" : \"DLR / MO\",\n \"Data\" : \"2022-03-25T00:00:00\",\n \"Telefone\": \"11987654321\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/api/WebHook/","description":"Esse exemplo de requisição detalha como deve ser criada a api do lado cliente para receber os eventos de atualização de status e respostas.
\n","urlObject":{"protocol":"http","port":"5000","path":["api","WebHook",""],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"77f84ee9-efdd-4d2e-9f26-e12618d2b165"}]}