{"info":{"_postman_id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","name":"Doc API - NETiZap","description":"

Apresentação

\n

Documentação para utilização da API NETiZap. Responsável pela comunicação com o Whatsapp.

\n

Autenticação

\n

Modo 2+ para camadas de autenticação.
Auth Basic ( user / api ).
Credencial de acesso.

\n

Error Codes

\n

400 – Bad Request

\n

Dados enviados de forma incorreta ou fora do padrão.

\n

Data sent incorrectly or nonstandard.

\n
400.001    \n    Parameter incorrect or not found.\n    Parametro incorreto ou não encontrado.\n400.002\n    Authentication error. Parameter incorrect or Access Key invalid.\n    Erro na autenticação. Parametro incorreto ou Chave de Acesso expirou.\n400.003\n    Expression contains incorrect characters.\n    Expressão contém caracteres incorretos.\n400.004\n    Parameters Incorrect or Format Error.\n    Parametros ou formatação incorretos.\n400.005\n    Parameters outside expected range.\n    Parametros fora do intervalo esperado.\n\n

401 – Required Authentication

\n

Requisição Requer Autenticação.

\n

Authentication Required for Request.

\n

403 – Forbidden

\n

Sem autorização suficiente para acessar o recurso desejado.

\n

Request Denied.

\n

404 – Resource

\n

Recurso não Encontrado.

\n

Resource Not Found.

\n

405 – Method

\n

Método não Permitido.

\n

Method Not Allowed.

\n
405.001\n    Método não Permitido. Verifique intervalos de execução do evento no manual.\n    Method Not Allowed. Check event execution intervals in the manual.\n\n

408 – Timeout

\n

Tempo esgotado para a requisição.

\n

Request timeout.

\n

413 – Request Size

\n

Requisição excede o tamanho máximo permitido.

\n

Request exceeds maximum allowable size.

\n

422 – Business exceptions

\n

500 - Internal Server

\n

900 – Others Exceptions

\n

Sugestão de repetir o comando.

\n

Tip for repeating the command.

\n

Exception Return Model

\n

[
{
\"errors\": [
{
\"code\": \"\",
\"type\": \"\",
\"message\": \"\",
\"link\": \"\"
}
]
}
]

\n

Cupons de Descontos

\n

\"ZAP50Plus\" - 50% de desconto nos 3 meses iniciais;

\n

\"ZAP40YPlus\" - 40% de desconto no primeiro ano;

\n

Termos e Condições de Uso

\n\n

Intervalos de Consulta

\n

Apenas alguns eventos possuem controle global para consultas.

\n
requests_start\n    5 segundos.\nstatistics_for_day\n    30 segundos.\nwebhook\n    60 segundos.\nwebhook.list\n    30 segundos.\n\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Apresentação","slug":"apresentacao"},{"content":"Autenticação","slug":"autenticacao"},{"content":"Error Codes","slug":"error-codes"},{"content":"Cupons de Descontos","slug":"cupons-de-descontos"},{"content":"Termos e Condições de Uso","slug":"termos-e-condicoes-de-uso"},{"content":"Intervalos de Consulta","slug":"intervalos-de-consulta"}],"owner":"2747664","collectionId":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","publishedId":"SVSPnmoH","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-07-23T05:22:46.000Z"},"item":[{"name":"model ( urlencoded )","item":[{"name":"services","item":[{"name":"message_send","id":"3b87bce5-9a86-4e4a-b303-7965abad6500","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/services/message_send?line={{line}}&key={{accesskey}}&destiny={{destiny}}&text={{message_send-text}}&reference&priority&app©","description":"

Realiza o envio de mensagem de texto.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["services","message_send"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Telefone (DDI+DDD+Número) ou ID Grupo.

\n","type":"text/plain"},"key":"destiny","value":"{{destiny}}"},{"description":{"content":"

(requerido) Mensagem.

\n","type":"text/plain"},"key":"text","value":"{{message_send-text}}"},{"description":{"content":"

(opcional) Identificação personalizada para o comando. É retornado em pesquisas.

\n","type":"text/plain"},"key":"reference","value":null},{"description":{"content":"

(opcional) priorização de envio na ordem de 0 (padrão) a 5 (maior prioridade).

\n","type":"text/plain"},"key":"priority","value":null},{"description":{"content":"

(opcional) Identificação do emissor.

\n","type":"text/plain"},"key":"app","value":null},{"description":{"content":"

(opcional) Cópia para multiplos destinatários. Separe pelo delimitador \";\" .

\n","type":"text/plain"},"key":"copy","value":null}],"variable":[]}},"response":[],"_postman_id":"3b87bce5-9a86-4e4a-b303-7965abad6500"},{"name":"message_search","id":"1506d774-5ec0-40bb-9f9a-86214aca228a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/services/message_search?line={{line}}&key={{accesskey}}&protocol={{protocol}}","description":"

\nRealiza a consulta de informações relacionadas ao protocolo requisitado.
\nExecute search of information related to the requested protocol.
\nIntervalo de Utilização / Usage Interval: --\n

\n
\n
\nDetalhes do Json de retorno / Return Json details

\n
\nreference:\n    retorno da id interna enviada anteriormente.\n    return of previously sent internal id.
\nsent:\n    indicação de mensagem transmitida pelo serviço.\n    indication of message transmitted by the service.
\nsent_datehour:\n    data/hora de mensagem transmitida pelo serviço.\n    date/hour of message transmitted by the service.
\ndestiny:\n    destinatário da mensagem.\n    recipient of the message.
\nstatus:\n    indicador de status do whatsapp para a mensagem:\n    whatsapp status indicator for message:
\n    0: aguardando / waiting\n    1: enviado (não entregue) / shipped (not delivered) ==> 1 tick gray\n    2: entregue ao distinatario / delivered to the recipient ==> 2 ticks gray\n    3: lido / read ==> 2 ticks blue\n    4: reproduzido (áudio) / played (audio) ==> 2 ticks blue
\nerror:\n    campo indicador de ocorrência de erro.\n    error occurrence indicator field.
\nerror_detail:\n    detalhamento do erro.\n    error details.
\nquoted:\n    indica a ocorrência de citação.\n    indicates the occurrence of quotation.
\nquote_message:\n    Conteúdo da mensagem de citação.\n    Citation message content.
\n
","urlObject":{"protocol":"http","port":"{{port}}","path":["services","message_search"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Protocolo para consulta (código de retorno do evento \"question_search\").

\n","type":"text/plain"},"key":"protocol","value":"{{protocol}}"}],"variable":[]}},"response":[],"_postman_id":"1506d774-5ec0-40bb-9f9a-86214aca228a"},{"name":"question_send","id":"5a108c6f-01d4-4ee4-8fc9-f67f7b5f6860","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/services/question_send?line={{line}}&key={{accesskey}}&destiny={{destiny}}&text={{question_send-text}}&question=[{{question_send-answers_accepted}}]&reference=&app","description":"

Realiza o envio de mensagem com opções de respostas para análises.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["services","question_send"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Telefone (DDI+DDD+Número) ou ID Grupo.

\n","type":"text/plain"},"key":"destiny","value":"{{destiny}}"},{"description":{"content":"

(requerido) Mensagem do questionamento/pergunta/menu de opções.

\n","type":"text/plain"},"key":"text","value":"{{question_send-text}}"},{"description":{"content":"

(requerido) Valores aceitos como respostas. Indicação exclusiva na consulta \"question_search\". Deve ser iniciado e finalizado por colchetes e valores devem estar separados por \";\" .

\n","type":"text/plain"},"key":"question","value":"[{{question_send-answers_accepted}}]"},{"description":{"content":"

(opcional) Identificação personalizada para o comando. É retornado em pesquisas.

\n","type":"text/plain"},"key":"reference","value":""},{"key":"app","value":null}],"variable":[]}},"response":[],"_postman_id":"5a108c6f-01d4-4ee4-8fc9-f67f7b5f6860"},{"name":"question_search","id":"fe6f591a-44a4-44c7-83d4-a4d45091e6ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/services/question_search?line={{line}}&key={{accesskey}}&protocol={{protocol}}","description":"

Realiza a consulta de informações relacionadas ao protocolo requisitado.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["services","question_search"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Protocolo para consulta (código de retorno do evento \"message_search\").

\n","type":"text/plain"},"key":"protocol","value":"{{protocol}}"}],"variable":[]}},"response":[],"_postman_id":"fe6f591a-44a4-44c7-83d4-a4d45091e6ce"},{"name":"file_send","id":"c6c6d4c2-374b-478d-bc28-7fc5082efbeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"text","value":"{{file_send-text}}","description":"

(requerido) Mensagem ou questionamento/pergunta/menu de opções.

\n","type":"text"},{"key":"question","value":"","description":"

(opcional) Valores aceitos como respostas. Indicação exclusiva na consulta \"question_search\". Deve ser iniciado e finalizado por colchetes e valores devem estar separados por \";\" .

\n","type":"text"},{"key":"type","value":"{{file_send-type}}","description":"

(requerido) Tipo do arquivo como PDF, JPG, JPEG, PNG, HTM, HTML, DOC, DOCX, XLS, XLSX, TXT, CSV, MP3, MP4 e outros (consultar).

\n","type":"text"},{"key":"stream","value":"{{file_send-stream}}","description":"

(requerido) Arquivo em formato base64.

\n","type":"text"},{"key":"filename","value":"{{file_send-filename}}","description":"

(requerido) Nome do arquivo na entrega.

\n","type":"text"}]},"url":"http://api.meuaplicativo.vip:{{port}}/services/file_send?line={{line}}&key={{accesskey}}&destiny={{destiny}}&reference=&app","description":"

Realiza o envio de arquivos.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["services","file_send"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Telefone (DDI+DDD+Número) ou ID Grupo.

\n","type":"text/plain"},"key":"destiny","value":"{{destiny}}"},{"description":{"content":"

(opcional) Identificação personalizada para o comando. É retornado em pesquisas.

\n","type":"text/plain"},"key":"reference","value":""},{"description":{"content":"

(opcional) Identificação do emissor.

\n","type":"text/plain"},"key":"app","value":null}],"variable":[]}},"response":[],"_postman_id":"c6c6d4c2-374b-478d-bc28-7fc5082efbeb"}],"id":"81b57641-9ef1-45ee-b203-738095d1ba80","description":"

\nObjeto de contexto que pertence a camada principal dos serviços de ação de transmissão e recepção da integração.\n

\n
\n
\nContext object that belongs to the main layer of the integration transmission and reception action services.\n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3a7514ef-e5a4-4b8f-9ecb-a000fbe6411a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"738c08e4-b35b-4f2b-9654-d9dbe09f89ae","type":"text/javascript","exec":[""]}}],"_postman_id":"81b57641-9ef1-45ee-b203-738095d1ba80"},{"name":"reports","item":[{"name":"requests_start","id":"ca169e83-6981-4b6d-8636-2b7eea70da3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/reports/requests_start?line={{line}}&key={{accesskey}}","description":"

Exibe detalhes dos contatos e mensagens dos números que acionaram o whatsapp.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["reports","requests_start"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"}],"variable":[]}},"response":[],"_postman_id":"ca169e83-6981-4b6d-8636-2b7eea70da3c"},{"name":"statistics_for_day","id":"e3d61bb5-937d-45cd-a9d3-64fcb491cc8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":"http://api.meuaplicativo.vip:{{port}}/reports/statistics_for_day?line={{line}}&key={{accesskey}}&gestor=false","description":"

\nFornece informações de estatísticas atualizadas do dia.
\nIntervalo de Utilização: 2 minutos\n

\n
\n
\nProvides updated statistics information for the day.
\nUsage Interval: 2 minutes\n

\n
\n
\nJson Model Details

\nqueue:
\npendentes de envio do dia.
\npending day shipping.

\nqueue_remaining:
\ntotal de pendentes dos dias anteriores.
\ntotal outstanding from previous days.

\nsent:
\nenviados no dia.
\nsent on the day.

\nsent_total:
\nenviados nos dias anteriores ao atual.
\nsent in previous days.

\nnext_update:
\ndata/hora da liberação de uma nova requisição do evento.
\ndate/time of the release of a new event request.

\n

","urlObject":{"protocol":"http","port":"{{port}}","path":["reports","statistics_for_day"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(opcional) Se \"true\" retornará os dados em conjunto de todos os serviços vinculados.

\n","type":"text/plain"},"key":"gestor","value":"false"}],"variable":[]}},"response":[],"_postman_id":"e3d61bb5-937d-45cd-a9d3-64fcb491cc8f"}],"id":"7ec87d23-4693-4fe9-b1e1-38e94112ce1a","description":"
\n

Objeto de contexto ao qual são relacionados eventos de retorno de informações da integração.

\n
\n

Context object to which integration information return events are related.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"c713015d-5827-4aff-81b1-4e1b0f761f3a","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"eeabd54f-36cb-4264-9019-ab321b45fb18","type":"text/javascript","exec":[""]}}],"_postman_id":"7ec87d23-4693-4fe9-b1e1-38e94112ce1a"},{"name":"webhook","item":[{"name":"authorize","id":"67ddc63e-7d36-4228-ae2e-c57526f180c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/webhook/authorize?line={{line}}&key={{accesskey}}&method=post&enabled=true&url={{webhook-url}}","description":"

Habilita/Desabilita webhook.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["webhook","authorize"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Método de acionamento para o alvo.

\n","type":"text/plain"},"key":"method","value":"post"},{"description":{"content":"

(requerido) Habilita/Desabilita a função.

\n","type":"text/plain"},"key":"enabled","value":"true"},{"description":{"content":"

(requerido) Endereço completo e acessível na internet do evento para acionamento.

\n","type":"text/plain"},"key":"url","value":"{{webhook-url}}"}],"variable":[]}},"response":[],"_postman_id":"67ddc63e-7d36-4228-ae2e-c57526f180c9"},{"name":"list","id":"233c04b7-639c-4cb5-a25f-2e2bb731d6da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"http://api.meuaplicativo.vip:{{port}}/webhook/list?line={{line}}&key={{accesskey}}","description":"

Lista informações relacionadas ao registro do webhook.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["webhook","list"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"}],"variable":[]}},"response":[],"_postman_id":"233c04b7-639c-4cb5-a25f-2e2bb731d6da"}],"id":"f1b6695a-60a3-4da5-946e-d60de8825026","description":"
\n

Endpoint destinado a utilização de webhooks.

\n
\n

Endpoint for the use of webhooks.

\n

Validações

\n\n

 Criptografia

\n

  SSL: TLS 1.2

\n

 Envio

\n

  Content-Type: application/json

\n

 Retorno

\n

  Status: 200

\n

Recovery

\n\n

 A API possui sistema de recovery para comandos que tiverem retornos inadequados. Durante o período especificado, a API tentará contatar o WebService cadastrado.

\n

  TEMPO: 2 HORAS

\n

Exemplos

\n\n

.:: message_search ::.

\n

Definição: Dedicado na ocorrência ao envio \"message_send\" com resposta via citação (quoted).

\n

Ocorrência: Em alterações comportamentais do registro a partir do evento inicial.

\n

Aplicações: Largamente utilizado para captura de respostas/retorno de mensagens citadas individualmente ou em grupos.

\n

{

\n

 \"event\":\"message_search\",

\n

 \"protocol\":\"\",

\n

 \"context\":

\n

 {

\n

  \"reference\":\"\",

\n

  \"sent\":\"\",boolean

\n

  \"sent_datehour\":\"\",timestamp

\n

  \"destiny\":\"\",

\n

  \"status\":,char/integer

\n

  \"error\":\"\",boolean

\n

  \"error_detail\":\"\",

\n

  \"quoted\":\"\",boolean

\n

  \"quote_message\":\"\"

\n

 }

\n

}

\n

.:: question_search ::.

\n

Definição: Dedicado na ocorrência de resposta ao envio \"question_send\".

\n

Ocorrência: Em alterações comportamentais do registro a partir do evento inicial.

\n

Aplicações: Largamente utilizado para captura de respostas/retorno de mensagens/opções.

\n

{

\n

 \"event\":\"question_search\",

\n

 \"protocol\":\"\",

\n

 \"context\":

\n

 {

\n

  \"reference\":\"\",

\n

  \"sent\":\"\",boolean

\n

  \"sent_datehour\":\"\",timestamp

\n

  \"destiny\":\"\",

\n

  \"error\":\"\",boolean

\n

  \"error_detail\":\"\",

\n

  \"question_answer\":\"\",boolean

\n

  \"question_answer_correct\":\"\",boolean

\n

  \"question_response\":\"\",

\n

  \"question_expired\":\"\"boolean

\n

  \"status\":\"\"numeric

\n

 }

\n

}

\n

.:: requests_start ::.

\n

Definição: Dedicado na ocorrência de acionamentos de interação.

\n

Ocorrência: No ato do contato inicial com o serviço/linha por um visitante/host.

\n

Aplicações: Utilizado geralmente para captação de visitante e posterior apresentação de mensagens automáticas, menus de opções e outras diversas opções automatizadas.

\n

{

\n

 \"event\":\"requests_start\",

\n

 \"context\":

\n

 {

\n

  \"id\":\"\",integer

\n

  \"phone\":\"\"

\n

  \"datehour\":\"\",timestamp

\n

  \"message\":\"\"

\n

 }

\n

}

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"f4600372-cfc5-4291-bead-8ff072f37061","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1feb66fa-3082-4d92-8f28-5e7593964a84","type":"text/javascript","exec":[""]}}],"_postman_id":"f1b6695a-60a3-4da5-946e-d60de8825026"},{"name":"batch","item":[{"name":"message","id":"865225a6-ec76-4d7b-8d04-f5bd0a5adad2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"filename","value":"{{batch_message_file_send-filename}}","description":"

(requerido) Nome do arquivo. Exemplo: Lote.xlsx

\n","type":"text"},{"key":"stream","value":"{{batch_message_file_send-stream}}","description":"

(requerido) Arquivo em formato base64.

\n","type":"text"}]},"url":"http://api.meuaplicativo.vip:{{port}}/batch/message?line={{line}}&key={{accesskey}}&text&question=&destiny=&reference=&app&scheduling","description":"

Realiza o processamento em lote para o evento \"message_send\".

\n

Validações

\n\n

 Microsoft Excel (.xlsx)

\n

  1.Será sempre ignorado a primeira linha;  2.O processamento irá ser encerrado quando antingir a linha em que um ou mais campos obrigatórios estiverem vazios;

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["batch","message"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

(requerido) Telefone emissor/autenticado.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"description":{"content":"

(requerido) Chave de acesso.

\n","type":"text/plain"},"key":"key","value":"{{accesskey}}"},{"description":{"content":"

(requerido) Indicação da coluna e linha inicial que contém \"Mensagem\". Exemplo: A2

\n","type":"text/plain"},"key":"text","value":null},{"description":{"content":"

(opcional) Indicação da coluna e linha inicial que contém \"Valores aceitos como respostas. Deve ser iniciado e finalizado por colchetes e valores devem estar separados por ; \".

\n","type":"text/plain"},"key":"question","value":""},{"description":{"content":"

(requerido) Indicação da coluna e linha inicial que contém \"Telefone (DDI+DDD+Número) ou ID Grupo\". Exemplo: B2

\n","type":"text/plain"},"key":"destiny","value":""},{"description":{"content":"

(opcional) Indicação da coluna e linha inicial que contém \"Identificação personalizada para o comando. É retornado em pesquisas\".

\n","type":"text/plain"},"key":"reference","value":""},{"description":{"content":"

(opcional) Identificação do emissor.

\n","type":"text/plain"},"key":"app","value":null},{"description":{"content":"

(opcional) Indica a data que o lote deve ser processado. Formato \"ddmmyyyy\".

\n","type":"text/plain"},"key":"scheduling","value":null}],"variable":[]}},"response":[],"_postman_id":"865225a6-ec76-4d7b-8d04-f5bd0a5adad2"}],"id":"fd759db5-bedb-4f6d-9cde-1ab963900e9b","description":"
\n

Objeto de contexto ao qual são relacionados eventos que compõe envios ou processamentos em lote.

\n
\n

Context object to which events that make up batch submissions or processing are related.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"3fe9da95-bf5a-4ddb-9d9c-a96113a989be","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"ec35ce50-95ec-407a-929a-58dde8bd073f","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"fd759db5-bedb-4f6d-9cde-1ab963900e9b"}],"id":"3e7f6360-8449-4a69-85b7-4641488849ee","_postman_id":"3e7f6360-8449-4a69-85b7-4641488849ee","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","name":"Doc API - NETiZap","type":"collection"}}},{"name":"model ( form-data )","item":[{"name":"services","item":[{"name":"message_send","id":"f0f13ffd-36bc-4aa4-9211-02c67fbf6c42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"app","value":"myApp","type":"text"},{"key":"destiny","value":"5527998022075","type":"text"},{"key":"reference","value":"","type":"text"},{"key":"text","value":"write here you text","type":"text"}]},"url":"http://api.meuaplicativo.vip:{{port}}/services/message_send?line={{line}}&accesskey={{accesskey}}","description":"

Realiza o envio de mensagem de texto.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["services","message_send"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

Telefone de origem (autenticado), incluindo código do país e ddd.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"key":"accesskey","value":"{{accesskey}}"}],"variable":[]}},"response":[],"_postman_id":"f0f13ffd-36bc-4aa4-9211-02c67fbf6c42"}],"id":"f5f86567-fddb-4f92-96ce-37637e5baff8","_postman_id":"f5f86567-fddb-4f92-96ce-37637e5baff8","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","name":"Doc API - NETiZap","type":"collection"}}}],"id":"e2c9d67e-4d9f-4f74-a908-3a20d4c2e4a1","_postman_id":"e2c9d67e-4d9f-4f74-a908-3a20d4c2e4a1","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","name":"Doc API - NETiZap","type":"collection"}}},{"name":"model ( json )","item":[{"name":"services","item":[{"name":"message_send","id":"5281f910-8eb1-4027-89e8-5ed92f1e4d90","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","description":"

Tipo do conteúdo.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"app\":\"{{app}}\",\r\n\"destiny\":\"{{destiny}}\",\r\n\"reference\":\"{{reference}}\",\r\n\"text\":\"{{message_send-text}}\"\r\n}"},"url":"http://api.meuaplicativo.vip:{{port}}/services/message_send?line={{line}}&accesskey={{accesskey}}","description":"

Realiza o envio de mensagem de texto.

\n","urlObject":{"protocol":"http","port":"{{port}}","path":["services","message_send"],"host":["api","meuaplicativo","vip"],"query":[{"description":{"content":"

Telefone de origem (autenticado), incluindo código do país e ddd.

\n","type":"text/plain"},"key":"line","value":"{{line}}"},{"key":"accesskey","value":"{{accesskey}}"}],"variable":[]}},"response":[],"_postman_id":"5281f910-8eb1-4027-89e8-5ed92f1e4d90"}],"id":"ab8cc924-e009-49ce-8a73-cde812cd5e91","_postman_id":"ab8cc924-e009-49ce-8a73-cde812cd5e91","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","name":"Doc API - NETiZap","type":"collection"}}}],"id":"497e7bb1-32a2-4cbc-80b2-b63924c2e032","_postman_id":"497e7bb1-32a2-4cbc-80b2-b63924c2e032","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","id":"3dce9d00-d56b-4527-ab1f-9a30d812fe89","name":"Doc API - NETiZap","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"1f8ea062-68f6-4c80-a0d2-c05ba64a6a97","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e671558f-0935-4958-b61d-4032130cf608","type":"text/javascript","exec":[""]}}]}