Help
RSS
API
Feed
Maltego
Contact
Domain > docs.comtele.com.br
×
More information on this domain is in
AlienVault OTX
Is this malicious?
Yes
No
DNS Resolutions
Date
IP Address
2018-07-11
54.175.95.86
(
ClassC
)
2018-11-08
34.226.151.187
(
ClassC
)
2026-01-08
149.28.193.51
(
ClassC
)
Port 80
HTTP/1.1 301 Moved PermanentlyServer: nginx/1.14.0 (Ubuntu)Date: Thu, 08 Jan 2026 18:57:45 GMTContent-Type: text/htmlContent-Length: 194Connection: keep-aliveLocation: https://docs.comtele.com.br/ html>head>title>301 Moved Permanently/title>/head>body bgcolorwhite>center>h1>301 Moved Permanently/h1>/center>hr>center>nginx/1.14.0 (Ubuntu)/center>/body>/html>
Port 443
HTTP/1.1 200 OKServer: nginx/1.14.0 (Ubuntu)Date: Thu, 08 Jan 2026 18:57:45 GMTContent-Type: text/htmlContent-Length: 614819Last-Modified: Wed, 05 Feb 2025 13:28:32 GMTConnection: keep-aliveETag: 67a36780-961a3Accept-Ranges: bytes !doctype html>html>head> meta charsetutf-8> meta contentIEedge,chrome1 http-equivX-UA-Compatible> meta nameviewport contentwidthdevice-width, initial-scale1, maximum-scale1> title>Comtele API Rest Docs/title> link relapple-touch-icon sizes180x180 hrefimages/apple-touch-icon.png> link relicon typeimage/png sizes32x32 hrefimages/favicon-32x32.png> link relicon typeimage/png sizes16x16 hrefimages/favicon-16x16.png> link relmanifest hrefimages/manifest.json> link relmask-icon hrefimages/safari-pinned-tab.svg color#ff7404> meta nametheme-color content#ffffff> link hrefstylesheets/screen.css relstylesheet typetext/css mediascreen /> link hrefstylesheets/print.css relstylesheet typetext/css mediaprint /> link hrefhttps://fonts.googleapis.com/css?familyComfortaa:400,500,600,700|Fira+Code:400,500,600,700&displayswap relstylesheet> script srchttps://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js>/script> script srcjavascripts/all.js typetext/javascript>/script> script> (function (i, s, o, g, r, a, m) { iGoogleAnalyticsObject r; ir ir || function () { (ir.q ir.q || ).push(arguments) }, ir.l 1 * new Date(); a s.createElement(o), m s.getElementsByTagName(o)0; a.async 1; a.src g; m.parentNode.insertBefore(a, m) })(window, document, script, //www.google-analytics.com/analytics.js, ga); ga(create, UA-2663638-8, auto); ga(send, pageview); /script>/head>body classindex> header> div classheader__primary js-two-col-header-primary> div classpage-wrap> div> img srcimages/comtele-white.png altComtele classlogo /> /div> nav classjs-hamburger-nav> a hrefhttps://www.postman.com/comtelesms/workspace/comtele target_blank>Postman/a> a hrefhttps://docs.comtele.com.br/sdk>SDK de Exemplo/a> a hrefhttps://comtele.com.br/blog/>Blog/a> a hrefhttps://sms.comtele.com.br/>Login/a> !--a classbtn primary href#>conta teste/a>--> /nav> /div> /div> /header> div classcnt-two-col> div classpage-wrap> section classcnt-two-col__nav js-two-col-nav> nav classside-nav js-side-nav> /nav> nav classside-nav js-side-nav> /nav> nav classside-nav tocify-wrapper active js-side-nav> section idtoc> /section> section idtoc2> ul idtocify-header9 classtocify-header> li classtocify-item data-uniquesdk> a hrefhttps://docs.comtele.com.br/sdk>SDK de Exemplo/a> /li> li> a hrefhttps://www.postman.com/comtelesms/workspace/comtele target_blank>Postman/a> /li> /ul> /section> /nav> /section> section classcnt-two-col__content> h1 idintroducao-api-rest>Introdução API Rest/h1> p>Bem vindo DEV! A API da Comtele é construída no padrão a hrefhttps://restfulapi.net/ target_blank>REST/a>. Nossa API possui URLs previsíveis de acordo com todos recursos servidos por cada endpoint, aceita requisições e retorna utilizando padrão a hrefhttps://www.w3.org/TR/json-ld/ target_blank>JSON/a> e também usa códigos de resposta HTTP padrão, a autenticação é feita via Header e todas as requisições também devem conter ‘Content-Type’: 'application/json’./p> p>Além da API Rest, a Comtele mantem oficialmente pacotes de software para facilitar o desenvolvimento e a vida dos nossos amigos devs. Na Seção strong>SDK/strong> fornecemos instruções básicas sobre como instalar e começar a trabalhar com esses pacotes./p> h3 idgithub>GitHub/h3> p>Oficialmente nós damos suporte strong>apenas/strong> para nossa API REST, mas também criamos alguns EXEMPLOS de SDK OpenSource que podem ser encontradas no GitHub pelos links: a hrefhttps://github.com/comtele/comtele-python-sdk target_blank>Python/a>, a hrefhttps://github.com/comtele/comtele-net-standard-sdk target_blank>.NET/a>, a hrefhttps://github.com/comtele/comtele-net-standard-sdk target_blank>.NET Core/a>, a hrefhttps://github.com/comtele/comtele-nodejs-sdk target_blank>Node/a>, a hrefhttps://github.com/comtele/comtele-java-sdk target_blank>Java/a>, a hrefhttps://github.com/comtele/comtele-ruby-sdk target_blank>Ruby/a>, a hrefhttps://github.com/comtele/comtele-php-sdk target_blank>PHP via composer/a> e a hrefhttps://github.com/comtele/comtele-php-classic-sdk target_blank>importação de arquivos/a>. Com isto, você pode montar seu próprio código/SDK se baseando em nossos exemplos e usando a linguagem de programação que desejar. /p> h2 idurl-base-da-api>URL Base da API/h2> p>code classprettyprint>https://sms.comtele.com.br/api/v2//code>/p> h2 idautenticacao>Autenticação/h2> p>Todas as requisições direcionadas a qualquer recurso da API Rest devem ser autenticadas, a chave de integração está disponível na sua conta em a hrefhttps://sms.comtele.com.br>https://sms.comtele.com.br/a>. No menu lateral, dentro da seção API, clique em Chave de API e você irá para a página de strong>Informações do Desenvolvedor/strong> e lá irá encontrar o campo nomeado como strong>Sua Chave de API./strong> Ela deve ser informada via strong>Header/strong> no seguinte formato: code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code> /p> h2 idcodigos-de-erros>Códigos de Erro/h2> p>Os retornos de erro usam códigos padrões de status HTTP para indicar o tipo de erro que está acontecendo. Na maior parte dos casos, também será retornado via strong>Body/strong> no formato a hrefhttps://www.w3.org/TR/json-ld/ target_blank>JSON/a> um campo que contém uma descrição detalhada sobre o erro. Todos os códigos de erros estão alinhados com a a hrefhttps://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status target_blank>específicação padrão/a>/p> h3 idexemplo-de-erro-http-401-unauthorized>Exemplo de erro HTTP 401 - Unauthorized/h3> p>Neste caso por exemplo, não será retonado corpo em JSON. Apenas o HTTP Status: code classprettyprint>401 - Unauthorized/code> /p> h2 iderros-comuns>Erros Comuns/h2> table> thead> tr> th>HTTP Status/th> th>Error Code/th> th>Description/th> /tr> /thead> tbody> tr> td>400/td> td>BadRequest/td> td>Este erro geralmente ocorre quando algum recurso é acessado sem algum parâmetro necessário ser informado./td> /tr> tr> td>401/td> td>InvalidCredentials/td> td>Erro relacionado a chave de API, pode ter sido informada de maneira incorreta ou não ter sido informada./td> /tr> tr> td>404/td> td>NotFound/td> td>Recurso inexistente, o endpoint informado provavelmente está incorreto./td> /tr> tr> td>405/td> td>MethodNotAllowed/td> td>Este erro está relacionado quando algum recurso é acessado por um método não disponível./td> /tr> tr> td>429/td> td>TooManyRequests/td> td>Este erro ocorre, quando é feita uma quantidade excessiva de requisições na API em um curto período de tempo./td> /tr> tr> td>500/td> td>RequestTimeout/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> tr> td>503/td> td>ServerError/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> /tbody> /table> hr> h1 idenvio-de-sms>Envio de SMS/h1> p>Nesta seção, são abordados todos os recursos disponíveis para envio de SMS. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint./p> h2 idenviar-sms>Enviar SMS/h2> p>Com este recurso, é possivel enviar SMS de forma instantânea.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/send/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/send span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Sender:sender_id,Receivers:phone_number,Content:message}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/send/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Sender:sender_id,Receivers:phone_number,Content:message}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/send/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Sender/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sender_id/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Receivers/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Content/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>message/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Sender\:\sender_id\,\Receivers\:\phone_number\,\Content\:\message\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/send/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/send/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Sender/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sender_id/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Receivers/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Content/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>message/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>não/td> td>Este campo é usado só internamente, e geralmente é bem util para controle. Por exemplo você pode informar um id interno, que ele será exibido no relatório, dispensando que você faça “de para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>strong>Receivers/strong>/td> td>sim/td> td>Destinatários que irão receber o SMS. Para dois ou mais destinatários, separe por uma vírgula os telefones, formato: DDD + Número, pode-se enviar para ate 100 telefones dessa forma./td> /tr> tr> td>strong>Content/strong>/td> td>sim/td> td>Conteúdo da mensagem que vai ser recebida pelo número que o SMS será enviado. Nos casos que o conteúdo do SMS superar 160 caracteres, será tarifado mais de um crédito a cada 153 caracteres. Algumas operadoras como a Oi e Sercomtel não suportam concatenação da mensagens, então serão recebidos SMS separadamente./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: { span classs2>requestUniqueId/span>: span classnb>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> } span classs2>Message/span>: span classs2>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>Neste recurso será nulo, pois não existe objeto a ser retornado./td> /tr> tr> td>RequestUniqueId/td> td>Este campo é o ID da sua requisição./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>É necessário informar ao menos um destinatário que irá receber o SMS./td> /tr> tr> td>400/td> td>O parâmetro ‘Content’ deve ser informado com conteúdo./td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idenviar-sms-regra-de-resposta-automatica>Enviar SMS / Regra de Resposta Automática/h2> p>Com este recurso, é possivel enviar SMS de forma instantânea e quando o SMS for respondido, é possivel enviar uma resposta de forma automática, baseado em um contexto previamente configurado.br> Para utilizar este recurso, é necessário que você acesse a opção “strong>Resposta Automática/strong>” no menu “strong>Configurações/strong>” no painel de SMS, cadastre uma regra de resposta automática e informe o nome que foi cadastrado no campo strong>ContextRuleName/strong> no momento que for usar o endpoint.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/sendcontextmessage/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/sendcontextmessage span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Sender:sender_id,Receivers:phone_number,ContextRuleName:rule_name,ForceContent:force_content}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/sendcontextmessage/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Sender:sender_id,Receivers:phone_number,ContextRuleName:rule_name,ForceContent:force_content}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/sendcontextmessage/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Sender/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sender_id/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Receivers/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ContextRuleName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>rule_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ForceContent/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>force_content/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Sender\:\sender_id\,\Receivers\:\phone_number\,\ContextRuleName\:\rule_name\,\ForceContent\:\force_content\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/sendcontextmessage/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/sendcontextmessage/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Sender/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sender_id/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Receivers/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ContextRuleName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>rule_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ForceContent/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>force_content/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>não/td> td>Este campo é usado só internamente, e geralmente é bem util para controle. Por exemplo você pode informar um id interno, que ele será exibido no relatório, dispensando que você faça “de para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>strong>Receivers/strong>/td> td>sim/td> td>Destinatários que irão receber o SMS. Para dois ou mais destinatários, separe por uma vírgula os telefones, formato: DDD + Número, pode-se enviar para ate 100 telefones dessa forma./td> /tr> tr> td>strong>ContextRuleName/strong>/td> td>sim/td> td>Neste campo deve ser informado o nome da regra que o contexto de resposta foi programado e cadastrado no sistema que no caso será usado neste envio./td> /tr> tr> td>strong>ForceContent/strong>/td> td>não/td> td>Se este campo for preenchido, o conteúdo da mensagem será ele, se ele não for preenchido, o sistema irá usar o conteúdo pré-cadastrado no Painel SMS na Regra de Resposta Automática./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: null, span classs2>Message/span>: span classs2>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>Neste recurso será nulo, pois não existe objeto a ser retornado./td> /tr> tr> td>Content/td> td>Conteúdo da mensagem que foi recebida pelo número retornado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>É necessário informar ao menos um destinatário que irá receber o SMS./td> /tr> tr> td>400/td> td>E necessario informar o nome da regra de resposta automatica./td> /tr> tr> td>400/td> td>Nao foi possivel encontrar uma regra de resposta automatica cadastrada com o nome informado. /td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idenviar-sms-grupos-de-contatos>Enviar SMS / Grupos de Contatos/h2> p>Com este recurso, é possivel enviar SMS de forma instantânea para um grupo de contatos.br> Para usar este recuso, é necessário ter grupos de contatos já cadastrados em nossa aplicação, caso ainda não tenha feito isso, dê uma olhadinha no recurso a href#cadastrar-grupos-de-contatos>Cadastrar / Grupos de Contatos/a> e a href#cadastrar-contatos-grupos-de-contatos>Cadastrar Contatos / Grupos de Contatos/a>br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/sendcontactmessage/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/sendcontactmessage span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Sender:sender_id,Content:message,GroupName:group_name}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/sendcontactmessage/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Sender:sender_id,Content:message,GroupName:group_name}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/sendcontactmessage/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Sender/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sender_id/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Content/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>message/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>GroupName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>group_name/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Sender\:\sender_id\,\Content\:\message\,\GroupName\:\group_name\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/sendcontactmessage/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/sendcontactmessage/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Sender/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sender_id/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Content/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>message/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>GroupName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>group_name/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>não/td> td>Este campo é usado só internamente, e geralmente é bem util para controle. Por exemplo você pode informar um id interno, que ele será exibido no relatório, dispensando que você faça “de para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>strong>Content/strong>/td> td>sim/td> td>Conteúdo da mensagem que vai ser recebida pelo número que o SMS será enviado. Nos casos que o conteúdo do SMS superar 160 caracteres, será tarifado mais de um crédito a cada 153 caracteres. Algumas operadoras como a Oi e Sercomtel não suportam concatenação da mensagens, então serão recebidos SMS separadamente./td> /tr> tr> td>strong>GroupName/strong>/td> td>sim/td> td>Nome do grupo de contatos, com todos os telefones que receberão o SMS./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: null, span classs2>Message/span>: span classs2>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>Neste recurso será nulo, pois não existe objeto a ser retornado./td> /tr> tr> td>Content/td> td>Conteúdo da mensagem que foi recebida pelo número retornado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>E necessario informar o grupo de contatos que irao receber o SMS/td> /tr> tr> td>400/td> td>Nao foi possivel encontrar um grupo de contatos cadastrado com o nome informado./td> /tr> tr> td>400/td> td>O parâmetro 'Content’ deve ser informado com conteúdo./td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h1 idagendamento-de-sms>Agendamento de SMS/h1> p>Nesta seção, são abordados todos os recursos disponíveis para envio de SMS agendado. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint./p> h2 idagendar-sms>Agendar SMS/h2> p>Com este recurso, é possivel programar a data e horário de envio de SMS para serem enviados.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/schedule/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell>curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/schedule span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Sender:sender_id,Receivers:phone_number,Content:message,ScheduleDate:send_in}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/schedule/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Sender:sender_id,Receivers:phone_number,Content:message,ScheduleDate:send_in}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/schedule/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Sender/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sender_id/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Receivers/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Content/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>message/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ScheduleDate/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>send_in/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Sender\:\sender_id\,\Receivers\:\phone_number\,\Content\:\message\,\ScheduleDate\:\send_in\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/schedule/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/schedule/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Sender/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sender_id/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Receivers/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Content/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>message/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ScheduleDate/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>send_in/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>não/td> td>Este campo é usado só internamente, e geralmente é bem util para controle. Por exemplo você pode informar um id interno, que ele será exibido no relatório, dispensando que você faça “de para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>strong>Receivers/strong>/td> td>sim/td> td>Destinatários que irão receber o SMS. Para dois ou mais destinatários, separe por uma vírgula os telefones, formato: DDD + Número, pode-se enviar para ate 100 telefones dessa forma./td> /tr> tr> td>strong>Content/strong>/td> td>sim/td> td>Conteúdo da mensagem que vai ser recebida pelo número que o SMS será enviado. Nos casos que o conteúdo do SMS superar 160 caracteres, será tarifado mais de um crédito a cada 153 caracteres. Algumas operadoras como a Oi e Sercomtel não suportam concatenação da mensagens, então serão recebidos SMS separadamente./td> /tr> tr> td>strong>ScheduleDate/strong>/td> td>sim/td> td>Data de agendamento que o SMS deve ser disparado, padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: { span classs2>requestUniqueId/span>: span classnb>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> } span classs2>Message/span>: span classs2>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>Neste recurso será nulo, pois não existe objeto a ser retornado./td> /tr> tr> td>RequestUniqueId/td> td>Este campo é o ID da sua requisição./td> /tr> tr> td>Content/td> td>Conteúdo da mensagem que foi recebida pelo número retornado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>É necessário informar ao menos um destinatário que irá receber o SMS./td> /tr> tr> td>400/td> td>O parâmetro ‘Content’ deve ser informado com conteúdo./td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>400/td> td>A data de agendamento não pode ser retroativa./td> /tr> tr> td>400/td> td>O parametro 'ScheduleDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idagendar-sms-regra-de-resposta-automatica>Agendar SMS / Regra de Resposta Automática/h2> p>Com este recurso, é possivel programar a data e horário de envio de SMS para serem enviados, e quando o SMS for respondido, é possivel enviar uma resposta de forma automática, baseado em um contexto previamente configurado.br> Para utilizar este recurso, é necessário que você acesse a opção “strong>Resposta Automática/strong>” no menu “strong>Configurações/strong>” no painel de SMS, cadastre uma regra de resposta automática e informe o nome que foi cadastrado no campo strong>ContextRuleName/strong> no momento que for usar o endpoint.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/schedulecontextmessage/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/schedulecontextmessage span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Sender:sender_id,Receivers:phone_number,ScheduleDate:send_in,ContextRuleName:rule_name,ForceContent:force_content}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/schedulecontextmessage/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Sender:sender_id,Receivers:phone_number,ScheduleDate:send_in,ContextRuleName:rule_name,ForceContent:force_content}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/schedulecontextmessage/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Sender/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sender_id/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Receivers/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ScheduleDate/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>send_in/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ContextRuleName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>rule_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ForceContent/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>force_content/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Sender\:\sender_id\,\Receivers\:\phone_number\,\ScheduleDate\:\send_in\,\ContextRuleName\:\rule_name\,\ForceContent\:\force_content\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/schedulecontextmessage/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/schedulecontextmessage/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Sender/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sender_id/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Receivers/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ScheduleDate/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>send_in/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ContextRuleName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>rule_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ForceContent/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>force_content/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>não/td> td>Este campo é usado só internamente, e geralmente é bem util para controle. Por exemplo você pode informar um id interno, que ele será exibido no relatório, dispensando que você faça “de para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>strong>Receivers/strong>/td> td>sim/td> td>Destinatários que irão receber o SMS. Para dois ou mais destinatários, separe por uma vírgula os telefones, formato: DDD + Número, pode-se enviar para ate 100 telefones dessa forma./td> /tr> tr> td>strong>ContextRuleName/strong>/td> td>sim/td> td>Neste campo deve ser informado o nome da regra que o contexto de resposta foi programado e cadastrado no sistema que no caso será usado neste envio./td> /tr> tr> td>strong>ScheduleDate/strong>/td> td>sim/td> td>Data de agendamento que o SMS deve ser disparado, padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> tr> td>strong>ForceContent/strong>/td> td>não/td> td>Se este campo for preenchido, o conteúdo da mensagem será ele, se ele não for preenchido, o sistema irá usar o conteúdo pré-cadastrado no Painel SMS na Regra de Resposta Automática./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: null, span classs2>Message/span>: span classs2>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./span> span classo>}/span>/code>/pre> /div> /div> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>É necessário informar ao menos um destinatário que irá receber o SMS./td> /tr> tr> td>400/td> td>E necessario informar o nome da regra de resposta automatica./td> /tr> tr> td>400/td> td>Nao foi possivel encontrar uma regra de resposta automatica cadastrada com o nome informado. /td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>400/td> td>A data de agendamento não pode ser retroativa./td> /tr> tr> td>400/td> td>O parametro 'ScheduleDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idagendar-sms-grupos-de-contatos>Agendar SMS / Grupos de Contatos/h2> p>Com este recurso, é possivel programar a data e horário de envio de SMS para um grupo de contatos.br> Para usar este recuso, é necessário ter grupos de contatos já cadastrados em nossa aplicação, caso ainda não tenha feito isso, dê uma olhadinha no recurso a hrefhttp://149.28.193.51:4567/#cadastrar-grupos>Cadastrar Grupos/a> e a hrefhttp://149.28.193.51:4567/#>Adicionar Contatos / Grupos/a>br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/schedulecontactmessage/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell>curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/schedulecontactmessage span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Sender:sender_id,Content:message,GroupName:group_name,ScheduleDate:send_in}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/schedulecontactmessage/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Sender:sender_id,Content:message,GroupName:group_name,ScheduleDate:send_in}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby>span classnb>require/span> span classs1>uri/span>span classnb>require/span> span classs1>net/http/span>span classnb>require/span> span classs1>openssl/span>span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/schedulecontactmessage/span>span classp>)/span>span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span>span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span>span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span>span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span>span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span>span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Sender/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sender_id/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Content/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>message/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>GroupName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>group_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ScheduleDate/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>send_in/span>span classse>\/span>span classs2>}/span>span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript>span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Sender\:\sender_id\,\Content\:\message\,\GroupName\:\group_name\,\ScheduleDate\:\send_in\}/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span>span classp>});/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/schedulecontactmessage/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython>span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/schedulecontactmessage/span>span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Sender/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sender_id/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Content/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>message/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>GroupName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>group_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ScheduleDate/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>send_in/span>span classse>\/span>span classs>}/span>span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>não/td> td>Este campo é usado só internamente, e geralmente é bem util para controle. Por exemplo você pode informar um id interno, que ele será exibido no relatório, dispensando que você faça “de para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>strong>Content/strong>/td> td>sim/td> td>Conteúdo da mensagem que vai ser recebida pelo número que o SMS será enviado. Nos casos que o conteúdo do SMS superar 160 caracteres, será tarifado mais de um crédito a cada 153 caracteres. Algumas operadoras como a Oi e Sercomtel não suportam concatenação da mensagens, então serão recebidos SMS separadamente./td> /tr> tr> td>strong>GroupName/strong>/td> td>sim/td> td>Nome do grupo de contatos, com todos os telefones que receberão o SMS./td> /tr> tr> td>strong>ScheduleDate/strong>/td> td>sim/td> td>Data de agendamento que o SMS deve ser disparado, padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: null, span classs2>Message/span>: span classs2>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./span> span classo>}/span>/code>/pre> /div> /div> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A requisicao de envio foi encaminhada para processamento com sucesso. Voce podera acompanhar o status pelos relatorios./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>E necessario informar o grupo de contatos que irao receber o SMS/td> /tr> tr> td>400/td> td>Nao foi possivel encontrar um grupo de contatos cadastrado com o nome informado./td> /tr> tr> td>400/td> td>O parâmetro 'Content’ deve ser informado com conteúdo./td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>400/td> td>A data de agendamento não pode ser retroativa./td> /tr> tr> td>400/td> td>O parametro 'ScheduleDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idcancelar-agendamento>Cancelar Agendamento de SMS/h2> p>Com este recurso, é possível cancelar o agendamento de SMSbr> br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/cancelrequest/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell>curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/cancelrequest span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{RequestUniqueId:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript>span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/cancelrequest/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{RequestUniqueId:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby>span classnb>require/span> span classs1>uri/span>span classnb>require/span> span classs1>net/http/span>span classnb>require/span> span classs1>openssl/span>span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/cancelrequest/span>span classp>)/span>span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span>span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span>span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span>span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span>span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span>span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>RequestUniqueId/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classse>\/span>span classs2>}/span>span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript>span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\RequestUniqueId\:\XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX\}/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span>span classp>});/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/cancelrequest/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython>span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/cancelrequest/span>span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>RequestUniqueId/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classse>\/span>span classs>}/span>span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>RequestUniqueId/td> td>Sim/td> td>Este campo é retornado na criação do agendamento do SMS./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: { span classs2>requestUniqueId/span>: span classnb>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> } span classs2>Message/span>: span classs2>As mensagens do token informado que ainda estavam em rota de processamento foram canceladas./span> span classo>}/span>/code>/pre> /div> /div> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>As mensagens do token informado que ainda estavam em rota de processamento foram canceladas. /td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>E necessario informar o grupo de contatos que irao receber o SMS/td> /tr> tr> td>400/td> td>Nao foi possivel encontrar um grupo de contatos cadastrado com o nome informado./td> /tr> tr> td>400/td> td>O parâmetro 'Content’ deve ser informado com conteúdo./td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>400/td> td>A data de agendamento não pode ser retroativa./td> /tr> tr> td>400/td> td>O parametro 'ScheduleDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h1 idautenticao-dois-fatores-via-sms>Autenticação Dois Fatores via SMS/h1> p>Nesta seção, são abordados dois recursos disponíveis para envio de SMS no cenário de autenticacão em dois fatores, por meio destes recursos, a Comtele automaticamente gera o código, envia e valida de acordo com o retorno do seu destinatário, dispensando você ter que desenvolver este controle em sua aplicação. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint./p> h2 idenviar-sms-dois-fatores>Enviar SMS / Dois Fatores/h2> p>Com este recurso, é possivel enviar via SMS de forma instantânea um código de autenticação para o destinatário, que pode ser validado posteriormente no endpoint a seguir: a href#validar-codigo-dois-fatores>Validar Código / Dois Fatores/a>./p> p>strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/tokenmanager/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/tokenmanager span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{ PhoneNumber:phone_number, Prefix:company_from, EnforceSecureValidation:bool, ExpireInMinutes:minute }/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/tokenmanager/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{ PhoneNumber:phone_number, Prefix:company_from, EnforceSecureValidation:bool, ExpireInMinutes:minute }/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/tokenmanager/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>PhoneNumber/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Prefix/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>company_from/span>span classse>\/span>span classse>\/span>span classs2>EnforceSecureValidation/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>bool/span>span classse>\/span>span classse>\/span>span classs2>ExpireInMinutes/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>minute/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\PhoneNumber\:\phone_number\,\Prefix\:\company_from\,\EnforceSecureValidation\:\bool\,\ExpireInMinutes\:\minute\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/tokenmanager/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/tokenmanager/span> span classn>payload/span> span classo>/span> span classs>{/span> span classse>\/span>span classs>PhoneNumber/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>,/span> span classse>\/span>span classs>Prefix/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>company_from/span>span classse>\/span>,/span> span classse>\/span>span classs>EnforceSecureValidation/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>bool/span>span classse>\/span>,/span> span classse>\/span>span classs>ExpireInMinutes/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>minute/span>span classse>\/span> span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>PhoneNumber/strong>/td> td>sim/td> td>Número de telefone do destinatário que você quer enviar um código para autenticação de dois fatores./td> /tr> tr> td>Prefix/td> td>não/td> td>Neste campo, você pode informar ao destinatário a origem do token recebido, por exemplo: Sua Empresa: Codigo de Autorizacao xxxxxx./td> /tr> tr> td>EnforceSecureValidation/td> td>não/td> td>Usando este recurso, a validação do token será realizada em conjunto com número de telefone que foi enviado. É necessário informar o telefone no momento da validação./td> /tr> tr> td>ExpireInMinutes/td> td>não/td> td>Neste campo, você pode informar qual o limite em minutos que o token poderá ser validado./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Prefix/span>: span classs2>/span>, span classs2>PhoneNumber /span>: span classs2>,/span> span classs2>ExpireInMinutes/span>: span classs2>,/span> span classs2>EnforceSecureValidation/span>: span classs2>/span> span classo>}/span>, span classs2>Message/span>: span classs2>O token foi criado com sucesso./span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Prefix/td> td>Será retornado o prefixo que foi informado/td> /tr> tr> td>PhoneNumber/td> td>Será retornado o telefone que foi informado/td> /tr> tr> td>ExpireInMinutes/td> td>Será retornado o tempo de expiração do token em minutos que foi informado/td> /tr> tr> td>EnforceSecureValidation/td> td>Será retornada a opção que foi informada/td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O token foi criado com sucesso./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>É necessário informar ao menos um destinatário que irá receber o SMS./td> /tr> tr> td>400/td> td>Não foi possível continuar, pois a quantidade de créditos é insuficiente. Para efetuar o envio é necessário ao menos 1 créditos./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idvalidar-codigo-dois-fatores>Validar Código / Dois Fatores/h2> p>Com este recurso, é possivel validar o token recebido e informado pelo usuário que recebeu o SMS, enviado pelo endpoint anterior anterior: a href#enviar-sms-dois-fatores>Enviar SMS / Dois Fatores/a>./p> p>strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/tokenmanager/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>PUT/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request PUT span classse>\/span> --url https://sms.comtele.com.br/api/v2/tokenmanager span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{TokenCode:inputed_user_token,PhoneNumber:phone_number}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>PUT/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/tokenmanager/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{TokenCode:inputed_user_token,PhoneNumber:phone_number}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/tokenmanager/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Put/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>TokenCode/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>inputed_user_token/span>span classse>\,/span>span classse>\/span>span classs2>PhoneNumber/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span>span classs2>{\TokenCode\:\inputed_user_token\,\PhoneNumber\:\phone_number\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>PUT/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/tokenmanager/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/tokenmanager/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>TokenCode/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>inputed_user_token/span>span classse>\,/span>span classs>PhoneNumber/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>PUT/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>TokenCode/strong>/td> td>sim/td> td>Token recebido pelo usuário, e que deve ser informado para ser realizada a validação./td> /tr> tr> td>PhoneNumber/td> td>não/td> td>Número de telefone do destinatário que será validado juntamente com o token recebido, caso a opção EnforceSecureValidation: true tenha sido utilizada, para que seja verificado se o token utilizado realmente pertence ao numero de telefone cadastrado./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>TokenCode/span>: span classs2>XXXXXX,/span> span classs2>PhoneNumber/span>: span classs2>DDD+Telefone/span> span classo>}/span>, span classs2>Message/span>: span classs2>O token informado foi validado com sucesso./span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>TokenCode/td> td>Token que foi recebido e inserido para ser validado./td> /tr> tr> td>PhoneNumber/td> td>Número de telefone caso tenha sido utilizado o campo EnforceSecureValidation: true, para aumentar a segurança de validação e validar o número de telefone e token recebido./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O token informado foi validado com sucesso./td> /tr> tr> td>400/td> td>O código informado está expirado./td> /tr> tr> td>400/td> td>O código informado é inválido para este telefone./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>É necessário informar ao menos um destinatário que irá receber o SMS./td> /tr> tr> td>400/td> td>O token informado é invalido./td> /tr> tr> td>400/td> td>Este token já foi utilizado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> tr> td>503/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> /tbody> /table> h1 idrelatorios>Relatórios/h1> p>Nesta seção, são abordados todos os recursos disponíveis para consulta de SMS enviados. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint. /p> h2 idconsultar-relatorio-detalhado>Consultar Relatório / Detalhado. /h2> p>Com este recurso, é possivel consultar todos os detalhes disponíveis dos SMS enviados. br>Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recursos de strong>Relatório de Regra de Resposta Automática, Relatório de Respostas e Histórico de Recargas/strong>, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/detailedreporting/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 475px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/detailedreporting?StartDatebegin_search_data&EndDateend_search_data&Deliveredfilter_status&Receiverreceiver&RequestUniqueIdunique_id/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/detailedreporting/span>span classp>,/span> span classna>qs/span>span classp>:/span> span classp>{/span> span classna>StartDate/span>span classp>:/span> span classs1>begin_search_data/span>span classp>,/span> span classna>EndDate/span>span classp>:/span> span classs1>end_search_data/span>span classp>,/span> span classna>Delivered/span>span classp>:/span> span classs1>filter_status/span>span classp>,/span> span classna>Receiver/span>span classp>:/span> span classs1>receiver/span>span classp>,/span> span classna>RequestUniqueId/span>span classp>:/span> span classs1>unique_id/span> span classp>},/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/detailedreporting?StartDatebegin_search_data&EndDateend_search_data&Deliveredfilter_status&Receiverreceiver&RequestUniqueIdunique_id/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/detailedreporting?StartDatebegin_search_data&EndDateend_search_data&Deliveredfilter_status&Receiverreceiver&RequestUniqueIdunique_id/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/detailedreporting/span> span classn>querystring/span> span classo>/span> span classp>{/span>span classs>StartDate/span>span classp>:/span>span classs>begin_search_data/span>span classp>,/span>span classs>EndDate/span>span classp>:/span>span classs>end_search_data/span>span classp>,/span>span classs>Delivered/span>span classp>:/span>span classs>filter_status/span>span classp>,/span>span classp>span classs>Receiver/span>span classp>:/span>span classs>receiver/span>span classp>,/span>span classs>RequestUniqueId/span>span classp>:/span>span classs>unique_id/span>}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>querystring/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatorio/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>StartDate/strong>/td> td>sim/td> td>Data inicial do período que os envios serão consultados. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> tr> td>strong>EndDate/strong>/td> td>sim/td> td>Data final do período que os envios serão consultados. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> tr> td>Delivered/td> td>não/td> td>Status de entrega dos SMS poderão ser filtrados e retornados nos relatórios. Os valores ‘option’ podem ser substituído por 'all’, para ser exibido todos os SMS entregues e não entregues no período; 'true’ para exibir apenas os SMS entregues; Por fim 'false’ para exibir somente os SMS não entregues./td> /tr> tr> td>Receiver/td> td>não/td> td>Destinatário que recebeu o SMS no formato: 55+DDD+Número./td> /tr> tr> td>RequestUniqueId/td> td>não/td> td>Este campo é retornado no envio do SMS e pode ser armazenado na sua base./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>/span> span classo>{/span> span classs2>Receiver/span>: span classs2>/span>, span classs2>Content/span>: span classs2>/span>, span classs2>Status/span>: span classs2>/span>, span classs2>ScheduleDate/span>: span classs2>/span>, span classs2>RequestDate/span>: span classs2>/span>, span classs2>SystemMessage/span>: span classs2>/span>, span classs2>DlrStatus/span>: span classs2>/span>, span classs2>Sender/span>: span classs2>/span>, span classs2>Credits/span>: int/span> span classo>}/span> span classo>/span>, span classs2>Message/span>: nullspan classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Receiver/td> td>Destinatários que receberam o SMS. Formato: DDD + Número./td> /tr> tr> td>Content/td> td>Conteúdo da mensagem que foi recebida pelo número retornado./td> /tr> tr> td>Status/td> td>É o campo de status do SMS enviado, pode ser retornado strong>Processed/strong>, para SMS que estão na fila de entrega; strong>Delivered/strong> para SMS entregues; strong>Error/strong> para casos que ocorreu algum erro no envio e o SMS não foi entregue./td> /tr> tr> td>ScheduleDate/td> td>É o campo que retorna a data que o SMS foi agendado, caso tenha sido feito agendamento, se o envio foi realizado de forma instantânea será retornado strong>null/strong>. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> tr> td>RequestDate/td> td>É o campo que retorna a data que o SMS foi requisitado. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)/td> /tr> tr> td>SystemMessage/td> td>Mensagem detalhada sobre o resultado da operação.br> strong>Retornos previsíveis:/strong>br> strong>A mensagem não foi enviada, pois não foi aceita pela operadora de destino./strong> br>• Não tarifado: Quando o número de telefone é válido, segue os padrões numéricos, mas não foi encontrado em nenhuma operadora. Ou seja, é um número inexistente. br> strong>A mensagem não foi enviada, pois foi rejeitada pela operadora de destino./strong>br>• Tarifado: O conteúdo da mensagem pode ter violado alguma regra estabelecida nos termos e condições de uso. Ex: conteúdo impróprio, uso indevido de alguma marca ou instituição que exige autorização para veiculação de conteúdo. br> strong>Envio cancelado pelo usuário./strong>br>• Não Tarifado: Quando há um agendamento e o mesmo foi cancelado antes do envio ter sido realizado às operadoras. br> strong>A mensagem não foi enviada, pois foi recusada pela operadora de destino./strong>br>• Não Tarifado: Quando a entrega não pode ser realizada por recusa técnica das operadoras. Pode ocorrer se houverem problemas técnicos e de indisponibilidade temporária na operadora. br> strong>A mensagem foi entregue a operadora, porém não foi entregue ao destinatário final./strong>br>• Tarifado: Quando a entrega não pode ser realizada, geralmente ocorre para um número de telefone desativado permanentemente há muito tempo. br> strong>A mensagem não pode ser enviada, pois excedeu o limite de tentativas./strong>br>• Não Tarifado: Quando esgotamos as tentativas de reenviar suas mensagens caso a operadora tenha retornado algum problema temporário que impossibilitou a entrega ser efetuada. br> strong>A mensagem foi enviada com sucesso para a operadora./strong>br>• Tarifado. Sua mensagem passou pelas pré-validações e está com a operadora para ser entregue ao celular de destino. Nessa etapa o tempo pode sofrer alguns atrasos por diversas questões. Ex: sinal de rede, aparelho desligado e configurações específicas do aparelho. br> strong>A mensagem não foi enviada, pois o número informado não é válido./strong>br>• Não Tarifado. O número informado não segue os padrões de números válidos. br> strong>O destinatário, remetente ou conteúdo está em branco./strong>br>• Não Tarifado. Ops, você esqueceu de inserir o destinatário ou sua mensagem. br> strong>O destinatário encontra-se em sua Lista de Bloqueios e não pode receber mensagens./strong>br>• Não Tarifado. Você anteriormente adicionou esse número em sua lista de restrições e por isso essa mensagem não pode seguir. /td> /tr> tr> td>DlrStatus/td> td>É o campo que informa mais detalhes sobre status do SMS enviado, pode ser retornado strong>Delivered/strong> para SMS entregues; strong>Undelivered/strong> para SMS não entregues; strong>Rejected/strong> para SMS que foram rejeitados por possuir conteúdo inadequado ou telefone incorreto; strong>Expired/strong> para SMS que excederam o limite de tentativas de entrega; strong>Accepted/strong>, para SMS que estão na fila de entrega /td> /tr> tr> td>Sender/td> td>Este campo é o que foi passado um id interno no endpoint de envio do SMS. Ele dispensam que você faça “de/para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>Credits/td> td>Retorna a quantidade de créditos consumidos na mensagem./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes de SMS enviados de acordo com a data selecionada. /td> /tr> tr> td>202/td> td>Nao foi possivel continuar, pois este metodo da API possui limite de tempo entre requisicoes. O tempo de espera entre sua ultima requisicao e esta e de 30 segundos e ainda faltam XX segundos. /td> /tr> tr> td>400/td> td>O parametro 'StartDate’ deve ser informado com conteudo./td> /tr> tr> td>400/td> td>O parametro 'EndDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-relatorio-regra-de-resposta-automatica>Consultar Relatório / Regra de resposta automática /h2> p>Com este recurso, é possivel consultar todos os detalhes disponíveis dos SMS enviados/recebidos utilizando a funcionalidade de regra de resposta automatica. br> Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recursos de strong>Relatório Detalhado, Relatório de Respostas e Histórico de Recargas/strong>, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas./p> p>strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/contextreporting/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 505px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/contextreporting?StartDatebegin_search_data&EndDateend_search_data&ContextRuleNamerule_name/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/contextreporting/span>span classp>,/span> span classna>qs/span>span classp>:/span> span classp>{/span> span classna>StartDate/span>span classp>:/span> span classs1>begin_search_data/span>span classp>,/span> span classna>EndDate/span>span classp>:/span> span classs1>end_search_data/span>span classp>,/span> span classna>ContextRuleName/span>span classp>:/span> span classs1>rule_name/span> span classp>},/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/contextreporting?StartDatebegin_search_data&EndDateend_search_data&ContextRuleNamerule_name/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/contextreporting?StartDatebegin_search_data&EndDateend_search_data&ContextRuleNamerule_name/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/contextreporting/span> span classn>querystring/span> span classo>/span> span classp>{/span>span classs>StartDate/span>span classp>:/span>span classs>begin_search_data/span>span classp>,/span>span classs>EndDate/span>span classp>:/span>span classs>end_search_data/span>span classp>,/span>span classs>ContextRuleName/span>span classp>:/span>span classs>rule_name/span>span classp>}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>querystring/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>StartDate/strong>/td> td>sim/td> td>Data inicial do período que os envios serão consultados. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)./td> /tr> tr> td>strong>EndDate/strong>/td> td>sim/td> td>Data final do período que os envios serão consultados. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)./td> /tr> tr> td>ContextRuleName/td> td>não/td> td>Neste campo pode ser informado o nome da regra que o contexto de resposta foi programado e cadastrado no sistema para filtrar os resultados somente de uma regra, se não for informado não será aplicado filtro e todos os dados serão exibidos./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>/span> span classo>{/span> span classs2>Sender/span>: span classs2>/span>, span classs2>Content/span>: span classs2>/span>, span classs2>Received/span>: span classs2>/span>, span classs2>ContextRuleName/span>: span classs2>/span>, span classs2>StatusMessage/span>: span classs2>/span> span classo>}/span> span classo>/span>, span classs2>Message/span>: nullspan classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Sender/td> td>Este campo é o que foi passado um id interno no endpoint de envio do SMS. Ele dispensam que você faça “de/para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>Content/td> td>Conteúdo da mensagem que foi recebida pelo número retornado./td> /tr> tr> td>ContextRuleName/td> td>Nome da regra que o contexto de resposta foi utilizado./td> /tr> tr> td>StatusMessage/td> td>É o campo de status que determina a direção do SMS, se é strong>Enviado/strong> ou strong>Recebido/strong>. /td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes de SMS enviados de acordo com a data selecionada. /td> /tr> tr> td>202/td> td>Nao foi possivel continuar, pois este metodo da API possui limite de tempo entre requisicoes. O tempo de espera entre sua ultima requisicao e esta e de 30 segundos e ainda faltam XX segundos. /td> /tr> tr> td>400/td> td>O parametro 'StartDate’ deve ser informado com conteudo./td> /tr> tr> td>400/td> td>O parametro 'EndDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-relatorio-respostas>Consultar Relatório / Respostas/h2> p>Com este recurso, é possivel consultar todos os detalhes disponíveis dos SMS recebidos utilizando a funcionalidade de recebimento de respostas. br> Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recursos de strong>Relatório Detalhado, Relatório de Regra de Resposta Automática e Histórico de Recargas/strong>, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas./p> p>strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/replyreporting/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 505px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/replyreporting?StartDatebegin_search_data&EndDateend_search_data&Senderphone_number&SenderNamesender/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/replyreporting/span>span classp>,/span> span classna>qs/span>span classp>:/span> span classp>{/span> span classna>StartDate/span>span classp>:/span> span classs1>begin_search_data/span>span classp>,/span> span classna>EndDate/span>span classp>:/span> span classs1>end_search_data/span>span classp>,/span> span classna>Sender/span>span classp>:/span> span classs1>phone_number/span> span classna>SenderName/span>span classp>:/span> span classs1>sender/span> span classp>},/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/replyreporting?StartDatebegin_search_data&EndDateend_search_data&Senderphone_number&SenderNamesender/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/replyreporting?StartDatebegin_search_data&EndDateend_search_data&Senderphone_number&SenderNamesender/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/replyreporting/span> span classn>querystring/span> span classo>/span> span classp>{/span>span classs>StartDate/span>span classp>:/span>span classs>begin_search_data/span>span classp>,/span>span classs>EndDate/span>span classp>:/span>span classs>end_search_data/span>span classp>,/span>span classs>Sender/span>span classp>:/span>span classs>phone_number/span>span classp>,/span>span classs>SenderName/span>span classp>:/span>span classs>sender/span>span classp>}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>querystring/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>StartDate/strong>/td> td>sim/td> td>Data inicial do período que os envios serão consultados. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)./td> /tr> tr> td>strong>EndDate/strong>/td> td>sim/td> td>Data final do período que os envios serão consultados. Padrão ISO8601 formato: YYYY-MM-DDThh:mm:ss.sTZD (eg 1997-07-16T19:20:30.45-02:00)./td> /tr> tr> td>Sender/td> td>não/td> td>Pode ser passado em branco caso não queira filtrar uma resposta. É o número do telefone de quem ou o que respondeu o SMS./td> /tr> tr> td>SenderName/td> td>não/td> td>Pode ser passado em branco caso não queira filtrar uma resposta. É o Sender que foi enviado no Envio do SMS./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>/span> span classo>{/span> span classs2>Sender/span>: span classs2>/span>, span classs2>SentContent/span>: span classs2>/span>, span classs2>ReceivedContent/span>: span classs2>/span>, span classs2>ReceivedDate/span>: span classs2>/span>, span classs2>SenderName/span>: span classs2>/span> span classo>}/span> span classo>/span>, span classs2>Message/span>: nullspan classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Sender/td> td>Este campo, diferentemente dos outros endpoints com recursos de relatório, é o número do telefone de quem ou o que respondeu o SMS, número de origem da resposta recebida./td> /tr> tr> td>SentContent/td> td>Conteúdo da mensagem que foi enviada para o número do telefone de destino../td> /tr> tr> td>ReceivedContent/td> td>Conteúdo da mensagem respondida pelo número do telefone de destino./td> /tr> tr> td>ReceivedDate/td> td>Data que a resposta foi recebida./td> /tr> tr> td>SenderName/td> td>Este campo é o que foi passado um id interno no endpoint de envio do SMS. Ele dispensam que você faça “de/para” dos ids da Comtele com o sistema que está integrando./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes de SMS enviados de acordo com a data selecionada. /td> /tr> tr> td>202/td> td>Nao foi possivel continuar, pois este metodo da API possui limite de tempo entre requisicoes. O tempo de espera entre sua ultima requisicao e esta e de 30 segundos e ainda faltam XX segundos. /td> /tr> tr> td>400/td> td>O parametro 'StartDate’ deve ser informado com conteudo./td> /tr> tr> td>400/td> td>O parametro 'EndDate’ deve ser informado com conteudo./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idreceber-respostas-callback>Receber Respostas / Callback/h2> p>Com este recurso, é possivel receber ao invés de consultar todos os detalhes disponíveis dos SMS recebidos utilizando a funcionalidade de recebimento de respostas. /p> h5 idconfigurao-da-url>Configuração da URL/h5> p>Antes de mais nada, para receber as respostas via callback, é necessário que você ja tenha construído em sua aplicação um webhook para receber a resposta no padrão a seguir, além disso é necessário que o endpoint do seu webhook seja público e que você tenha configurado em sua conta seguindo os seguintes passos:br> strong>1/strong> - Acessar o painel em https://sms.comtele.com.br, e inserir os dados de acesso de sua conta.br> strong>2/strong> - Na opção strong>Configurações/strong> do menu lateral, clique em strong>Alterar Meus Dados/strong>.br> strong>3/strong> - Na tela de edição dos seus dados pessoais, localize a seção strong>CONFIGURAÇÕES/strong> e a opção strong>URL de Callback de Respostas/strong>, insira a URL do webhook que irá receber as respostas e clique no botão strong>salvar/strong>.br> Feito esses passos, em um intervalo máximo de 30 minutos, todas as respostas que estiverem atrelados aos SMS enviados pelo seu usuário serão retornados via callback. /p> h5 idexemplo-do-objeto-da-resposta>Exemplo do objeto da resposta/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Sender/span>:string, span classs2>SentContent/span>:string, span classs2>ReceivedContent/span>:string, span classs2>ReceiveDate/span>:span classs2>YYYY-MM-DDThh:mm:ss.sTZD/span>, span classs2>SenderName/span>:string span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>Este campo, diferentemente dos outros endpoints com recursos de relatório, é o número do telefone de quem ou o que respondeu o SMS, número de origem da resposta recebida./td> /tr> tr> td>SentContent/td> td>Conteúdo da mensagem que foi enviada para o número do telefone de destino./td> /tr> tr> td>ReceivedContent/td> td>Conteúdo da mensagem respondida pelo número do telefone de destino./td> /tr> tr> td>ReceivedDate/td> td>Data que a resposta foi recebida./td> /tr> tr> td>SenderName/td> td>Este campo é o que foi passado um id interno no endpoint de envio do SMS. Ele dispensam que você faça “de/para” dos ids da Comtele com o sistema que está integrando./td> /tr> /tbody> /table> h2 idreceber-status-callback>Receber Status / Callback/h2> p>Com este recurso, é possivel receber os Status do seu SMS em tempo real. /p> h5 idconfigurao-da-url>Configuração da URL/h5> p>Antes de mais nada, para receber os status via callback, é necessário que você ja tenha construído em sua aplicação um webhook para receber a resposta no padrão a seguir, além disso é necessário que o endpoint do seu webhook seja público e que você tenha configurado em sua conta seguindo os seguintes passos:br> strong>1/strong> - Acessar o painel em https://sms.comtele.com.br, e inserir os dados de acesso de sua conta.br> strong>2/strong> - Na opção strong>Configurações/strong> do menu lateral, clique em strong>Alterar Meus Dados/strong>.br> strong>3/strong> - Na tela de edição dos seus dados pessoais, localize a seção strong>CONFIGURAÇÕES/strong> e a opção strong>URL de Callback de Status/strong>, insira a URL do webhook que irá receber as respostas e clique no botão strong>salvar/strong>.br> Feito esses passos, em um intervalo máximo de 30 minutos, todas os status que estiverem atrelados aos SMS enviados pelo seu usuário serão retornados via callback. /p> h5 idexemplo-do-objeto-da-resposta>Exemplo do objeto da resposta/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Sender/span>:string, span classs2>Status/span>:string, span classs2>PhoneNumber/span>:string, span classs2>StatusDate/span>:span classs2>YYYY-MM-DDThh:mm:ss.sTZD/span>, span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Sender/td> td>Este campo é o que foi passado um id interno no endpoint de envio do SMS./td> /tr> tr> td>Status/td> td>É o campo de status do SMS enviado, ele retorna em tempo real ao webhook o status do seu envio./td> /tr> tr> td>PhoneNumber/td> td>Número de telefone do destinatário da mensagem./td> /tr> tr> td>StatusDate/td> td>Data que o status foi recebido (UTC)./td> /tr> /tbody> /table> h1 idrespostas-automaticas>Respostas Automáticas/h1> p>Nesta seção é abordada a criação de regras de resposta automática, que podem ser utilizadas na hora do envio para criar um fluxo automatizado de acordo com a resposta do cliente para a mensagem enviada. /p> h2 idcadastrar-respostas-automaticas>Cadastrar / Respostas Automáticas/h2> p>Com este recurso, é possivel cadastrar respostas automáticas que podem ser usadas no momento do envio.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/sendingcontextrules/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/sendingcontextrules span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Name:rule_name,Message:message,PositiveContext:positive_input,PositiveResponse:response_for_positive_input,NegativeContext:negative_input,NegativeResponse:response_for_negative_input,DefaultResponse:default_response}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/sendingcontextrules/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Name:rule_name,Message:message,PositiveContext:positive_input,PositiveResponse:response_for_positive_input,NegativeContext:negative_input,NegativeResponse:response_for_negative_input,DefaultResponse:default_response}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/sendingcontextrules/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Name/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>rule_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Message/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>message/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>PositiveContext/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>positive_input/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>PositiveResponse/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>response_for_positive_input/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>NegativeContext/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>negative_input/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>NegativeResponse/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>response_for_negative_input/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>DefaultResponse/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>default_response/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{Name\:\rule_name\,\Message\:\message\,\PositiveContext\:\positive_input\,\PositiveResponse\:\response_for_positive_input\,\NegativeContext\:\negative_input\,\NegativeResponse\:\response_for_negative_input\,\DefaultResponse\:\default_response\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/sendingcontextrules/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/sendingcontextrules/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Name/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>rule_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Message/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>message/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>PositiveContext/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>positive_input/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>PositiveResponse/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>response_for_positive_input/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>NegativeContext/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>negative_input/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>NegativeResponse/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>response_for_negative_input/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>DefaultResponse/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>default_response/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>Name/strong>/td> td>sim/td> td>Nome da resposta automática, este campo que deve ser informado no método de envio./td> /tr> tr> td>Message/td> td>sim/td> td>Mensagem que será enviada para o cliente./td> /tr> tr> td>PositiveContext/td> td>sim/td> td>Conteúdo que será considerado como resposta positiva do cliente./td> /tr> tr> td>PositiveResponse/td> td>sim/td> td>Mensagem que será enviada caso haja resposta positiva do cliente./td> /tr> tr> td>NegativeContext/td> td>sim/td> td>Conteúdo que será considerado como resposta negativa do cliente./td> /tr> tr> td>NegativeResponse/td> td>sim/td> td>Mensagem que será enviada caso haja resposta negativa do cliente./td> /tr> tr> td>DefaultResponse/td> td>sim/td> td>Mensagem que será enviada caso resposta do cliente não caia nas regras de positiva/negativa. /td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Name/span>: span classs2>rule_name/span>, span classs2>Message/span>: span classs2>message/span>, span classs2>PositiveContext/span>: span classs2>positive_input/span>, span classs2>PositiveResponse/span>: span classs2>response_for_positive_input/span>, span classs2>NegativeContext/span>: span classs2>negative_input/span>, span classs2>NegativeResponse/span>: span classs2>response_for_negative_input/span>, span classs2>DefaultResponse/span>: span classs2>default_response span classo>}/span>, span classs2>Message/span>: span classs2>A resposta automatica foi criada com sucesso./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Name/td> td>Nome da resposta automática que foi adicionada./td> /tr> tr> td>Message/td> td>Mensagem da resposta automática que foi adicionada./td> /tr> tr> td>PositiveContext/td> td>Conteúdo que será considerado como resposta positiva do cliente./td> /tr> tr> td>PositiveResponse/td> td>Mensagem que será enviada caso haja resposta positiva do cliente./td> /tr> tr> td>NegativeContext/td> td>Conteúdo que será considerado como resposta negativa do cliente./td> /tr> tr> td>NegativeResponse/td> td>Mensagem que será enviada caso haja resposta negativa do cliente./td> /tr> tr> td>DefaultResponse/td> td>Mensagem que será enviada caso resposta do cliente não caia nas regras de positiva/negativa. /td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>A resposta automática foi criada com sucesso./td> /tr> tr> td>202/td> td>Não foi possível continuar, pois este método da API possui limite de tempo entre requisições. O tempo de espera entre sua última requisição e esta é de 30 segundos e ainda faltam 29 segundos. /td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>Requisição possui algum campo obrigatório faltando./td> /tr> tr> td>400/td> td>O nome da resposta automática informada já existe, por favor escolha um novo nome./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h1 idgrupo-de-contatos>Grupo de Contatos/h1> p>Nesta seção, são abordados recursos disponíveis para segmentação de contatos por grupos, que podem ser utilizados na hora do envio, facilitando tanto a rotina de armazemento destes telefones, quanto a de envio posteriormente para os contatos. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint./p> h2 idcadastrar-grupos-de-contatos>Cadastrar / Grupos de Contatos/h2> p>Com este recurso, é possivel cadastrar grupos de contatos para segmentar contatos em listas que podem ser usadas no momento do envio.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/contactgroup/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/contactgroup span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Name:group_name,Description:group_description}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Name:group_name,Description:group_description}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Name/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>group_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Description/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>group_description/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Name\:\group_name\,\Description\:\group_description\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/contactgroup/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Name/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>group_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Description/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>group_description/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>Name/strong>/td> td>sim/td> td>Nome do grupo para segmentação dos contatos, este campo que deve ser informado no método de envio./td> /tr> tr> td>Description/td> td>não/td> td>Breve descrição do grupo, pode ser usado para inserir detalhes e informações adicionais sobre o grupo./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Name/span>: span classs2>group_name/span>, span classs2>Description/span>: span classs2>group_description/span> span classo>}/span>, span classs2>Message/span>: span classs2>O grupo de contatos foi criado com sucesso./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Name/td> td>Nome do grupo que foi adicionado./td> /tr> tr> td>Description/td> td>Descrição do grupo que foi adicionado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O grupo de contatos foi criado com sucesso./td> /tr> tr> td>202/td> td>Não foi possível continuar, pois este método da API possui limite de tempo entre requisições. O tempo de espera entre sua última requisição e esta é de 30 segundos e ainda faltam 29 segundos. /td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>O nome do grupo deve ser informado./td> /tr> tr> td>400/td> td>O nome do grupo informado já existe, por favor escolha um novo nome./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-grupos-de-contatos>Consultar / Grupos de Contatos/h2> p>Com este recurso, é possivel consultar os grupos de contatos cadastrados.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/contactgroup//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>{group_name}/td> td>não/td> td>Caso queira filtrar os detalhes somente de um grupo é só informar na querystring, se não informado será retornado todos os grupos cadastrados no seu usuário./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>/span> span classo>{/span> span classs2>Id/span>: comtele_group_id, span classs2>Name/span>: span classs2>group_name/span>, span classs2>Description/span>: span classs2>group_description/span>, span classs2>TotalContacts/span>: 1, span classs2>LastUsed/span>: span classs2>yyyy-MM-dd HH:mm:ss.ms/span> span classo>}/span> span classo>/span>, span classs2>Message/span>: nullspan classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Id/td> td>Id junto a Comtele do grupo adicionado, campo numérico./td> /tr> tr> td>Name/td> td>Nome do grupo./td> /tr> tr> td>Description/td> td>Descrição do grupo./td> /tr> tr> td>TotalContacts/td> td>Número total de contatos atualmente no grupo./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes do grupo ou dos grupos de contatos consultados com o critério selecionado./td> /tr> tr> td>400/td> td>Nao foi encontrado nenhum grupo com o nome {group_name}/td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idexcluir-grupos-de-contatos>Excluir / Grupos de Contatos/h2> p>Com este recurso, é possivel excluir grupos de contatos cadastrados.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/contactgroup/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request DELETE span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>DELETE/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Delete/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>DELETE/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/contactgroup/{group_name}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>DELETE/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>Name/strong>/td> td>sim/td> td>Nome do grupo para segmentação dos contatos, este campo que deve ser informado no método de envio./td> /tr> tr> td>Description/td> td>não/td> td>Breve descrição do grupo, pode ser usado para inserir detalhes e informações adicionais sobre o grupo./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: null, span classs2>Message/span>: span classs2>O grupo de contatos foi removido com sucesso/span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>Neste recurso será nulo, pois não existe objeto a ser retornado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O grupo de contatos foi removido com sucesso./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idcadastrar-contatos-grupos-de-contatos>Cadastrar Contatos / Grupos de Contatos/h2> p>Com este recurso, é possivel cadastrar contatos em grupos para segmentar estes contatos em listas que podem ser usadas no momento do envio.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/contactgroup/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>PUT/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request PUT span classse>\/span> --url https://sms.comtele.com.br/api/v2/contactgroup span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{GroupName:group_name,Action:add_number,ContactName:contact_name,ContactPhone:phone_number}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>PUT/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{GroupName:group_name,Action:add_number,ContactName:contact_name,ContactPhone:phone_number}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Put/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>GroupName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>group_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Action/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>add_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ContactName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>contact_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ContactPhone/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\GroupName\:\group_name\,\Action\:\add_number\,\ContactName\:\contact_name\,\ContactPhone\:\phone_number\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>PUT/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/contactgroup/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>GroupName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>group_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Action/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>add_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ContactName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>contact_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ContactPhone/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>PUT/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>GroupName/strong>/td> td>sim/td> td>Nome do grupo que ja foi cadastrado para a segmentação dos contatos./td> /tr> tr> td>strong>Action/strong>/td> td>sim/td> td>Neste campo o parâmetro strong>“add_number”/strong> obrigatóriamente deve ser informado para adicionar os contatos ao grupo./td> /tr> tr> td>ContactName/td> td>não/td> td>Neste campo, você pode adicinar o nome do contato, que poderá ser usado no momento do envio via painel para fazer envios personalizados./td> /tr> tr> td>strong>ContactPhone/strong>/td> td>sim/td> td>Número de telefone do contato que está adicionando para receber os SMS./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>GroupName/span>: span classs2>group_name/span>, span classs2>Action/span>: span classs2>add_number/span>, span classs2>ContactPhone/span>: span classs2>phone_number/span>, span classs2>ContactName/span>: span classs2>contact_name/span> span classo>}/span>, span classs2>Message/span>: span classs2>O contato foi inserido no grupo com sucesso./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>GroupName/td> td>Nome do grupo em que o contato foi adicionado./td> /tr> tr> td>Action/td> td>strong>add_number/strong>, ação que foi informada para adicionar o número de telefone do contato./td> /tr> tr> td>ContactPhone/td> td>Número de telefone do contato que foi adicionado./td> /tr> tr> td>ContactName/td> td>Nome do contato que foi adicionado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O contato foi inserido no grupo com sucesso./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>O grupo informado nao foi encontrado./td> /tr> tr> td>400/td> td>O numero de telefone deve ser informado./td> /tr> tr> td>400/td> td>O parametro Action deve ser informado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idexcluir-contatos-grupos-de-contatos>Excluir Contatos / Grupos de Contatos/h2> p>Com este recurso, é possivel remover contatos em grupos segmentados, para que estes contatos não recebam mais SMS destas listas quando usadas no momento do envio.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/contactgroup/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>PUT/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request PUT span classse>\/span> --url https://sms.comtele.com.br/api/v2/contactgroup span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{GroupName:group_name,Action:remove_number,ContactName:contact_name,ContactPhone:phone_number}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>PUT/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{GroupName:group_name,Action:remove_number,ContactName:contact_name,ContactPhone:phone_number}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Put/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>GroupName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>group_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Action/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>remove_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ContactName/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>contact_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>ContactPhone/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\GroupName\:\group_name\,\Action\:\remove_number\,\ContactName\:\contact_name\,\ContactPhone\:\phone_number\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>PUT/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/contactgroup/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/contactgroup/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>GroupName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>group_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Action/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>remove_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ContactName/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>contact_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>ContactPhone/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>PUT/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>GroupName/strong>/td> td>sim/td> td>Nome do grupo que ja foi cadastrado para a segmentação dos contatos./td> /tr> tr> td>strong>Action/strong>/td> td>sim/td> td>Neste campo o parâmetro strong>“remove_number”/strong> obrigatóriamente deve ser informado para remover os contatos ao grupo./td> /tr> tr> td>ContactName/td> td>não/td> td>Neste campo, você pode adicinar o nome do contato, que poderá ser usado no momento do envio via painel para fazer envios personalizados./td> /tr> tr> td>strong>ContactPhone/strong>/td> td>sim/td> td>Número de telefone do contato que está adicionando para receber os SMS./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>GroupName/span>: span classs2>group_name/span>, span classs2>Action/span>: span classs2>remove_number/span>, span classs2>ContactPhone/span>: span classs2>phone_number/span>, span classs2>ContactName/span>: span classs2>contact_name/span> span classo>}/span>, span classs2>Message/span>: span classs2>O contato foi removido do grupo com sucesso./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>GroupName/td> td>Nome do grupo em que o contato foi adicionado./td> /tr> tr> td>Action/td> td>strong>remove_number/strong>, ação que foi informada para remover o número de telefone do contato./td> /tr> tr> td>ContactPhone/td> td>Número de telefone do contato que foi adicionado./td> /tr> tr> td>ContactName/td> td>Nome do contato que foi adicionado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O contato foi removido do grupo com sucesso./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>O grupo informado nao foi encontrado./td> /tr> tr> td>400/td> td>O numero de telefone deve ser informado./td> /tr> tr> td>400/td> td>O parametro Action deve ser informado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> !-- INÍCIO DA ÁREA DE Lista de Bloqueios --> h1 idblacklist>Lista de Bloqueios/h1> h2 idcadastrar-contatos-blacklist>Cadastrar Contatos / Lista de Bloqueios/h2> p>Com este recurso, é possivel adicionar números de telefone em uma Lista de Bloqueios para não receber mais SMS proveniente de sua conta, assim, você pode se despreocupar com uma verificação antes de mandar uma mensagem para números que não desejam mais receber seus SMS, basta adicionar estes telefones em sua Lista de Bloqueios, e caso seja enviado um SMS para este número, não será consumido crédito, o SMS não será entregue e aparecerá no relatório detalhado, uma mensagem informando que o número não recebeu o SMS pois está cadastrado na Lista de Bloqueios.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/blacklist/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/blacklist span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{PhoneNumber:phone_number}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/blacklist/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{PhoneNumber:phone_number}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/blacklist/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>PhoneNumber/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\PhoneNumber\:\phone_number\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/blacklist/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/blacklist/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>PhoneNumber/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>PhoneNumber/strong>/td> td>sim/td> td>Número de telefone do destinatário que não deve mais receber qualquer SMS enviado por sua conta./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>PhoneNumber/span>: span classs2>/span>, span classs2>BlacklistDate/span>: span classs2>yyyy-MM-ddTHH:mm:ss.ms/span> span classo>}/span>, span classs2>Message/span>: span classs2>O numero foi inserido na Lista de Bloqueios com sucesso./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>PhoneNumber/td> td>Número de telefone que foi adicionado na Lista de Bloqueios./td> /tr> tr> td>BlacklistDate/td> td>Data que o telefone foi adicionado na Lista de Bloqueios./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O numero foi inserido na Lista de Bloqueios com sucesso./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>O telefone deve ser informado/td> /tr> tr> td>400/td> td>O número informado é inválido./td> /tr> tr> td>400/td> td>O campo “PhoneNumber” não suporta texto, somente números./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-contatos-blacklist>Consultar Contatos / Lista de Bloqueios/h2> p>Com este recurso, é possivel consultar os números de telefone e a data que foram adicionados na sua Lista de Bloqueios.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/blacklist//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url https://sms.comtele.com.br/api/v2/blacklist/span classo>{/span>PhoneNumberspan classo>}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>PhoneNumber/td> td>não/td> td>Número de telefone do destinatário que não deve mais receber qualquer SMS enviado por sua conta./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>/span> span classo>{/span> span classs2>PhoneNumber/span>: span classs2>phone_number/span>, span classs2>BlacklistDate/span>: span classs2>yyyy-MM-ddTHH:mm:ss.ms/span> span classo>}/span> span classo>/span>, span classs2>Message/span>: null span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>PhoneNumber/td> td>Número de telefone que foi adicionado na Lista de Bloqueios./td> /tr> tr> td>BlacklistDate/td> td>Data que o telefone foi adicionado na Lista de Bloqueios./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes do número ou dos números de telefones consultados com o critério selecionado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idexcluir-contatos-blacklist>Excluir Contatos / Lista de Bloqueios/h2> p>Com este recurso, é possivel remover números de telefone que foram adicionados na Lista de Bloqueios para voltar a receber os SMS provenientes de sua conta. strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/blacklist//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>DELETE/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request DELETE span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>DELETE/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Delete/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>DELETE/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/blacklist/{PhoneNumber}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>DELETE/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>PhoneNumber/td> td>não/td> td>Número de telefone do destinatário que não deve mais receber qualquer SMS enviado por sua conta./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>PhoneNumber/span>: span classs2>/span>, span classs2>BlacklistDate/span>: span classs2>yyyy-MM-ddTHH:mm:ss.ms/span> span classo>}/span>, span classs2>Message/span>: span classs2>O numero foi removido da Lista de Bloqueios com sucesso./span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>PhoneNumber/td> td>Número de telefone que foi removido na Lista de Bloqueios./td> /tr> tr> td>BlacklistDate/td> td>Data que o telefone foi adicionado na Lista de Bloqueios./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes do número ou dos números de telefones consultados com o critério selecionado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> !-- FIM DA ÁREA DE Lista de Bloqueios --> !-- INÍCIO DA ÁREA DE ENCURTADOR URL --> h1 idaccounturl>Encurtador de URL/h1> h2 idcadastrar-contatos-accounturl>Criar / URL Encurtada/h2> p>Com este recurso, é possivel criar URLs encurtadas para reduzir o tamanho de suas URLs para que elas ocupem menos espaço em suas mensagens. Também é possível medir a quantidade de acessos que foram feitos na URL.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/accounturls/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span>--url https://sms.comtele.com.br/api/v2/accounturls span classse>\/span>--header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span>--header span classs1>content-type: application/json/span> span classse>\/span>--data span classs1>{Url:sua_url_original}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span>span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/accounturls/span>span classp>,/span>span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>},/span>span classna>body/span>span classp>:/span> span classs1>{Url:sua_url_original}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span>span classnb>require/span> span classs1>net/http/span>span classnb>require/span> span classs1>openssl/span>span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/accounturls/span>span classp>)/span>span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span>span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span>span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span>span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span>span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span>span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Url/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>sua_url_original/span>span classse>\/span>span classs2>}/span>span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Url\:\sua_url_original\}/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span>span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span>span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span>span classp>}/span>span classp>});/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/accounturls/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/accounturls/span>span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Url/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>sua_url_originalspan classse>\/span>span classs>}/span>span classn>headers/span> span classo>/span> span classp>{/span>span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>Url/strong>/td> td>sim/td> td>Sua URL original longa que deseja encurtar./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Code/span>: span classs2>/span>, span classs2>OriginalUrl/span>: span classs2>/span>, span classs2>UsageCount/span>: span classs2>0/span>, span classs2>UsageDate/span>: span classs2>yyyy-MM-ddTHH:mm:ss.ms/span>, span classs2>Status/span>: span classs2>Valid/span>, span classs2>ReceiveApprovalAlert/span>: span classs2>false/span>, span classs2>ShorterUrl/span>: span classs2>false/span> span classo>}/span>, span classs2>Message/span>: span classs2>/span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Code/td> td>Código gerado pelo sistema para identificar sua URL./td> /tr> tr> td>ShorterUrl/td> td>Sua URL encurtada gerada pelo nosso sistema./td> /tr> tr> td>UsageCount/td> td>Quantidade de acessos que sua URL teve./td> /tr> tr> td>UsageDate/td> td>Data do último acesso em sua URL./td> /tr> tr> td>Status/td> td>Status de sua URL, podendo conter os valores: Valid, Rejected e Awaiting./td> /tr> tr> td>ReceiveApprovalAlert/td> td>Campo que indica se irá receber alerta quando sua URL for aprovada pelo nosso time./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Sucesso./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>O telefone deve ser informado/td> /tr> tr> td>400/td> td>O número informado é inválido./td> /tr> tr> td>400/td> td>O campo “PhoneNumber” não suporta texto, somente números./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-accounturl>Consultar / Url Encurtada/h2> p>Com este recurso, é possivel consultar uma URL encurtada a partir de seu código.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/accounturls//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span>--url https://sms.comtele.com.br/api/v2/accounturls/span classo>{/span>Codespan classo>}/span> span classse>\/span>--header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span>span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classp>,/span>span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span>span classnb>require/span> span classs1>net/http/span>span classnb>require/span> span classs1>openssl/span>span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classp>)/span>span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span>span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span>span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span>span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span>span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span>span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span>span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span>span classp>}/span>span classp>});/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Code/td> td>sim/td> td>Código de sua URL que foi gerado pelo sistema no momento de sua criação./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Code/span>: span classs2>/span>, span classs2>OriginalUrl/span>: span classs2>/span>, span classs2>UsageCount/span>: span classs2>0/span>, span classs2>UsageDate/span>: span classs2>yyyy-MM-ddTHH:mm:ss.ms/span>, span classs2>Status/span>: span classs2>Valid/span>, span classs2>ReceiveApprovalAlert/span>: span classs2>false/span>, span classs2>ShorterUrl/span>: span classs2>false/span> span classo>}/span>, span classs2>Message/span>: span classs2>/span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Code/td> td>Código gerado pelo sistema para identificar sua URL./td> /tr> tr> td>ShorterUrl/td> td>Sua URL encurtada gerada pelo nosso sistema./td> /tr> tr> td>UsageCount/td> td>Quantidade de acessos que sua URL teve./td> /tr> tr> td>UsageDate/td> td>Data do último acesso em sua URL./td> /tr> tr> td>Status/td> td>Status de sua URL, podendo conter os valores: Valid, Rejected e Awaiting./td> /tr> tr> td>ReceiveApprovalAlert/td> td>Campo que indica se irá receber alerta quando sua URL for aprovada pelo nosso time./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes do número ou dos números de telefones consultados com o critério selecionado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idexcluir-accounturl>Excluir / URL Encurtada/h2> p>Com este recurso, é possivel remover uma url encurtada gerada pelo sistema a partir de seu código de identificação. strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/accounturls//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>DELETE/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request DELETE span classse>\/span>--url span classs1>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span> span classse>\/span>--header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span>span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span>span classna>method/span>span classp>:/span> span classs1>DELETE/span>span classp>,/span>span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classp>,/span>span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span>span classp>};/span>span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span>span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span>span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span>span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span>span classnb>require/span> span classs1>net/http/span>span classnb>require/span> span classs1>openssl/span>span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classp>)/span>span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span>span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span>span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span>span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Delete/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span>span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span>span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span>span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span>span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span>span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span>span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span>span classp>}/span>span classp>});/span>span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>DELETE/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span>span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span>span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/accounturls/{Code}/span>span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span>span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>DELETE/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span>span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Code/td> td>sim/td> td>Código de sua URL que foi gerado pelo sistema no momento de sua criação./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre> code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>null/span>, span classs2>Message/span>: span classs2>A url foi excluída com sucesso./span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes do número ou dos números de telefones consultados com o critério selecionado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> !-- FIM DA ÁREA DE ENCURTADOR URL --> !-- INÍCIO DA ÁREA DE CRÉDITOS --> h1 idcreditos>Créditos/h1> p>Nesta seção, são abordados recursos disponíveis para gestão de créditos, alguns em específico, necessitam que sua conta seja do tipo revenda, para ter funcionalidade administrativas a serem aplicadas em subcontas. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint./p> h2 idconsultar-saldo>Consultar Saldo/h2> p>Com este recurso, é possivel consultar a quantidade de saldo disponível em sua conta ou subcontas.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/credits//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/credits/{sub_account}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/credits/{sub_account}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/credits/{sub_account}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/credits/{sub_account}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/credits/{sub_account}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>sub_account/td> td>não/td> td>Se não for informado username, será retornado o saldo da conta que está relacionada a chave de integração que está sendo utilizada. A funcionalidade de consultar saldo de uma subconta só está disponível para contas do tipo revenda, que possui funcionalidades administrativas em suas subcontas./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: 0, span classs2>Message/span>: null span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>É retornado a quantidade de saldo disponível no momento da consulta./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON a quantidade de saldo disponível no momento da consulta./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idinserir-saldo-subcontas>Inserir Saldo / Subcontas/h2> p>Com este recurso, é possivel adicionar saldo em suas subcontas. strong>Recurso disponível apenas para contas do tipo revenda/strong>br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/credits/Username?Amount{credits_amount}/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>PUT/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request PUT span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/credits/sub_account?Amountcredits_amount/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>PUT/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/credits/sub_account/span>span classp>,/span> span classna>qs/span>span classp>:/span> span classp>{/span>span classna>Amount/span>span classp>:/span> span classs1>credits_amount/span>span classp>},/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/credits/sub_account?Amountcredits_amount/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Put/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>PUT/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/credits/sub_account?Amountcredits_amount/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/credits/sub_account/span> span classn>querystring/span> span classo>/span> span classp>{/span>span classs>Amount/span>span classp>:/span>span classs>credits_amount/span>span classp>}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>PUT/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>,/span> span classn>params/span>span classo>/span>span classn>querystring/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>sub_account/strong>/td> td>sim/td> td>Username da subconta que pertence a sua revenda que terão os créditos adicionados. strong>Recurso disponível apenas para contas do tipo revenda/strong> /td> /tr> tr> td>strong>Amount/strong>/td> td>sim/td> td>Quantidade de créditos a ser adicionados da subconta. strong>Recurso disponível apenas para contas do tipo revenda/strong>/td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide>span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: null, span classs2>Message/span>: span classs2>Os creditos foram alterados com sucesso./span>span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Object/td> td>Neste recurso será nulo, pois não existe objeto a ser retornado./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Os creditos foram alterados com sucesso./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>404/td> td>Será retornado um objeto JSON com o campo strong>“Success”: false/strong> com strong>Object/strong> e strong>Message/strong> null, pois o usuário não foi encontrado ou não está atrelado a conta com a chave que está utilizando. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-histrico-de-recargas-subcontas>Consultar Histórico de Recargas / Subcontas/h2> p>Com este recurso, é possivel consultar a histórico de créditos adicionados suas subcontas. br> Este recurso possui um cooldown de 30 segundos que é compartilhando entre os recuros de strong>Relatório Detalhado, Relatório de Regra de Resposta Automática e Relatório de Respostas/strong>, ou seja, somente uma chamada a cada 30 segundos a estes recursos podem ser realizadas. strong>Recurso disponível apenas para contas do tipo revenda/strong>br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/balancehistory//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url https://sms.comtele.com.br/api/v2/balancehistory/span classo>{/span>sub_accountspan classo>}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/balancehistory/{sub_account}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/balancehistory/{sub_account}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span> /code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/balancehistory/{sub_account}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/balancehistory/{sub_account}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>sub_account/strong>/td> td>sim/td> td>Username da subconta que pertence a sua revenda que deseja consultar o histórico de créditos adicionados./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>/span> span classo>{/span> span classs2>Amount/span>: 1, span classs2>Balance/span>: 1, span classs2>ExpiryDate/span>: null, span classs2>HistoryDate/span>: span classs2>yyyy-MM-dd HH:mm.ms/span>, span classs2>AssociadedUsername/span>: span classs2>username/span> span classo>}/span> span classo>/span>, span classs2>Message/span>: null span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Amount/td> td>Quantidade de crédito que foi adicionado./td> /tr> tr> td>Balance/td> td>Quantidade de crédito adicionado, somada a quandidade saldo que estava disponível no momento que foi adicionado./td> /tr> tr> td>ExpiryDate/td> td>Caso o saldo disponível tenha data de expiração, neste caso será sempre strong>null/strong> /td> /tr> tr> td>HistoryDate/td> td>Timestamp do momento que o crédito foi adicionado na conta./td> /tr> tr> td>AssociadedUsername/td> td>Username da conta responsável por adicionar o crédito para o usuário./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON a quantidade de saldo disponível no momento da consulta./td> /tr> tr> td>202/td> td>Nao foi possivel continuar, pois este metodo da API possui limite de tempo entre requisicoes. O tempo de espera entre sua ultima requisicao e esta e de 30 segundos e ainda faltam XX segundos. /td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h1 idsubcontas>Subcontas/h1> p>Nesta seção, são abordados recursos administrativos de criação de subcontas, caso sua aplicação precise dividir acessos em multiníveis ou então comercializar SMS. Mais detalhes sobre cada recurso, pode ser encontrado em uma breve descrição logo abaixo do título de cada endpoint./p> h2 idcadastrar-subcontas>Cadastrar / Subcontas/h2> p>Com este recurso, é possivel cadastrar subcontas, se a sua conta for do tipo revenda. Dessa maneira é possível separar completamente a utilização das funcionalidades, créditos e acesso.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/accounts/code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>POST/code> /p> div stylemin-height: 455px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request POST span classse>\/span> --url https://sms.comtele.com.br/api/v2/accounts span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classse>\/span> --header span classs1>content-type: application/json/span> span classse>\/span> --data span classs1>{Firstname:first_name,Lastname:last_name,Email:email,CorporateTaxpayer:cnpj,IndividualTaxpayer:cpf,MobileNumber:phone_number,Password:password}/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>POST/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/accounts/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span> span classs1>content-type/span>span classp>:/span> span classs1>application/json/span>span classp>,/span> span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>},/span> span classna>body/span>span classp>:/span> span classs1>{Firstname:first_name,Lastname:last_name,Email:email,CorporateTaxpayer:cnpj,IndividualTaxpayer:cpf,MobileNumber:phone_number,Password:password}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/accounts/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Post/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>content-type/span>span classp>/span> span classo>/span> span classs1>application/json/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>request/span>span classp>./span>span classnf>body/span> span classo>/span> span classs2>{/span>span classse>\/span>span classs2>Firstname/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>first_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Lastname/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>last_name/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Email/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>email/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>CorporateTaxpayer/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>cnpj/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>IndividualTaxpayer/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>cpf/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>MobileNumber/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>phone_number/span>span classse>\/span>span classs2>,/span>span classse>\/span>span classs2>Password/span>span classse>\/span>span classs2>:/span>span classse>\/span>span classs2>password/span>span classse>\/span>span classs2>}/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classs2>{\Firstname\:\first_name\,\Lastname\:\last_name\,\Email\:\email\,\CorporateTaxpayer\:\cnpj\,\IndividualTaxpayer\:\cpf\,\MobileNumber\:\phone_number\,\Password\:\password\}/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>POST/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/accounts/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>content-type/span>span classp>,/span> span classs2>application/json/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/accounts/span> span classn>payload/span> span classo>/span> span classs>{/span>span classse>\/span>span classs>Firstname/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>first_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Lastname/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>last_name/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Email/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>email/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>CorporateTaxpayer/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>cnpj/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>IndividualTaxpayer/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>cpf/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>MobileNumber/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>phone_number/span>span classse>\/span>span classs>,/span>span classse>\/span>span classs>Password/span>span classse>\/span>span classs>:/span>span classse>\/span>span classs>password/span>span classse>\/span>span classs>}/span> span classn>headers/span> span classo>/span> span classp>{/span> span classs>content-type/span>span classp>:/span> span classs>application/json/span>span classp>,/span> span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>POST/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>data/span>span classo>/span>span classn>payload/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>strong>Firstname/strong>/td> td>sim/td> td>Se refere ao primeiro nome do usuário, este nome será exibido no painel para dar boas vindas e etc. O campo não pode estar vazio e pode conter caracteres alfanuméricos./td> /tr> tr> td>Lastname/td> td>não/td> td>Sobrenome do usuário./td> /tr> tr> td>strong>Email/strong>/td> td>sim/td> td>O e-mail do usuário que está sendo cadastrado, pode ser usado para fazer login no painel./td> /tr> tr> td>strong>CorporateTaxpayer/strong>/td> td>–/td> td>CNPJ do usuário, caso seja pessoa jurídica, só é necessário informar um documento, CNPJ ou CPF. /td> /tr> tr> td>strong>IndividualTaxpayer/strong>/td> td>–/td> td>CPF do usuário, caso seja pessoa física, só é necessário informar um documento, CPF ou CNPJ. /td> /tr> tr> td>strong>MobileNumber/strong>/td> td>sim/td> td>Celular do usuário que está sendo cadastrado./td> /tr> tr> td>strong>Password/strong>/td> td>sim/td> td>Senha de acesso ao painel do usuário que está sendo cadastrado./td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Enabled/span>: span classnb>true/span>, span classs2>Username/span>: span classs2>sub_account_username/span>, span classs2>Balance/span>: 0, span classs2>Connection/span>: null, span classs2>LastBalanceHistory/span>: null, span classs2>ApiKey/span>: span classs2>sub_account_apikey/span> span classo>}/span>, span classs2>Message/span>: span classs2>O usuario foi inserido com sucesso/span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Enabled/td> td>Status da subconta que foi adicionada, no caso todas as subcontas recém criadas ja são ativadas./td> /tr> tr> td>Username/td> td>Username da subconta que foi criada./td> /tr> tr> td>Balance/td> td>Quantidade de créditos disponíveis na subconta que foi criada, todas as subcontas são criadas com 0 créditos./td> /tr> tr> td>Connection/td> td>Data mais recente que a subconta efetuou login no painel./td> /tr> tr> td>LastBalanceHistory/td> td>Data mais recente que a subconta teve créditos adicionados./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado./td> /tr> tr> td>ApiKey/td> td>Retorna a API Key da subconta que foi criada./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>O usuario foi inserido com sucesso./td> /tr> tr> td>400/td> td>Object reference not set to an instance of an object.br>strong>Possível Causa:/strong> Nenhum objeto foi informado no Body da requisição./td> /tr> tr> td>400/td> td>O nome do usuario deve ser informado./td> /tr> tr> td>400/td> td>O telefone celular do usuario deve ser informado./td> /tr> tr> td>400/td> td>O e-mail já está em uso, por favor escolha um novo e-mail./td> /tr> tr> td>400/td> td>O e-mail informado é inválido ou não foi informado./td> /tr> tr> td>400/td> td>O campo C.P.F. ou o campo C.N.P.J. deve ser preenchido./td> /tr> tr> td>400/td> td>A senha do usuario deve ser informada./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> h2 idconsultar-subcontas>Consultar / Subcontas/h2> p>Com este recurso, é possivel consultar as subcontas cadastradas e atreladas a sua conta.br> strong>URL do Endpoint:/strong> code classprettyprint>https://sms.comtele.com.br/api/v2/accounts//code>br> strong>Autenticação via Header:/strong> code classprettyprint>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/code>br> strong>Método:/strong> code classprettyprint>GET/code> /p> div stylemin-height: 435px;> div classcode-snippet js-code-snippet language-shell> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-shell data-langshell> curl --request GET span classse>\/span> --url span classs1>https://sms.comtele.com.br/api/v2/accounts/{sub_account}/span> span classse>\/span> --header span classs1>auth-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-node> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-node data-langjavascript> span classkd>var/span> span classnx>request/span> span classo>/span> span classnx>require/span>span classp>(/span>span classs2>request/span>span classp>);/span> span classkd>var/span> span classnx>options/span> span classo>/span> span classp>{/span> span classna>method/span>span classp>:/span> span classs1>GET/span>span classp>,/span> span classna>url/span>span classp>:/span> span classs1>https://sms.comtele.com.br/api/v2/accounts/{sub_account}/span>span classp>,/span> span classna>headers/span>span classp>:/span> span classp>{/span>span classs1>auth-key/span>span classp>:/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classp>};/span> span classnx>request/span>span classp>(/span>span classnx>options/span>span classp>,/span> span classkd>function/span> span classp>(/span>span classnx>error/span>span classp>,/span> span classnx>response/span>span classp>,/span> span classnx>body/span>span classp>)/span> span classp>{/span> span classk>if/span> span classp>(/span>span classnx>error/span>span classp>)/span> span classk>throw/span> span classk>new/span> span classnb>Error/span>span classp>(/span>span classnx>error/span>span classp>);/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classnx>body/span>span classp>);/span> span classp>});/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-ruby> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-ruby data-langruby> span classnb>require/span> span classs1>uri/span> span classnb>require/span> span classs1>net/http/span> span classnb>require/span> span classs1>openssl/span> span classn>url/span> span classo>/span> span classno>URI/span>span classp>(/span>span classs2>https://sms.comtele.com.br/api/v2/accounts/{sub_account}/span>span classp>)/span> span classn>http/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>./span>span classnf>host/span>span classp>,/span> span classn>url/span>span classp>./span>span classnf>port/span>span classp>)/span> span classn>http/span>span classp>./span>span classnf>use_ssl/span> span classo>/span> span classkp>true/span> span classn>http/span>span classp>./span>span classnf>verify_mode/span> span classo>/span> span classno>OpenSSL/span>span classo>::/span>span classno>SSL/span>span classo>::/span>span classno>VERIFY_NONE/span> span classn>request/span> span classo>/span> span classno>Net/span>span classo>::/span>span classno>HTTP/span>span classo>::/span>span classno>Get/span>span classp>./span>span classnf>new/span>span classp>(/span>span classn>url/span>span classp>)/span> span classn>request/span>span classp>/span>span classs2>auth-key/span>span classp>/span> span classo>/span> span classs1>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span> span classn>response/span> span classo>/span> span classn>http/span>span classp>./span>span classnf>request/span>span classp>(/span>span classn>request/span>span classp>)/span> span classnb>puts/span> span classn>response/span>span classp>./span>span classnf>read_body/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-javascript> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-javascript data-langjavascript> span classkd>var/span> span classnx>data/span> span classo>/span> span classkc>null/span>span classp>;/span> span classkd>var/span> span classnx>xhr/span> span classo>/span> span classk>new/span> span classnx>XMLHttpRequest/span>span classp>();/span> span classnx>xhr/span>span classp>./span>span classnx>addEventListener/span>span classp>(/span>span classs2>readystatechange/span>span classp>,/span> span classkd>function/span> span classp>()/span> span classp>{/span> span classk>if/span> span classp>(/span>span classk>this/span>span classp>./span>span classnx>readyState/span> span classo>/span> span classk>this/span>span classp>./span>span classnx>DONE/span>span classp>)/span> span classp>{/span> span classnx>console/span>span classp>./span>span classnx>log/span>span classp>(/span>span classk>this/span>span classp>./span>span classnx>responseText/span>span classp>);/span> span classp>}/span> span classp>});/span> span classnx>xhr/span>span classp>./span>span classnx>open/span>span classp>(/span>span classs2>GET/span>span classp>,/span> span classs2>https://sms.comtele.com.br/api/v2/accounts/{sub_account}/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>setRequestHeader/span>span classp>(/span>span classs2>auth-key/span>span classp>,/span> span classs2>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>);/span> span classnx>xhr/span>span classp>./span>span classnx>send/span>span classp>(/span>span classnx>data/span>span classp>);/span>/code>/pre> /div> /div> div classcode-snippet js-code-snippet language-python> button classbtn alternative>copy/button> div classcode-snippet__selector> nav> button classselector_switch idshell>curl/button> button classselector_switch idnode>node/button> button classselector_switch idruby>ruby/button> button classselector_switch idjavascript>javascript/button> button classselector_switch idpython>python/button> /nav> /div> div classcode-snippet__cnt highlight> pre>code classlanguage-python data-langpython> span classkn>import/span> span classnn>requests/span> span classn>url/span> span classo>/span> span classs>https://sms.comtele.com.br/api/v2/accounts/{sub_account}/span> span classn>headers/span> span classo>/span> span classp>{/span>span classs>auth-key/span>span classp>:/span> span classs>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/span>span classp>}/span> span classn>response/span> span classo>/span> span classn>requests/span>span classo>./span>span classn>request/span>span classp>(/span>span classs>GET/span>span classp>,/span> span classn>url/span>span classp>,/span> span classn>headers/span>span classo>/span>span classn>headers/span>span classp>)/span> span classk>print/span>span classp>(/span>span classn>response/span>span classo>./span>span classn>text/span>span classp>)/span>/code>/pre> /div> /div> /div> table> thead> tr> th>Campos/th> th>Obrigatório/th> th>Descrição/th> /tr> /thead> tbody> tr> td>sub_account/td> td>não/td> td>Username da subconta que pertence a sua revenda. strong>Recurso disponível apenas para contas do tipo revenda/strong>/td> /tr> /tbody> /table> h5 idexemplo-de-retorno-de-sucesso>Exemplo de Retorno de Sucesso/h5> div classcode-snippet js-code-snippet language-bashnohide> button classbtn alternative>copy/button> div classcode-snippet__cnt highlight> pre>code classlanguage-bashnohide data-langbashnohide> span classo>{/span> span classs2>Success/span>: span classnb>true/span>, span classs2>Object/span>: span classo>{/span> span classs2>Enabled/span>: span classnb>true/span>, span classs2>Username/span>: span classs2>sub_account_username/span>, span classs2>Balance/span>: 0, span classs2>Connection/span>: yyyy-MM-ddTHH:mm:ss.ms, span classs2>LastBalanceHistory/span>: yyyy-MM-ddTHH:mm:ss.ms, span classs2>ApiKey/span>: span classs2>sub_account_apikey/span> span classo>}/span>, span classs2>Message/span>: span classs2>O usuario foi inserido com sucesso/span> span classo>}/span>/code>/pre> /div> /div> h5 idcampos-do-retorno>Campos do Retorno/h5> table> thead> tr> th>Campos/th> th>Descrição/th> /tr> /thead> tbody> tr> td>Success/td> td>Pode ser retornado strong>true/strong> para sucesso ou strong>false/strong> para erro, este campo é o resultado da operação./td> /tr> tr> td>Enabled/td> td>Status da subconta que foi adicionada./td> /tr> tr> td>Username/td> td>Username da subconta que foi informado na consulta./td> /tr> tr> td>Balance/td> td>Saldo disponível na subconta no momento da consulta./td> /tr> tr> td>Connection/td> td>Data mais recente que a subconta efetuou login no painel./td> /tr> tr> td>LastBalanceHistory/td> td>Data mais recente que a subconta teve créditos adicionados./td> /tr> tr> td>Message/td> td>Neste campo é retornado mais detalhes sobre o resultado da operação do recurso que foi utilizado, neste caso será sempre strong>null/strong>/td> /tr> tr> td>ApiKey/td> td>Retorna a API Key da subconta que foi criada./td> /tr> /tbody> /table> h5 idretornos-previsveis>Retornos Previsíveis/h5> table> thead> tr> th>HTTP Status/th> th>Descrição/th> /tr> /thead> tbody> tr> td>200/td> td>Será retornado um objeto JSON com os detalhes do grupo ou dos grupos de contatos consultados com o critério selecionado./td> /tr> tr> td>401/td> td>A chave de acesso informada é inválida e não pode efetuar uma requisição à API. br>strong>Possível Causa:/strong> code classprettyprint>auth-key/code> está incorreta ou o campo foi informado em branco. /td> /tr> tr> td>401/td> td>O usuário informado está desativado./td> /tr> tr> td>401/td> td>O usuário informado está incorreto ou não existebr>strong>Possível Causa:/strong> o campo code classprettyprint>auth-key/code> não está sendo informado na requisição. /td> /tr> tr> td>500/td> td>Algum problema com o servidor em que está o recurso acessado, neste caso, tente acessar novamente./td> /tr> tr> td>503/td> td>houve um time out na requisição ao efetuar a conexão com o endpoint./td> /tr> /tbody> /table> footer> div classpage-wrap> /div> /footer> /section> /div> /div>/body>/html>
View on OTX
|
View on ThreatMiner
Please enable JavaScript to view the
comments powered by Disqus.
Data with thanks to
AlienVault OTX
,
VirusTotal
,
Malwr
and
others
. [
Sitemap
]