{"info":{"_postman_id":"fba7f8f8-da54-4e3d-8e13-fbe9b6b75fd3","name":"Documentação APIs Atende Simples","description":"

O Atende Simples provê APIs REST simples e poderosas para integrar com seu site ou aplicação.

\n\n

Essa documentação fornece informações sobre os endpoints disponíveis e como interagir com os mesmos e configurar as integrações.

As requisições à API respondem com formato JSON, sendo assim, o cabeçalho das respostas terá sempre Content-Type: application/json.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"10289073","collectionId":"fba7f8f8-da54-4e3d-8e13-fbe9b6b75fd3","publishedId":"T1LQhm7V","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-08-17T19:24:47.000Z"},"item":[{"name":"API - Clientes","item":[{"name":"Logs de atendentes","id":"431c5067-fc6a-4c7c-a001-63ed2b5d2325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"

API Token de autenticação

\n","type":"text"}],"url":"api.atendesimples.com/customers/attendants/logs?start_at=2020-01-01T00:00&end_at=2020-01-23T15:00&after&size&attendant_email&description&duration&ani&attendant_name&source&direction&call_id&voip_version&kind&screen&extension_number","description":"

API de consulta de logs dos atendentes

\n URL: https://api.atendesimples.com/customers/attendants/logs

\n Header: x-api-key: Token de Autenticação.

\n Parâmetros de consulta de dados:
\n start_at: Data inicio do log
\n end_at: Data fim do log
\n after: Busca os proximos itens da consulta
\n size: Tamanho maximo de itens retornados (Maximo de 1000 itens)
\n attendant_email: Email do atendente
\n description: Descrição da tela
\n duration: Duração Maior ou Igual ao valor (em segundos)
\n ani: Número ANI
\n attendant_name: Nome do atendente
\n source: Origem da chamada
\n direction: Direção da chamada
\n call_id: ID da chamada
\n voip_version: Versão do VoIP Maior ou Igual ao valor
\n kind: Tipo de log
\n screen: Nome da tela
\n extension_number: Ramal

\nCOMO PASSAR OS PARÂMETROS DE CONSULTA NA REQUISIÇÃO
\nhttps://api.atendesimples.com/customers/attendants/logs?start_at&end_at&after&size&attendant_email&description&duration&ani&attendant_name&source&direction&call_id&voip_version&kind&screen&extension_number

\nOBSERVAÇÃO: Na URL de consulta, você deve adicionar o parâmetro=valor

\nEx. https://api.atendesimples.com/customers/attendants/logs?start_at=2020-01-01T00:00&end_at=2020-01-23T15:00&kind=action

\nNo campo de datas segue o padrão [ano-mês-diaT00:00]\n","urlObject":{"path":["customers","attendants","logs"],"host":["api","atendesimples","com"],"query":[{"description":{"content":"

Data inicio do log

\n","type":"text/plain"},"key":"start_at","value":"2020-01-01T00:00"},{"description":{"content":"

Data fim do log

\n","type":"text/plain"},"key":"end_at","value":"2020-01-23T15:00"},{"description":{"content":"

Busca os proximos itens da consulta

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

Tamanho maximo de itens retornados (Maximo de 1000 itens)

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

Email do atendente

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

Descrição da tela

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

Duração Maior ou Igual ao valor (em segundos)

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

Número ANI

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

Nome do atendente

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

Origem da chamada

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

Direção da chamada

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

ID da chamada

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

Versão do VoIP Maior ou Igual ao valor

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

Tipo de log

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

Nome da tela

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

Ramal

\n","type":"text/plain"},"key":"extension_number","value":null}],"variable":[]}},"response":[{"id":"15af5960-b8fa-45b3-a20a-093cbc0addb5","name":"Logs de atendentes","originalRequest":{"method":"GET","header":[{"description":"API Token de autenticação","key":"x-api-key","type":"text","value":""}],"url":{"raw":"api.atendesimples.com/customers/attendants/logs?start_at=2020-01-01T00:00&end_at=2020-01-15T00:00&kind=action","host":["api","atendesimples","com"],"path":["customers","attendants","logs"],"query":[{"description":"Data inicio do log (Ano - Mês - Dia)","key":"start_at","value":"2020-01-01T00:00"},{"description":"Data fim do log (Ano - Mês - Dia)","key":"end_at","value":"2020-01-15T00:00"},{"description":"Busca os proximos itens da consulta","key":"after","value":null,"disabled":true},{"description":"Tamanho maximo de itens retornados (Maximo de 100 itens)","key":"size","value":null,"disabled":true},{"description":"Email do atendente","key":"attendant_email","value":null,"disabled":true},{"description":"Descrição da tela","key":"description","value":null,"disabled":true},{"description":"Duração Maior ou Igual ao valor (em segundos)","key":"duration","value":null,"disabled":true},{"description":"Número ANI","key":"ani","value":null,"disabled":true},{"description":"Nome do atendente","key":"attendant_name","value":null,"disabled":true},{"description":"Origem da chamada","key":"source","value":null,"disabled":true},{"description":"Direção da chamada","key":"direction","value":null,"disabled":true},{"description":"ID da chamada","key":"call_id","value":null,"disabled":true},{"description":"Versão do VoIP Maior ou Igual ao valor","key":"voip_version","value":null,"disabled":true},{"description":"Tipo de log","key":"kind","value":"action"},{"description":"Nome da tela","key":"screen","value":null,"disabled":true},{"description":"Ramal","key":"extension_number","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 63395,\n \"after\": 1581020914072,\n \"items\": [\n {\n \"configuration\": {\n \"wrap_up_time_outbound_active\": true,\n \"hold_active\": false,\n \"dialer_queue_active\": false,\n \"transfer_active\": true,\n \"post_attendance_active\": true,\n \"beep_termited_call_active\": false,\n \"dtmf_active\": true,\n \"wrap_up_time_inbound_active\": true,\n \"calling_timer_active\": true,\n \"pause_button_active\": true,\n \"dump_call_active\": true,\n \"send_logs_active\": true\n },\n \"description\": null,\n \"screen\": \"disconnected\",\n \"source\": \"voip\",\n \"attendants_groups\": [\n {\n \"extension_number\": 16\n }\n ],\n \"duration\": 0,\n \"attendant\": {\n \"sip_number\": \"90900197019\",\n \"extension_number\": \"19\",\n \"name\": \"RH1\",\n \"email\": \"rh1@atende.com\"\n },\n \"ani_number\": null,\n \"last_machine_attributes\": {\n \"isWebSocketsSupported\": true,\n \"publicAddress\": \"177.126.85.250\",\n \"sessionID\": \"f3df3c04-395d-f7e576d1\",\n \"hasMicrophone\": true,\n \"hasWebcam\": true,\n \"osName\": \"Mac OS X\",\n \"isWebRTCSupported\": true,\n \"voipNumberVersion\": \"1.14.111.1559\",\n \"isWebSocketsBlocked\": false,\n \"osVersion\": \"10_14_6\",\n \"localAddress\": \"192.168.1.105\",\n \"hasSpeakers\": true,\n \"browserVersion\": \"80.0.3987.87\",\n \"browserName\": \"Chrome\",\n \"loggedInAt\": \"2020-02-06T19:37:04.912Z\",\n \"localNetworkType\": \"wlan\",\n \"voipVersion\": \"Versão 1.14.111.1559\",\n \"isMobileDevice\": false\n },\n \"screen_name\": \"Desconectado\",\n \"complements\": {\n \"offline\": {},\n \"wrapup\": {\n \"source\": null,\n \"direction\": null\n },\n \"ringing\": {\n \"duration\": 0,\n \"from\": null,\n \"source\": null,\n \"direction\": null,\n \"has_error\": false\n },\n \"inactive\": {},\n \"waiting\": {},\n \"busy\": {\n \"transfer\": null,\n \"dtmf\": null,\n \"from\": null,\n \"source\": null,\n \"direction\": null\n },\n \"pause\": {\n \"scheduled\": false,\n \"type\": {}\n }\n },\n \"description_name\": null,\n \"dnis\": \"08008870608\",\n \"id\": \"590\",\n \"email\": \"rh1@atende.com\",\n \"timestamp\": \"2020-02-06T20:28:34.072Z\",\n \"machine_attributes\": {\n \"isWebSocketsSupported\": true,\n \"publicAddress\": \"177.126.85.250\",\n \"sessionID\": \"f3df3c04-395d-f7e576d1\",\n \"hasMicrophone\": true,\n \"hasWebcam\": true,\n \"osName\": \"Mac OS X\",\n \"isWebRTCSupported\": true,\n \"voipNumberVersion\": \"1.14.111.1559\",\n \"isWebSocketsBlocked\": false,\n \"osVersion\": \"10_14_6\",\n \"localAddress\": \"192.168.1.105\",\n \"hasSpeakers\": true,\n \"browserVersion\": \"80.0.3987.87\",\n \"browserName\": \"Chrome\",\n \"loggedInAt\": \"2020-02-06T19:37:04.912Z\",\n \"localNetworkType\": \"wlan\",\n \"voipVersion\": \"Versão 1.14.111.1559\",\n \"isMobileDevice\": false\n },\n \"status_changed_by\": \"voip\",\n \"previous\": null,\n \"kind\": \"status\",\n \"call\": {\n \"x_call_id\": null,\n \"ani_number\": null,\n \"dnis\": \"08008870608\",\n \"call_id\": null\n },\n \"last_statuses\": null,\n \"status_complements\": null,\n \"allow_save\": true,\n \"extension_number\": \"19\",\n \"name\": \"RH1\",\n \"user\": {},\n \"send_logs_active\": true\n }\n ]\n}"}],"_postman_id":"431c5067-fc6a-4c7c-a001-63ed2b5d2325"},{"name":"Logs de CDRs","id":"dd853964-e6c2-4ba0-9557-43f6d0198493","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"

API Token de autenticação

\n","type":"text"}],"url":"api.atendesimples.com/customers/cdrs/logs?start_at&end_at&after&size&call_id&alt_dnis&ori_billing_time&total_charge&selected_options&zendesk_ticket_id&configuration_kind&period&call_terminated&customer_phone&call_status&my_status_name&my_status_complement_1&my_status_complement_2&my_tags","description":"

API de consulta de logs dos cdrs

\n","urlObject":{"path":["customers","cdrs","logs"],"host":["api","atendesimples","com"],"query":[{"description":{"content":"

Data inicio do log

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

Data fim do log

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

Busca os proximos itens da consulta

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

Tamanho maximo de itens retornados (Maximo de 1000 itens)

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

ID da chamada

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

Número da chamada

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

Duração arredondada

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

Valor total

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

Opções chamada navegou

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

Ticket zendesk

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

Tipo do discador

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

Periodo

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

Quem desligou

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

Telefone do Cliente iniciando com 55, exemplo: 552125253939

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

Status da Chamada [answered | failed | missed | handled | abandoned]

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

Nome do MyStatus

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

Complement do MyStatus 1

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

Complement do MyStatus 1

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

Nome do MyTags

\n","type":"text/plain"},"key":"my_tags","value":null}],"variable":[]}},"response":[{"id":"98c0e63f-24b3-4757-9f0c-00c457fd03e6","name":"Logs de CDRs","originalRequest":{"method":"GET","header":[{"key":"x-api-key","value":"","description":"API Token de autenticação","type":"text"}],"url":{"raw":"https://api.atendesimples.com/customers/cdrs/logs","protocol":"https","host":["api","atendesimples","com"],"path":["customers","cdrs","logs"],"query":[{"key":"start_at","value":null,"description":"Data inicio do log","disabled":true},{"key":"end_at","value":null,"description":"Data fim do log","disabled":true},{"key":"after","value":null,"description":"Busca os proximos itens da consulta","disabled":true},{"key":"size","value":null,"description":"Tamanho maximo de itens retornados (Maximo de 100 itens)","disabled":true},{"key":"call_id","value":null,"description":"ID da chamada","disabled":true},{"key":"alt_dnis","value":null,"description":"Número da chamada","disabled":true},{"key":"ori_billing_time","value":null,"description":"Duração arredondada","disabled":true},{"key":"total_charge","value":null,"description":"Valor total","disabled":true},{"key":"selected_options","value":null,"description":"Opções chamada navegou","disabled":true},{"key":"zendesk_ticket_id","value":null,"description":"Ticket zendesk","disabled":true},{"key":"configuration_kind","value":null,"description":"Tipo do discador","disabled":true},{"key":"period","value":null,"description":"Periodo","disabled":true},{"key":"call_terminated","value":null,"description":"Quem desligou","disabled":true},{"key":"customer_phone","value":null,"description":"Telefone do Cliente iniciando com 55, exemplo: 552125253939","type":"text","disabled":true},{"key":"call_status","value":null,"description":"Status da Chamada [answered | failed | missed | handled | abandoned]","type":"text","disabled":true},{"key":"my_status_name","value":null,"description":"Nome do MyStatus","type":"text","disabled":true},{"key":"my_status_complement_1","value":null,"description":"Complement do MyStatus 1","type":"text","disabled":true},{"key":"my_status_complement_2","value":null,"description":"Complement do MyStatus 1","type":"text","disabled":true},{"key":"my_tags","value":null,"description":"Nome do MyTags","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"after\": 1580164093000,\n \"items\": [\n {\n \"callid\": \"69709941\",\n \"my_status_name\": \"status 9\",\n \"selected_options\": \"2,4\",\n \"number_info3\": \"teste3\",\n \"number_info2\": \"teste2\",\n \"call_status_humanized\": \"Chamada Abandonada\",\n \"selected_call_classification_tags\": null,\n \"number_info1\": \"teste1\",\n \"ani_uf\": \"TO\",\n \"call_status\": \"abandoned\",\n \"uraduration\": 29,\n \"dnis\": \"5508008870608\",\n \"period\": \"worktime\",\n \"public_audio_url\": \"https://staging.atendesimples.com/public/audios/53f866da4ec24ab8b5448acc3a6d3214\",\n \"my_status_code\": \"9\",\n \"voicemail\": false,\n \"ani_long\": \"-48.3317167\",\n \"block_reason\": null,\n \"ani_state\": \"Tocantins\",\n \"number_host\": \"www.eu.com\",\n \"total_charge\": \"1.35\",\n \"dialduration\": 0,\n \"dialer_type\": null,\n \"result_leg_a_humanized\": null,\n \"block_reason_humanized\": null,\n \"number_name\": \"Teste22\",\n \"configuration_kind\": \"default\",\n \"leg_a_type_humanized\": \"Atendente\",\n \"call_status_complement\": \"ring_off\",\n \"week_day\": \"monday\",\n \"period_humanized\": \"Horário normal\",\n \"ani_city\": \" Palmas\",\n \"period_complement\": null,\n \"my_tags\": \"Hugo Luis\",\n \"direction_humanized\": \"Entrante\",\n \"has_audio\": false,\n \"alt_dnis\": \"5508008870608\",\n \"ani_provider\": \"OI\",\n \"my_status_info_2\": null,\n \"my_status_info_1\": null,\n \"my_status_info_3\": null,\n \"ani_prefix\": \"63\",\n \"ani_kind\": \"cellphone\",\n \"redirects\": [\n {\n \"group_id\": 1,\n \"attendable_type\": \"Attendant\",\n \"ori_real_time\": 2,\n \"billing_time\": 60,\n \"charge\": \"0.0\",\n \"initial_date\": \"2020-01-21T10:49:01.000-03:00\",\n \"end_time\": \"2020-01-21T10:49:03.000-03:00\",\n \"attendant_ani\": \"5590900513130\",\n \"option\": 1,\n \"redirect_terminated\": \"A\",\n \"user_name\": \"Atendente 2\",\n \"user_email\": \"teste2@teste.com\",\n \"user_extension\": \"130\",\n \"sipcode\": null,\n \"mailbox_detected\": false,\n \"timeout_voscenter\": \"f\"\n }\n ],\n \"interactions\": [\n {\n \"flow_kind\": \"default\",\n \"redirecting_option\": null,\n \"name\": null,\n \"digits\": \"\",\n \"validation_status\": \"error\",\n \"status_humanized\": null,\n \"validation_status_humanized\": \"Inválida\",\n \"option_selected\": \"4\",\n \"status\": null\n }\n ],\n \"leg_a_type\": \"attendant\",\n \"call_terminated\": \"A\",\n \"configuration_kind_humanized\": \"Padrão\",\n \"ori_end_time\": \"2020-01-27T19:28:42.000-03:00\",\n \"ori_charge\": \"1.35\",\n \"ani_lat\": \"-10.168891\",\n \"customer_info\": null,\n \"ani\": \"5563984866338\",\n \"ring_duration_a\": null,\n \"ring_duration_b\": null,\n \"direction\": \"inbound\",\n \"ring_duration_c\": null,\n \"queue_dialer_name\": null,\n \"card_info_1\": null,\n \"result_leg_a\": null,\n \"my_status_complement_2\": null,\n \"result_leg_b\": null,\n \"my_status_complement_1\": null,\n \"zendesk_ticket_id\": null,\n \"result_leg_b_humanized\": null,\n \"audio_processing_state\": \"idle\",\n \"duration_call\": 29,\n \"ori_start_time\": \"2020-01-27T19:28:13.000-03:00\",\n \"ori_billing_time\": 60,\n \"card_info_2\": null,\n \"card_info_3\": null\n }\n ]\n}"}],"_postman_id":"dd853964-e6c2-4ba0-9557-43f6d0198493"},{"name":"Logs de fichas","id":"323e3807-65ef-43cc-9da5-2088021233eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"description":"

API Token de autenticação

\n","key":"x-api-key","type":"text","value":""}],"url":"api.atendesimples.com/customers/dialer-queue/cards?token&start_at&end_at&after&size&number&status&card_info_1&card_info_2&card_info_3","description":"

API de consulta de logs das fichas

\n","urlObject":{"path":["customers","dialer-queue","cards"],"host":["api","atendesimples","com"],"query":[{"description":{"content":"

Token do discador (Obrigatorio)

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

Data inicio do log

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

Data fim do log

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

Busca os proximos itens da consulta

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

Tamanho maximo de itens retornados (Maximo de 1000 itens)

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

Numero de discagem

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

Status da ficha

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

Info discador 1

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

Info discador 2

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

Info discador 3

\n","type":"text/plain"},"key":"card_info_3","value":null}],"variable":[]}},"response":[{"id":"746c5066-a324-47ff-9e5d-e7bf5437db6b","name":"Logs de fichas","originalRequest":{"method":"GET","header":[{"description":"API Token de autenticação","key":"x-api-key","type":"text","value":""}],"url":{"raw":"api.atendesimples.com/customers/dialer-queue/cards?token=lpnIf8ACeW70YtQNPitLr5DbL2I3ZlU71skFwTJL","host":["api","atendesimples","com"],"path":["customers","dialer-queue","cards"],"query":[{"key":"token","value":"lpnIf8ACeW70YtQNPitLr5DbL2I3ZlU71skFwTJL","description":"Token do discador (Obrigatorio)"},{"key":"start_at","value":null,"description":"Data inicio do log","disabled":true},{"key":"end_at","value":null,"description":"Data fim do log","disabled":true},{"key":"after","value":null,"description":"Busca os proximos itens da consulta","disabled":true},{"key":"size","value":null,"description":"Tamanho maximo de itens retornados (Maximo de 100 itens)","disabled":true},{"key":"number","value":null,"description":"Numero de discagem","disabled":true},{"key":"status","value":null,"description":"Status da ficha","disabled":true},{"key":"card_info_1","value":null,"description":"Info discador 1","disabled":true},{"key":"card_info_2","value":null,"description":"Info discador 2","disabled":true},{"key":"card_info_3","value":null,"description":"Info discador 3","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"total\": 1,\n \"after\": 1580480009669,\n \"items\": [\n {\n \"card_info_1\": \"Truck\",\n \"number\": \"5521999999999\",\n \"schedule\": null,\n \"source\": \"Atende Simples - Format_2020-01-24T09_44_16.380Z_2020-01-31T14:13:24.131Z.csv\",\n \"is_scheduled\": false,\n \"card_info_2\": \"Grade Baixa\",\n \"token\": \"****************\",\n \"card_info_3\": \"NÃO\",\n \"status\": \"to_call\",\n \"timestamp\": \"2020-01-31T14:13:29.669Z\"\n }\n ]\n}"}],"_postman_id":"323e3807-65ef-43cc-9da5-2088021233eb"}],"id":"3ffeb36b-7f48-4da1-86c5-9011a4dad70f","description":"

API de busca de logs para clientes da Atende Simples

\n","event":[{"listen":"prerequest","script":{"id":"e84807a1-f855-4be2-a9dc-6dae3b3f8410","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a59b98b4-63e8-478b-ba72-6e37f8cc89a1","type":"text/javascript","exec":[""]}}],"_postman_id":"3ffeb36b-7f48-4da1-86c5-9011a4dad70f"},{"name":"API - Discador","item":[{"name":"API Discador","id":"9020e143-dd06-4820-a0a3-31e7f59232c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"dialer\":{\r\n\"dials\": [{\r\n\"attendant_email\": \"teste@teste.com\",\r\n\"extension_number\": 101,\r\n\"customer_info\": \"Teste Chamada\",\r\n\"client\": {\r\n\"phones\": [{\r\n\"name\":\"\",\r\n\"number\": \"552125383939\",\r\n\"type\": \"2\"}]}}]},\r\n\"token\": \"35f8f78b00e56e56d229ced49946667bccaceeb196de\"}"},"url":"https://dialer.atendesimples.com/","description":"\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n\n \n \n\n

\"attendant_email\":	email do atendente que vamos enviar a ligação
\"extension_number\":	Ramal do atendente que vamos enviar a ligação. Pode ser enviado apenas o email e o ramal ou apenas o email ou apenas o ramal. Se não for enviado o ramal e houver mais de um atendene cadastrado com o mesmo email, a chamada será realizada para um dos atedentes aleatoriamente.
\"customer_info\":	Informação que será salva e poderá ser consultada no campo customer_info via webhook ou no campo discador custumer info para o relatórios de chamadas.
\"name\":	Campo opcional com informação complementar que poderá ser usada como variável para anúncio ao atendente ou cliente, conforme configuração do fluxo do discador.
\"number\":	Número do cliente para qual será realizada a chamada. Enviar preferencialmente apenas números no formato: 55 + DDD + número.

","urlObject":{"protocol":"https","path":[""],"host":["dialer","atendesimples","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9020e143-dd06-4820-a0a3-31e7f59232c4"}],"id":"83005f65-4a35-41c5-99dd-70db2f077bed","description":"

Através da API do discador conseguimos enviar um pedido de ligação direto ao voip de um atendente.
\nAo ser feita a requisição o Atende Simples irá processar a chamada e a ligação será realizada em seguida.

Importante:

Atualmente não há um controle de chamadas simultâneas no discador por API.
","event":[{"listen":"prerequest","script":{"id":"c4a3f397-d971-48fc-997e-b8df78be7994","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9a6b2842-fce8-4dfc-9eaf-8bacd8921587","type":"text/javascript","exec":[""]}}],"_postman_id":"83005f65-4a35-41c5-99dd-70db2f077bed"},{"name":"API - Discador por Fila","item":[{"name":"Postagem de Ficha","id":"1a1ca6e4-4a1b-49ed-96a3-3f80171b3d31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"IH6MoVokoF84GsvN7vw4z6s5UmuDHhzm4QcpYQjs","type":"text"},{"key":"user-id","value":"10551","type":"text"},{"key":"queue-id","value":"queue|dc530442-9420-42a3-83e4-627554082421","type":"text"},{"key":"token","value":"a9571e7ab6b57b9cd2cab27757ead98fa2fe046160acc44a","type":"text"}],"body":{"mode":"raw","raw":"[\n { \n \"number\":\"11990000000\",\n \"card_info_1\":\"\",\n \"card_info_2\":\"\", \n \"card_info_3\":\"\", \n \"schedule\":\"\" \n },\n { \n \"number\":\"11990000001\",\n \"card_info_1\":\"Exemplo info 1\",\n \"card_info_2\":\"Exemplo info 2\", \n \"card_info_3\":\"Exemplo info 3\", \n \"schedule\":\"2020-07-13T17:00\" \n },\n { \n \"number\":\"11990000002\",\n \"card_info_1\":\"Teste\",\n \"card_info_2\":\"\", \n \"card_info_3\":\"\", \n \"schedule\":\"\" \n }\n]\n\n"},"url":"https://api.atendesimples.com/v1/cards","description":"

Informações a serem enviadas no body:

\n\n

number: Numero do telefone no formato DDD+Numero (Campo obrigatório).

card_info_1: Informação a ser adicionada na ficha no campo Info 1 ( Campo opcional , pode ser enviado em vazio).

card_info_2:Informação a ser adicionada na ficha no campo Info 2 (Campo opcional , pode ser enviado em vazio).

card_info_3:Informação a ser adicionada na ficha no campo Info 3 (Campo opcional , pode ser enviado em vazio).

schedule: Data de agendamento de discagem da ficha no formato ano-mm-dd-T24:00. Para enviar uma ficha sem agendamento , basta encaminhar este campo vazio.

\n","urlObject":{"protocol":"https","path":["v1","cards"],"host":["api","atendesimples","com"],"query":[],"variable":[]}},"response":[{"id":"62c3f1c3-1be1-4d48-b052-de0ac61b2155","name":"Postagem de Ficha","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","type":"text","value":"IH6MoVokoF84GsvN7vw4z6s5UmuDHhzm4QcpYQjs"},{"key":"user-id","type":"text","value":"10551"},{"key":"queue-id","type":"text","value":"queue|dc530442-9420-42a3-83e4-627554082421"},{"key":"token","type":"text","value":"a9571e7ab6b57b9cd2cab27757ead98fa2fe046160acc44a"}],"body":{"mode":"raw","raw":"[\n{ \n\"number\":\"11990000000\",\n\"card_info_1\":\"\",\n\"card_info_2\":\"\", \n\"card_info_3\":\"\", \n\"schedule\":\"\" \n},\n{ \n\"number\":\"11990000001\",\n\"card_info_1\":\"Exemplo info 1\",\n\"card_info_2\":\"Exemplo info 2\", \n\"card_info_3\":\"Exemplo info 3\", \n\"schedule\":\"2020-07-13T17:00\" \n},\n{ \n\"number\":\"11990000002\",\n\"card_info_1\":\"Teste\",\n\"card_info_2\":\"\", \n\"card_info_3\":\"\", \n\"schedule\":\"\" \n}\n\n]\n\n","options":{"raw":{"language":"json"}}},"url":"https://api.atendesimples.com/v1/cards"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1a1ca6e4-4a1b-49ed-96a3-3f80171b3d31"},{"name":"Cancelamento de Ficha","id":"7e03bc49-9da8-4da5-9a09-f9439504bb51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"IH6MoVokoF84GsvN7vw4z6s5UmuDHhzm4QcpYQjs"},{"key":"user-id","type":"text","value":"10551"},{"key":"queue-id","type":"text","value":"queue|9e3cea74-49ac-45fe-b6d7-8115d1e16e60"},{"key":"token","type":"text","value":"5e29dd110f1e0f64afc57cc2daa43a7dfee30ffa6ffbdc13"}],"body":{"mode":"raw","raw":"{ \n\"token\":\"f0673f187aeb6cf4d4a692680f2a3cd7ed1ed08134e3d2d9\"\n}"},"url":"api.atendesimples.com/v1/cards","description":"

Este método permite realizar o cancelamento de fichas. Conseguimos realizar o cancelamento de fichas incluídas via api, csv, callback e manual de um determinado discador por fila.

Informações do Body

\nnumber: Numero do telefone da ficha.

\nstatus: Status da ficha.
\n -> to_call (Aguardando Discagem)
\n -> trying (Tentando Discagem)
\n -> dialing (Discando)
\n -> success (Sucesso)

\nsource: Origem de inclusão da Ficha(api,callback,manual e csv(inserir o nome do arquivo csv importado).

\nstart_at: Data de inicio para exclusão de ficha (formato ano-mm-dd-T24:00).

\nend_at: Data fim para exclusão de ficha (formato ano-mm-dd-T24:00).

\ncard_info_1: Informação do campo do campo Info 1 da ficha.

\ncard_info_2: Informação do campo do campo Info 2 da ficha.

\ncard_info_3: Informação do campo do campo Info 3 da ficha.

\ntoken: Token do discador por fila (obrigatório).

\n\n

IMPORTANTE: Se enviarmos uma request apenas com o Token, todas ás fichas do discador serão canceladas.

","urlObject":{"path":["v1","cards"],"host":["api","atendesimples","com"],"query":[],"variable":[]}},"response":[{"id":"2c4646b4-2f25-4c9d-9b4b-88807b66fb8a","name":"Exemplo Cancelamento de Ficha utilizando Intervalo de Datas","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","type":"text","value":"IH6MoVokoF84GsvN7vw4z6s5UmuDHhzm4QcpYQjs"},{"key":"user-id","type":"text","value":"10551"},{"key":"queue-id","type":"text","value":"queue|9e3cea74-49ac-45fe-b6d7-8115d1e16e60"},{"key":"token","type":"text","value":"5e29dd110f1e0f64afc57cc2daa43a7dfee30ffa6ffbdc13"}],"body":{"mode":"raw","raw":"{ \n\"start_at\":\"2020-07-16T00:00\",\n\"end_at\":\"2020-07-16T23:59\",\n\"token\":\"5e29dd110f1e0f64afc57cc2daa43a7dfee30ffa6ffbdc13\"\n}","options":{"raw":{"language":"json"}}},"url":"api.atendesimples.com/v1/cards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 16 Jul 2020 12:25:33 GMT"},{"key":"x-amzn-RequestId","value":"1bfe223b-e287-40f2-b9a8-b61b174ecb9c"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"PxARjEaxoAMFgKg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f10473d-13665b383f813778ba968b50;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Thu, 16 Jul 2020 12:25:33 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 c59efe844fd614ff20a756172908fed1.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"uTU2acFlBhK3388jUGky9o88f3XGNTEJ4geUcVT6TZ8J6iJ1PKcekA=="}],"cookie":[],"responseTime":null,"body":"{\n \"cards_canceled\": 3\n}"},{"id":"a0f0a9fb-da10-40a8-94e4-874c305c25f7","name":"Exemplo de Cancelamento de ficha Utilizando Status","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"IH6MoVokoF84GsvN7vw4z6s5UmuDHhzm4QcpYQjs"},{"key":"user-id","type":"text","value":"10551"},{"key":"queue-id","type":"text","value":"queue|9e3cea74-49ac-45fe-b6d7-8115d1e16e60"},{"key":"token","type":"text","value":"5e29dd110f1e0f64afc57cc2daa43a7dfee30ffa6ffbdc13"}],"body":{"mode":"raw","raw":"{ \n\"status\":\"trying\",\n\"token\":\"5e29dd110f1e0f64afc57cc2daa43a7dfee30ffa6ffbdc13\"\n}"},"url":"api.atendesimples.com/v1/cards"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"20"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 16 Jul 2020 12:19:11 GMT"},{"key":"x-amzn-RequestId","value":"94c3c1b7-f189-4174-9fd9-eb28a345f38f"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"Pw_V2EdmIAMFrXg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f1045be-1cd87cfc3c6e610fe5f416ad;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Thu, 16 Jul 2020 12:19:11 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 410afdc6f5ccb1e217b0553f07e83049.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"wZEJ1D4EIxg72fZY7X4Uk7Y07JKo8wYU8VcP_4TE06PKQLsUyIwwFQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"cards_canceled\": 1\n}"}],"_postman_id":"7e03bc49-9da8-4da5-9a09-f9439504bb51"}],"id":"d70ac111-7106-4163-befe-269657e6eaf3","description":"

A requisição para postagem ou cancelamento de ficha via api do Discador por fila é feita atravésde um Post/delete “json”, nessa requisição devemos informar os dados abaixo:

Url da Api:

https://api.atendesimples.com/v1/cards
\n

Header

\nContent-Type: application/json
\nx-api-key:IH6MoVokoF84GsvN7vw4z6s5UmuDHhzm4QcpYQjs
\nuser-id:Id da conta.
\nqueue-id: Id do discador por fila.
\ntoken: Token do discador por fila.
\nOs campos user-id,queue-id e token estão disponiveis em Discador -> Discador por fila -> Selecionar o discador desejadoi -> Importar fichas -> Importar. ( https://app.atendesimples.com/outbound/configurations/dialer_queues ).
","event":[{"listen":"prerequest","script":{"id":"900886e3-d1df-42df-ba2a-29a6996c6cd2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9641b4d8-c9e7-4635-97e9-0ac8ca957db3","type":"text/javascript","exec":[""]}}],"_postman_id":"d70ac111-7106-4163-befe-269657e6eaf3"},{"name":"API - Download de Áudio","item":[{"name":"Download do Audio","id":"f944e765-d0fb-46de-926c-5740ed005ab8","protocolProfileBehavior":{"followRedirects":false,"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-api-key","value":"Token de autenticação","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"callid\": \"123456\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.atendesimples.com/customers/audio/download","urlObject":{"protocol":"https","path":["customers","audio","download"],"host":["api","atendesimples","com"],"query":[],"variable":[]}},"response":[{"id":"02cd282c-b5d1-41ad-8634-c9abb1b9e71c","name":"Download do Audio","originalRequest":{"method":"POST","header":[{"key":"x-api-key","value":"Token de autenticação","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"callid\": \"123456\"\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.atendesimples.com/customers/audio/download"},"status":"Moved Permanently","code":301,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 17 Dec 2020 13:03:43 GMT"},{"key":"x-amzn-RequestId","value":""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":""},{"key":"Location","value":"Link para download do audio"},{"key":"X-Amzn-Trace-Id","value":""},{"key":"Access-Control-Allow-Credentials","value":""},{"key":"X-Cache","value":""},{"key":"Via","value":""},{"key":"X-Amz-Cf-Pop","value":""},{"key":"X-Amz-Cf-Id","value":""}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"f944e765-d0fb-46de-926c-5740ed005ab8"}],"id":"2996f6be-e0fd-4075-b2d1-82c4e26bef60","description":"

Nessa API de áudio do Atende Simples permite realizar o download de gravações de áudios das chamadas realizadas. Basta na requisição do tipo Post enviar no body o callid da chamada que desejada

\n\n

Estrutura da requisição:

\n\n

Endpoint	https://api.atendesimples.com/customers/audio/download
x-api-key	Token de autenticação , o token de autenticação é gerado dentro de sua plataforma atende simples em opções da conta -> Configuração de Acesso à API de Áudio
Callid	Id da chamada que deseja solicitar o arquivo de áudio , somente é possível enviar um callid por requisição

\n\n

A resposta de sua requisição será um status 301.
No header da resposta, no campo Location será enviado o link para download do arquivo de áudio.
O Link para download tem expiração de 60 segundos , se o link expirar deverá ser feito uma nova requisição.

","_postman_id":"2996f6be-e0fd-4075-b2d1-82c4e26bef60"},{"name":"API - Interação","item":[{"name":"Estrutura da API","id":"6c5080b0-a41d-42da-a6af-34630f1ca83a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Sempre que um cliente estiver em uma opção de interação e digitar um número o Atende Simples vai mandar uma requisição JSON síncrona para sua API no seguinte formato:
\n

{\"interaction\":{\"selected_option\":\"2\",\"digits\":\"12345\",\"call_id\":\"9999999\",\"ani\":\"551122222222\",\"dnis\":\"5508008871565\"}}

option_selected: número da opção da respectiva interação.
digits: número digitado por seu cliente.
call_id: Código identificador da chamada único (esse id será o mesmo para todos os posts referente a essa ligação).
ani: Número do telefone de quem ligou para o seu atendimento (ponta A), no formato código do país + DDD + telefone. Exemplo: \"552130409670\".
dnis: Número do seu atendimento, no formato código do país + número. Exemplo:\"5508008871565\".

\nAo enviar a requisição para sua API o Atende Simples espera uma resposta no formato JSON com o padrão abaixo:
\nExemplo com Prompt:
\n

{\"interaction\":{ \"option_selected\": \"W\", \"action\": {\"prompt\": \"Texto de mensagem\", \"option\":\"Z\"}}}

\n
\nExemplo com áudio:
\n

{\"interaction\":{ \"option_selected\": \"W\", \"action\": {\"prompt_audio\": \"dbee7586-b0ec-4d2a-a185-b1066fc53460\", \"option\":\"Z\"}}}

option_selected: Número da opção referente a respectiva resposta. Esse atributo é opcional para ajudar a dubugar caso haja qualquer problema (atributo opcional).
prompt: Mensagem que o sistema irá ler para seu cliente antes de direcionar a chamada a opção informada. Atributo opcional, caso não queira nenhuma mensagem e que a chamada vá automaticamente para a opção basta não incluir o atributo
Áudio que o sistema irá exibir para seu cliente antes de direcionar a chamada a opção informada. Na opção de “áudio” deve ser incluído o token do áudio. Este atributo é opcional, caso não queira nenhuma mensagem e que a chamada vá automaticamente para a opção desejada basta não incluir o atributo
option: Atributo obrigatório com o número da opção que a chamada será encaminhada.

Atenção\n

Se seu cliente digitar um número com menos dígitos do que o configurado na Interação o Atende Simples seguirá o fluxo configurado para essa interação e não será feita requisição para sua API.

Diferente do webhook que podem ser enviadas várias opções digitadas (selected_options), na interação será sempre um opção por requisição e por isso o atributo é no singular: selected_option.

Se sua API não responder em 5 segundos ou responder fora do padrão a chamada será enviada para a opção configurada no campo: Se der erro na consulta ao seu sistema, a chamada vai para a\nopção...

O sistema de leitura do Atende Simples irá ler o texto, caso exista, da forma que tiver escrito.Recomendamos que faça um teste da pronúncia no campo de mensagem de boas-vindas para ter\ncerteza que o texto está ok.

Se um número da opção da resposta não estiver configurada no seu fluxo de atendimento o sistema irá tocar uma mensagem que houve uma falha na ligação e deve retornar mais tarde em seguida a chamada será desligada (para evitar essa situação certifique que todas as possíveis opções de resposta estão configuradas no seu fluxo de atendimento do Atende Simples)

","urlObject":{"query":[],"variable":[]}},"response":[{"id":"874ce065-a60b-43c7-8cdd-d8f60380c4cd","name":"Exemplo de requisição com áudio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"interaction\":{\"selected_option\":\"2\",\"digits\":\"12345\",\"call_id\":\"9999999\",\"ani\":\"551122222222\"\r\n,\"dnis\":\"5508008871565\"}}","options":{"raw":{"language":"json"}}},"url":"Endpoint do cliente"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\"interaction\":{ \"option_selected\": \"2\", \"action\": {\"prompt_audio\":\"dbee7586-b0ec-4d2a-a185-b1066fc53460\", \"option\":\r\n\"5\"}}}"},{"id":"b19fe450-0265-4883-8fbb-1690f43d59ba","name":"Exemplo de Requisão com Prompt","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"interaction\":{\"selected_option\":\"2\",\"digits\":\"12345\",\"call_id\":\"9999999\",\"ani\":\"551122222222\"\r\n,\"dnis\":\"5508008871565\"}}\r\n","options":{"raw":{"language":"json"}}},"url":"Endpoint do cliente"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\"interaction\":{ \"option_selected\": \"2\", \"action\": {\"prompt\": \"Texto de mensagem\", \"option\":\r\n\"5\"}}}"}],"_postman_id":"6c5080b0-a41d-42da-a6af-34630f1ca83a"}],"id":"2acd64c4-adeb-4a27-b0be-863a415ae2a1","description":"

Interação é uma funcionalidade do Atende Simples que permite tratar as chamadas baseadas nos\nnúmeros digitados por seus clientes durante a ligação. A validação dos números pode ser feita por seu\nsistema, através de uma API, em uma lista pré-definida ou fixo.\nCom a Interação é possível validar clientes antes de atender, aprofundar as integrações com seus\nsistemas, registrar informações, ...

","_postman_id":"2acd64c4-adeb-4a27-b0be-863a415ae2a1"},{"name":"API - Pré Chamada","item":[{"name":"Estrutura da API","id":"23ae4932-ccfa-4c7d-a013-ba70ec6f8d0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Quando alguém ligar para o atendimento, o Atende Simples vai mandar uma requisição JSON síncrona para sua API no seguinte formato:

{\"incoming_call\":{\"call_id\":\"9999999\",\"ani\":\"552122223456\",\"dnis\":\"5508008871565\"}}

Incoming_call: toda requisição de pré chamada é uma incoming_call
Call_id: identificador da chamada.
ani: Número do telefone de quem ligou para o seu atendimento, no formato código do país + DDD + telefone.
dnis: Número do seu atendimento, no formato código do país + número

\nAo enviar a requisição para a API Externa o Atende Simples espera uma resposta no formato JSON com o seguinte formato:
\nResposta com texto:
\n

{\"incoming_call\":{\"action\":{\"prompt\":\"Mensagem de boas vindas\",\"option\":\"Z\"}}}

\nResposta com áudio:
\n

{\"incoming_call\":{\"action\":{\"prompt_audio\":\"dbee7586-b0ec-4d2a-a185-b1066fc53460\",\"option\":\"Z\"}}}

Prompt: Mensagem que o sistema irá exibir no lugar da mensagem de boas-vindas configurada no seu atendimento. Este atributo é opcional, caso não queira nenhuma mensagem e que a chamada vá automaticamente para a opção desejada basta não incluir o atributo.
Audio: Áudio que o sistema irá exibir no lugar da mensagem de boas-vindas configurada no seu atendimento. Na opção de “áudio” deve ser incluído o token do áudio. Este atributo é opcional, caso não queira nenhuma mensagem e que a chamada vá automaticamente para a opção desejada basta não incluir o atributo.

\nO Token do áudio é encontrado em Opções da conta -> Áudios\n

ATENÇÃO:
\n

A requisição para sua API é síncrona e deverá enviar uma resposta em até 5 segundos (time out).
Se sua API não responder em 5 segundos ou responder fora do padrão a chamada seguirá o fluxo normal configurado.
Caso sua API responda um prompt e uma option, o sistema vai ler a mensagem de boas-vindas e depois automaticamente encaminhar a chamada para a opção enviada.
Se sua API responder um número de opção que não esteja configurada ou que não exista, seu cliente vai ouvir a mensagem: Opção inválida e em seguida seguirá o fluxo normal configurado.
Caso exista um prompt o sistema de leitura do Atende Simples irá ler o texto da forma que tiver escrito.Recomendamos que faça um teste da pronúncia no campo de mensagem de boas-vindas para ter certeza que o texto está ok.
Se sua API responder para bloquear a chamada com “option”: “block”, o Atende Simples irá descartar o atributo prompt caso exista. A chamada será automaticamente desligada.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"2b1ff153-98c4-4100-83dd-618f557207c5","name":"Exemplo de Requisção com Audio","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"incoming_call\":{\"call_id\":\"9999999\",\"ani\":\"552122223456\",\"dnis\":\"5508008871565\"}}","options":{"raw":{"language":"json"}}},"url":"Endpoint da api do cliente"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"incoming_call\": {\n \"action\": {\n \"prompt_audio\": \"dbee7586-b0ec-4d2a-a185-b1066fc53460\",\n \"option\": \"1\"\n }\n }\n}"},{"id":"b7393356-5d2f-4780-9b81-6ff0110aa77f","name":"Exemplo de Requisção com Prompt","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"incoming_call\":{\"call_id\":\"9999999\",\"ani\":\"552122223456\",\"dnis\":\"5508008871565\"}} ","options":{"raw":{"language":"json"}}},"url":"Endpoint da api do cliente"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"incoming_call\": {\n \"action\": {\n \"prompt\": \"Mensagem de boas vindas\",\n \"option\": \"1\"\n }\n }\n}"}],"_postman_id":"23ae4932-ccfa-4c7d-a013-ba70ec6f8d0c"}],"id":"c6bd3c63-d51f-479a-a194-1d913165a5f7","description":"

Pré-chamada é uma funcionalidade que permite identificar uma ligação antes de seu atendimento e definir automaticamente alguns parâmetros, como por exemplo; personalizar mensagens de boas-vindas para grupos ou clientes específicos, encaminhar o cliente a uma opção específica do fluxo de chamada, distribuir chamadas baseadas no DDD, bloquear ligações de números específicos ou por faixa.

\nPara visualizar a configuração da pré-chamada em nossa aplicação clique aqui\n","_postman_id":"c6bd3c63-d51f-479a-a194-1d913165a5f7"},{"name":"API - Voip","item":[{"name":"Abrir página","id":"641ed85d-53a7-4967-b608-4eaeaf17d349","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"url:open\",\r\n \"options\": { \"url\": \"https://www.atendesimples.com/\" }\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"disabled":true,"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 "}],"variable":[]}},"response":[{"id":"fdebe063-8142-4123-9704-cd012cc99e45","name":"Abrir página","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","type":"text","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"url:open\",\r\n \"options\": { \"url\": \"https://www.atendesimples.com/\" }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","protocol":"https","host":["api","atendesimples","com"],"path":["voip","status"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 09 Jul 2020 13:31:04 GMT"},{"key":"x-amzn-RequestId","value":"9b2a30b9-556a-4798-bc40-3ec73b5a2a57"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"PaFTxGyWIAMF2Hw="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f071c18-84ef50c912310615cbca6069;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Thu, 09 Jul 2020 13:31:04 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 b7b2667a8f791fb60d70bb1835ef9b2b.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"o6S7jYqE9uKcewF7e_mMVueydF28z9Kn8xbHZn5apsJnmBsFwOESfQ=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"641ed85d-53a7-4967-b608-4eaeaf17d349"},{"name":"Abrir página via notificação","id":"4e7b42d9-0a09-4e47-a40f-147187ab3c4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"url:notification\",\r\n \"options\": { \"url\": \"https://www.atendesimples.com/\" }\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"disabled":true,"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 "}],"variable":[]}},"response":[{"id":"559d01bd-9460-4799-a280-6823fa69c08e","name":"Abrir página via notificação","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","type":"text","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"url:notification\",\r\n \"options\": { \"url\": \"https://www.atendesimples.com/\" }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","protocol":"https","host":["api","atendesimples","com"],"path":["voip","status"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 09 Jul 2020 13:38:22 GMT"},{"key":"x-amzn-RequestId","value":"b5a98ed9-01d0-48d0-9b6e-9d09de4c940e"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"PaGYJEH1IAMFxsg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f071dcd-90f34a6a8b77ab3bd3d693cf;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Thu, 09 Jul 2020 13:38:22 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 ff59f24ad9231de5fbb56e661c4dad59.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"pWRsGgieIPZ_KY6gdEHvtsoIaQdEc6krfsJplDBGuCCL4TSG_eCuIA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"4e7b42d9-0a09-4e47-a40f-147187ab3c4c"},{"name":"Enviar mensagem para o voip","id":"7649140f-62da-4e45-8fc2-95a93931ec48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"x-api-key","type":"text","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"teste@teste.com\",\r\n \"extension_number\": 111,\r\n \"action\": \"inbox:attendant\",\r\n \"options\": {\r\n \"notification\": true,\r\n \"messages\": [\r\n {\r\n \"subject\": \"Titulo da mensagem\",\r\n \"content\": \"Mensagem a ser enviada ao voip \"\r\n },\r\n {\r\n \"subject\": \"Teste Mensagem\",\r\n \"content\": \"Solicite confirmação do cliente ao receber o protocolo 123 \"\r\n }\r\n ]\r\n }\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"}],"variable":[]}},"response":[],"_postman_id":"7649140f-62da-4e45-8fc2-95a93931ec48"},{"name":"Pausa - Improdutiva","id":"bbe10fd7-24bc-4441-b78c-a6ba98cfd459","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"action:pause\",\r\n \"active_pause_type\": {\r\n \"kind\": \"not_working\",\r\n \"position\": 1\r\n }\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"disabled":true,"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 "}],"variable":[]}},"response":[{"id":"5f6aa8d1-2fa7-46fb-9a4c-114111365434","name":"Pausa - Improdutiva","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"action:pause\",\r\n \"active_pause_type\": {\r\n \"kind\": \"not_working\",\r\n \"position\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","protocol":"https","host":["api","atendesimples","com"],"path":["voip","status"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 ","disabled":true}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 08 Jul 2020 18:12:14 GMT"},{"key":"x-amzn-RequestId","value":"b23526c5-2d32-4f22-90a8-10348cb88bc2"},{"key":"x-amzn-ErrorType","value":"ForbiddenException"},{"key":"x-amz-apigw-id","value":"PXbjyGLEIAMF8lw="},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 5ce364e30dcfb61805012dae39f02ed5.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"DTcqixOQ5jJ02D_vhBcaeg7vYSXwoMLAuI1MexfbzVgTjmFG-s2yGg=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Forbidden\"\n}"}],"_postman_id":"bbe10fd7-24bc-4441-b78c-a6ba98cfd459"},{"name":"Pausa - Produtiva","id":"faf4efe0-59f7-4b94-ad26-2cd153450063","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"action:pause\",\r\n \"active_pause_type\": {\r\n \"kind\": \"working\",\r\n \"position\": 1\r\n }\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"disabled":true,"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 "}],"variable":[]}},"response":[{"id":"e363e51c-3599-43e4-805e-1f1944fda7a6","name":"Pausa - Produtiva","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"extension_number\": 111,\r\n \"action\": \"action:pause\",\r\n \"active_pause_type\": {\r\n \"kind\": \"working\",\r\n \"position\": 1\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","protocol":"https","host":["api","atendesimples","com"],"path":["voip","status"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 08 Jul 2020 18:24:36 GMT"},{"key":"x-amzn-RequestId","value":"ba954dbf-2623-4217-b54b-509b9e014b40"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"PXdXmFlZoAMFirA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f060f63-f65dc7d489a029dc3216e5c8;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Wed, 08 Jul 2020 18:24:36 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 e185c441fa41d36301225c1b7a30aea0.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"aTt7S8GDnFwXe9nHasKUXkGmM1sXuZnO3z9d6dCji4RsIUlebdMS9g=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"faf4efe0-59f7-4b94-ad26-2cd153450063"},{"name":"Reload","id":"51b5a528-38f8-4989-883e-b5d4ed22428c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"action\": \"action:reload\",\r\n\"extension_number\": 111\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"disabled":true,"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 "}],"variable":[]}},"response":[{"id":"b0d4a5c5-ee71-423e-95c8-bcb76da3aa7e","name":"Reload","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"action\": \"action:reload\",\r\n\"extension_number\": 111\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","protocol":"https","host":["api","atendesimples","com"],"path":["voip","status"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 08 Jul 2020 17:30:32 GMT"},{"key":"x-amzn-RequestId","value":"f7db3a75-9a8d-4dec-9dbe-731e65a22418"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"PXVcuFkGIAMFSIQ="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f0602b7-6ebf62ae64bc37926518d7c7;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Wed, 08 Jul 2020 17:30:32 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 03a01756f425f7cd985f2fe307cb3527.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"GtVk9DCpG06Xycqz4iFp1Gh7_JWycShOPMr2NIKdjyU0bFGxhBfhsw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"51b5a528-38f8-4989-883e-b5d4ed22428c"},{"name":"Habilitar/Desabilitar Discador","id":"b1741095-5a6e-43a4-addb-5b97053a3e6a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"action\": \"action:dialer-queue\",\r\n\"extension_number\": 111\r\n}"},"url":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","urlObject":{"protocol":"https","path":["voip","status"],"host":["api","atendesimples","com"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"disabled":true,"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 "}],"variable":[]}},"response":[{"id":"5bf457f9-3392-4720-a5f5-adda6a729bf1","name":"Discador por fila","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"x-api-key","value":"r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\"email\":\"teste@teste.com\",\r\n\"action\": \"action:dialer-queue\",\r\n\"extension_number\": 111\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api.atendesimples.com/voip/status?token=4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999","protocol":"https","host":["api","atendesimples","com"],"path":["voip","status"],"query":[{"key":"token","value":"4e49c6be9cf8d8543eaa55469509a8dfe2cc23d67bfb9999"},{"key":"","value":"KQEGuDpto52h4In9wuflk59W5UMYsF9h5Lofckc7 ","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 08 Jul 2020 17:27:25 GMT"},{"key":"x-amzn-RequestId","value":"a4fafe83-1024-4126-ac3c-664fe7f7c999"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"x-amz-apigw-id","value":"PXU_bE7voAMFZDA="},{"key":"X-Amzn-Trace-Id","value":"Root=1-5f0601fc-44bb61447779c00c84463a04;Sampled=1"},{"key":"x-amzn-Remapped-Date","value":"Wed, 08 Jul 2020 17:27:25 GMT"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-Cache","value":"Miss from cloudfront"},{"key":"Via","value":"1.1 03a01756f425f7cd985f2fe307cb3527.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"GRU1-C1"},{"key":"X-Amz-Cf-Id","value":"l8pX-sm4FgM-xzmLDYMFDuDtMqXkE1-Yd6xw0U_meORRAcuhxx4tjw=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Success\"\n}"}],"_postman_id":"b1741095-5a6e-43a4-addb-5b97053a3e6a"}],"id":"2d793036-7035-4703-8509-36831ddc7aca","description":"

Nessa API do VoIP do Atende Simples permite executar ações no Voip de um determinado atendente através de requisições.Basta na requisição do tipo Post identificar o atendente através do seu email e ramal e especificar ação com seu complemento, se for o caso.

\n\n

Hoje é possível fazer as seguintes ações:

\n\n

Discador por fila	action:dialer-queue	essa ação liga ou desliga o discador por fila no VoIP do atendente. Se o discador tiver ligado, a ação vai desligá-lo. Se o discador por fila tiver desligado, a ação vai ligá-lo. (Em breve vamos criar as ações ligar e desligar especificamente)
Desconectar	action:hangup	essa ação desloga o voip
Sair da pausa ou continuar	action:resume	Essa ação tira o voip do modo pausa ou wrapup. Se o Voip estiver em Ligação ou Wrapup com pausa agendada, essa ação desliga o agendamento da pausa.
Desligar	action:disconnect	Essa ação desliga uma chamada em curso. Se for uma chamada entrante e o fluxo da ligação tiver cofnigurado com ação pós atendimento, o cliente será direcionado para a opção de pós atendimento.
Atender	action:answer	Se o voip estiver na tela de Tocando recebendo uma chamada essa ação atende a ligação
Rejeitar	action:reject	Se o voip estiver na tela de Tocando recebendo uma chamada essa ação irá rejeitar a ligação.
Pausar	action:pause	Se o VoIP estiver na tela de Disponível ou Tocando essa ação coloca o Voip imediatamente em pausa. Se o VoIP estiver na tela em Ligação ou Wrapup essa ação programa o VoIP para entrar em pausa após o término da chamada e do wrapup (se houver). Essa ação necessita de informação complementar identificando qual pausa que o Voip vai entrar. Essa identificação é feita sinalziando se é uma pausa produtiva ou não produtiva e qual o número da pausa, conforme configurado na conta.
Abrir página	action:url:open	Essa ação abre uma nova aba na link especificado na ação. ATENÇÃO: essa ação exige que o chrome esteja liberado para popup. Na primeira vez que essa ação for executada no browser o Chrome irá identificar se o atendente aceita que o Atende Simples gere popups. Se essa opção não for habilitada a abertura de página não irá funcionar. A URL deve ter o padrão completo: https://www.atendesimples.com/
Abrir página via notificação	action:url:notification	Essa ação funciona de forma semelhante a Abrir página, a diferença é que a página não é aberta automaticamente. É gerado uma notificação e o atendente tem a opção de clicar em abrir página ou recusar a página. Vale a mesma regra do aceite de popup da ação Abrir página. A URL deve ter o padrão completo: https://www.atendesimples.com/
Ativar/desativar bloqueio de chamadas entrantes	action:blocked-inbound	Essa ação ativa ou desativa o bloqueio de chamadas entrantes no VoIP do atendente. Se o bloqueio estiver ativado, a ação vai desligá-lo. Se o bloqueio estiver desligado, a ação vai ligá-lo.
Ativar bloqueio de chamadas entrantes	action:blocked-inbound-on	Essa ação ativa o bloqueio de chamadas entrantes no VoIP do atendente.
Desativar bloqueio de chamadas entrantes	action:blocked-inbound-off	Essa ação desativa o bloqueio de chamadas entrantes no VoIP do atendente.
Enviar mensagem para o voip	action: inbox:attendant	Essa ação envia uma mensagem para o voip do atendente.

\n\n

Metodo:POST

URL: https://api.atendesimples.com/voip/status?token=TOKEN_DO_VOIP

Headers:

x-api-key:r8xsZLBZR82ScRhWouxvu38BllnxYn223mTKKigs

Content-Type: application/json

Body:

email: E-mail do atendente.

extension_number: Ramal do atendente

action: Tipo de ação a ser executada.

\n\n

action:dialer-queue
action:reload
action:disconnect
action:unpause ou action:resume
action:hangup
action:answer
action:reject
action:pause
action:url:notification
action:url:open
action: inbox:attendant

\n\n

Exemplo de body de pausa

\n\n

kind: working (produtiva) ou not_working (não produtiva)

position: é o número da pausa conforme configurado na conta

\n\n

{\n    \"email\": \"atendente@emai.com\",\n    \"extension_number\": 21,\n    \"action\": \"action:pause\",\n    \"active_pause_type\": {\n        \"kind\": \"not_working\",\n        \"position\": 1\n    }\n}\n\n

","event":[{"listen":"prerequest","script":{"id":"b2bd71e9-6127-4d1a-9028-016c519f391f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"660e1c73-ffee-4600-8cd5-a48a0e5b943e","type":"text/javascript","exec":[""]}}],"_postman_id":"2d793036-7035-4703-8509-36831ddc7aca"},{"name":"Webhooks","item":[{"name":"Requisição","id":"ee39cd33-a243-47fc-90e4-a81b78ae78f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

As requisições realizadas para as URLs configuradas nos webhooks contém os seguintes cabeçalhos:

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Cabeçalho	Descrição
X-AtendeSimples-Event	Código do evento que gerou a requisição.
X-AtendeSimples-Request-Id	Código identificador da requisição, no formato UUID.
X-AtendeSimples-Environment	Ambiente de onde a requisição foi disparada (production ou staging).
X-Hub-Signature	Assinatura de segurança, para a sua aplicação verificar a autenticidade da requisição. O valor desse header é computado com o HMAC hex digest do corpo da requisição, usando o algoritmo sha1 com a chave secreta do webhook (disponível na página do webhook) como chave de criptografia (ver exemplo ao lado).
User-Agent	AtendeSimples-Robot + o ambiente que originou a requisição.
Content-Type:	Formato do payload, de acordo com o que for configurado no webhook. Os formatos disponíveis são application/json e application/x-www-form-urlencoded.

\n","urlObject":{"query":[],"variable":[]}},"response":[{"id":"3e682244-2b3d-41f9-bf0b-29be4fce8e29","name":"Exemplo de requisição","originalRequest":{"method":"POST","header":[{"key":"User-Agent","value":"AtendeSimples-Robot (staging)","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"X-Hub-Signature","value":"sha1=5780ee6915fcc2d2e6a847d9c9e48f9ebe0159e7","type":"text"},{"key":"X-AtendeSimples-Event","value":"ping","type":"text"},{"key":"X-AtendeSimples-Request-Id","value":"c11366b2-813e-499c-a673-cbf03c17eed5","type":"text"},{"key":"X-AtendeSimples-Environment","value":"staging","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"event_code\": \"ping\",\r\n \"call\": {\r\n \"call_id\": 1004\r\n },\r\n \"webhook\": {\r\n \"id\": 1,\r\n \"url\": \"http://requestb.in/1d4c5sf1\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ee39cd33-a243-47fc-90e4-a81b78ae78f4"},{"name":"Eventos","id":"21d5c667-8948-4e1c-a572-75e32ee9c987","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

Todo evento possui um código que identifica o seu tipo. Esses códigos são formatados no padrão resource.event, sendo resource o nome do recurso e event o nome do evento disparado. Na tabela abaixo estão listados todos os tipos de eventos do Atende Simples:\n

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Código	Descrição
call.newcall	Quando uma chamada nova é iniciada.
call.a_leg_answered	Quando uma chamada é atendida pela ponta A. Somente quando a `direction` for `outbound`
call.b_leg_answered	Quando uma chamada é atendida pela ponta B
call.finished	Quando uma chamada é finalizada.
call.audio_available	Quando o áudio de uma chamada fica disponível para dar play.
call.interaction	Quando quem ligou digita um número válido em alguma interação.
call.word_spotting	Quando uma chamada tiver termos em monitoramento identificados.

\n\n

Ao configurar um webhook, você seleciona quais desses eventos ele escutará. Marcar somente os eventos específicos que você precisa tratar pode ajudar a limitar a quantidade de requisições HTTP que a sua aplicação receberá. Somente os eventos selecionados farão com que o webhook dispare requisições.

\n\n

Nota: Independentemente de existir webhooks configurados ou não, o Atende Simples registra todos os eventos internamente (com exceção do ping) e os disponibiliza no Log de eventos por um tempo limitado.

\n\n

EVENTO PING
\nO evento ping é um evento especial disparado para testar se a URL do webhook está funcionando. Quando um webhook é criado, é necessário fazer a ativação do mesmo através do botão “Enviar ping”, que dispara um evento ping.

\nEsse evento não é registrado no log de eventos.

\n\n

EVENTOS CORINGA (WILDCARD)\nEventos coringa (wildcard) não são eventos que acontecem no Atende Simples, são apenas representações de um conjunto de eventos que um webhook pode escutar. Os eventos coringa disponíveis são:\n

\n \n \n \n \n \n \n \n \n \n \n \n \n

Cabeçalho	Descrição
*	Todos os eventos do Atende Simples, inclusive os que ainda surgirão.
call.*	Todos os eventos do recurso call (chamada), inclusive os que ainda surgirão.

","urlObject":{"query":[],"variable":[]}},"response":[{"id":"b31b123b-9c6d-411c-a525-cd3153bec208","name":"Exemplo de como gerar o X-Hub-Signature","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"# Chave secreta do webhook\r\nkey = '31f439e8b93520776732ad97e129700d9d1020ed'\r\n\r\n# Corpo da requisição\r\nbody = '{\"event_code\":\"call.finished\",\"call\":{\"call_id\":\"123123\"}}'\r\n\r\ndigest = OpenSSL::Digest.new('sha1')\r\nOpenSSL::HMAC.hexdigest(digest, key, body)\r\n=> 'c7fb37d21fc3a868e346eca1d89af5ce15f83317'","options":{"raw":{"language":"json"}}},"url":""},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"21d5c667-8948-4e1c-a572-75e32ee9c987"},{"name":"Payloads","id":"e2fd4ba2-7d06-428b-9492-395f950f83cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"","description":"

As requisições enviadas pelos webhooks possuem um conjunto de informações chamado de payload, que contém dados do recurso (do momento que o evento ocorre) e dados do próprio evento. Essas informações são estruturadas nos seguintes campos:

event_code	Código do evento que originou a requisição, seguindo o padrão resource.event.
webhook	Dados do webhook que disparou a requisição.
call	Dados da chamada.
changes	Mudanças realizadas no recurso(presente somente quando event for updated)

\n\n

Veja exemplos de payloads para todos os tipos de evento na coluna ao lado.

Campo	Tipo	Descrição
call_id	String	Código identificador da chamada.
from_number	String	Número do telefone de quem ligou para o seu atendimento (ponta A), no formato código do país + DDD + telefone. Exemplo: \"552130409670\".
ani_prefix	String	DDD do telefone de quem ligou.
ani_city	String	Cidade do telefone de quem ligou.
ani_state	String	Nome do estado do telefone de quem ligou.
ani_uf	String	Siglas do estado do telefone de quem ligou, exemplo: “SP”.
ani_kind	String	Tipo do telefone de quem ligou (\"cellphone\", \"linephone\" ou \"unknown\").
ani_provider	String	Operadora do telefone de quem ligou.
ani_lat	String	Latitude do telefone de quem ligou.
ani_long	String	Longitude do telefone de quem ligou call_terminated String Perna que desligou a chamada (“Plataforma”, “A” ou “B”).
dnis	String	Número do seu atendimento, no formato código do país + número. Exemplo: \"5508008871565\".
alt_dnis	String	Número para o qual foi realizada a chamada originalmente e redirecionada para o dnis, no formato código do país + número. Exemplo: \"5508008871898\".
number_name	String	Nome definido para o número que a chamada foi realizada, os nomes para cada número podem ser configurados clicando em “Opções de conta” e depois no menu “Números”.
number_host	String	Host definido para o número que a chamada foi realizada, os hosts para cada número podem ser configurados clicando em “Opções de conta” e depois no menu “Números”.
number_info1	String	Valor definido para o número que a chamada foi realizada, os valores para cada número podem ser configurados clicando em “Opções de conta” e depois no menu “Números”, no campo “Info 1”.
number_info2	String	Valor definido para o número que a chamada foi realizada, os valores para cada número podem ser configurados clicando em “Opções de conta” e depois no menu “Números”, no campo “Info 2”.
number_info3	String	Valor definido para o número que a chamada foi realizada, os valores para cada número podem ser configurados clicando em “Opções de conta” e depois no menu “Números”, no campo “Info 3”.
direction	String	Direção da chamada: inbound ou outbound. Ex.: quando alguém ligar para o seu atendimento será inbound ou quando for uma chamada de alguns dos discadores será outbound.
started_at	DateTime	Data e hora do início da chamada, no formato ISO8601, com fuso horário -0300 (referente ao do Brasil, GMT-3). Exemplo: \"2015-05-07T16:26:05.000-03:00\".
status_details	String	Complemento do status. Pode vir com o nome do atendente que atendeu a ligação, uma mensagem personalizada ou com a mensagem \"Desligada\".
block_reason	String	Motivo da chamada ter sido bloqueada.
my_status_code	String	Código do Meu Status aplicado na chamada.
my_status_name	String	Nome do Meu Status aplicado na chamada.
my_status_complement_1	String	Complemento 1 do Meu Status aplicado na chamada.
my_status_complement_2	String	Complemento 2 do Meu Status aplicado na chamada.
my_status_info_1	String	Info 1 do Meu Status aplicado na chamada.
my_status_info_2	String	Info 2 do Meu Status aplicado na chamada.
my_status_info_3	String	Info 3 do Meu Status aplicado na chamada.
my_kpi	Array	Nomes das tags aplicadas na chamada.
result_leg_a	String	Resultado da perna A (\"answered\", \"error\", \"others\", \"busy_or_unavailable\", \"answered_machine\", \"not_answered\" ou \"absent\").
result_leg_b	String	Resultado da perna B (\"answered\", \"error\", \"others\", \"busy_or_unavailable\", \"canceled\", \"answered_machine\", \"not_answered\" ou \"absent\").
leg_a_type	String	Tipo de perna A (\"attendant\" ou \"client\").
attendant_name	String	Nome do Atendente que atendeu a ligação.
attendant_email	String	Email do Atendente que atendeu a ligação.
attendant_number	String	Telefone do Atendente que atendeu a ligação.
attendant_extension_number	String	Ramal do Atendente que atendeu a ligação.
voicemail	Boolean	Se tem caixa postal
dialer_tab_path	String	Campo do path da url que o usuário estava ao realizar a ligação pela extensão do chrome. Somente será preenchido quando for utilizado a extensão do chrome , para outras chamadas saintes e entrantes este campo virá preenchido como null.
business_hours	String	Identifica se a chamada ocorreu dentro ou fora do horário de atendimento configurado. Os valores possíveis são: worktime e out_of_worktime.
business_hours_complement	String	Complemento do horário, pode vir com o nome do feriado em que a chamada foi efetuada.
inbound_amount	Float	Valor cobrado referente a chamada recebida (entrante).
total_amount	Float	Valor total cobrado pela chamada (incluindo a chamada recebida e os reencaminhamentos).
billed_duration	String	Duração arredondada da chamada (em segundos) considerada para cobrança.
inbound_duration	String	Duração real da chamada (em segundos), sem arredondamento.
ura_duration	String	Duração na ura (em segundos), sem arredondamento.
dial_duration	String	Tempo de espera na fila (em segundos), sem arredondamento.
ring_duration_a	String	Tempo que levou a pessoa atender a ligação da perna A (em segundos), sem arredondamento.
ring_duration_b	String	Tempo que levou a pessoa atender a ligação da perna B (em segundos), sem arredondamento.
ring_duration_c	String	Tempo que levou a pessoa atender a ligação da perna C (em segundos), sem arredondamento.
selected_options	Array	Opções do menu digitadas por quem ligou, na ordem em que forem digitadas. Se o atendimento for automático, ou seja, sem menu de opções, o valor retornado será sempre \"1\". Dependendo da configuração do atendimento, é possível digitar mais de uma opção. Exemplo: [\"1\", \"3\"].
kind	String	Tipo da configuração usada na ligação.
call_tags	Array	Classificações da chamada registradas por quem atendeu a ligação. Exemplo: [{\"code\": \"70\", \"description\": \"Lead\"}].
call_tags ￫ code	String	Código que o atendente digitou para efetuar a classificação.
call_tags ￫ description	String	Descrição referente ao código digitado na classificação.
audio_url	String	Link para o arquivo com a gravação da conversa ou áudio da caixa postal. Exemplo: \"https://app.atendesimples.com/public/audios/98b2ec022a7f051a84e65b\".
zendesk_ticket_id	String	Código identificador do ticket do Zendesk associado à chamada.
customer_info	String	Informação por chamada enviada por sua API na requisição de uma chamada sainte, na resposta de uma pré-chamada ou na resposta de uma interação. Caso não tenha sido enviada essa informação, o campo ficará em branco. Se durante uma chamada forem enviados diferentes customer_info, ficará sempre armazenado a última string.
dialer_info_1	String	Info 1 definida na ficha do discador por fila.
dialer_info_2	String	Info 2 definida na ficha do discador por fila.
dialer_info_3	String	Info 3 definida na ficha do discador por fila.
outbound_calls	Array	Informações referente aos reencaminhamentos da chamada (pode haver mais de um). Só serão apresentados os reencaminhamentos que forem atendidos.
outbound_calls ￫ started_at	DateTime	Data e hora do reencaminhamento, no formato ISO8601, com fuso horário -0300 (referente ao do Brasil, GMT-3). Exemplo: \"2015-05-07T17:26:05.000-03:00\".
outbound_calls ￫ phone_number	String	Número do telefone que atendeu o reencaminhamento. Exemplo: \"5511999999999\".
outbound_calls ￫ name	String	Nome do atendente que atendeu o reencaminhamento. Exemplo: \"João\".
outbound_calls ￫ email	String	E-mail do atendente que atendeu o reencaminhamento. Exemplo: joao@suaempresa.com.
outbound_calls ￫ email	String	E-mail do atendente que atendeu o reencaminhamento. Exemplo: joao@suaempresa.com.
outbound_calls ￫ extension	Integer	Ramal do atendente que atendeu o reencaminhamento. Exemplo: 22.
outbound_calls ￫ duration	String	Duração real do reencaminhamento (em segundos).
outbound_calls ￫ billed_duration	String	Duração cobrada do reencaminhamento (em segundos).
outbound_calls ￫ option	Integer	opção em que a chamada foi atendida pelo Atendente. Exemple: 6.
outbound_calls ￫ queue_id	Integer	Código interno da fila de atendimento que atendeu a chamada, sendo: de 0 a 9 opções diretas do menu, de 21 a 99 ramais, 1000 fora de horário e outros números de opções complementares.
outbound_calls ￫ amount	Float	Valor cobrado pelo reencaminhamento. Exemplo: 17.28.
interactions	Array	Informações referente às interações da chamada.
interactions ￫ digits	Integer	Número digitado na interação por quem ligou para seu atendimento.
interactions ￫ selected_option	Integer	Opção de interação do menu digitada por quem ligou.
interactions ￫ validation_status	String	Status de validação da interação. Valores possíveis: \"ok\" ou \"error\".
post_attendances	Array	Informações sobre as pesquisas de pós atendimento.
word_spottings	Array	Informações referente ao monitoramento de termos.
word_spottings ￫ word	Array	Termo identificado durante a chamada. Exemplo: \"procon\".
word_spottings ￫ word_group	Array	Grupo ao qual o termo pertence. Exemplo: \"reclamação\".
word_spottings ￫ score	Integer	Porcentagem de certeza de que o termo identificado na chamada é realmente o que foi configurado. Exemplo: 85.
word_spottings ￫ occurred_at	Time	Tempo da chamada em que o termo foi identificado. Sendo uma representação de tempo, a data virá sempre “zerada”, e deverá ser desconsiderada. Exemplo: \"1900-01-01T00:01:48.159+00:00\" se refere ao tempo 1m, 48s e 159ms da chamada

","urlObject":{"query":[],"variable":[]}},"response":[{"id":"d250219e-61b3-4ef4-997e-89de360c8d01","name":"Payload do evento call.*","originalRequest":{"method":"VIEW","header":[],"url":""},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"event_code\": \"call.finished\",\n \"webhook\": {\n \"id\": 403,\n \"url\": \"https://webhook.teste.com\"\n },\n \"call\": {\n \"dnis\": \"5508000001234\",\n \"kind\": \"default\",\n \"ani_uf\": \"SP\",\n \"status\": \"answered\",\n \"ani_lat\": \"-23.1790801\",\n \"call_id\": \"1019960053\",\n \"my_tags\": [\n \"My Tag DDD\",\n \"Perna A Desliga\"\n ],\n \"alt_dnis\": \"5508000001234\",\n \"ani_city\": \" São José Dos Campos\",\n \"ani_kind\": \"Celular\",\n \"ani_long\": \"-45.8872475999999\",\n \"ani_state\": \"São Paulo\",\n \"audio_url\": \"https://app.atendesimples.com/public/audios/123abc3456\",\n \"call_tags\": [],\n \"direction\": \"inbound\",\n \"exit_type\": \"normal\",\n \"voicemail\": false,\n \"ani_prefix\": \"12\",\n \"leg_a_type\": \"client\",\n \"short_call\": false,\n \"started_at\": \"2020-09-14 10:39:01 -0300\",\n \"from_number\": \"5512999999999\",\n \"number_host\": \"\",\n \"number_name\": \"\",\n \"ani_provider\": \"Tim\",\n \"block_reason\": null,\n \"interactions\": [\n {\n \"digits\": \"1\",\n \"selected_option\": \"9\",\n \"validation_status\": \"ok\"\n },\n {\n \"digits\": null,\n \"selected_option\": \"35\",\n \"validation_status\": \"error\"\n }\n ],\n \"number_info1\": \"teste 1\",\n \"number_info2\": \"teste 2\",\n \"number_info3\": \"teste 3\",\n \"result_leg_a\": null,\n \"result_leg_b\": null,\n \"total_amount\": \"1.35\",\n \"ura_duration\": \"12.01\",\n \"client_number\": \"5512997297095\",\n \"customer_info\": null,\n \"dial_duration\": \"7.0\",\n \"dialer_info_1\": null,\n \"dialer_info_2\": null,\n \"dialer_info_3\": null,\n \"attendant_name\": null,\n \"business_hours\": \"worktime\",\n \"inbound_amount\": \"1.35\",\n \"my_status_code\": \"1\",\n \"my_status_name\": \"My status DDD 12\",\n \"outbound_calls\": [\n {\n \"name\": \"Atendente 1\",\n \"email\": \"teste@teste.com\",\n \"amount\": \"0.002\",\n \"option\": 1,\n \"duration\": \"6.0\",\n \"queue_id\": 1,\n \"extension\": 111,\n \"started_at\": \"2020-09-14 10:39:21 -0300\",\n \"phone_number\": \"5590910551111\",\n \"billed_duration\": \"60.0\",\n \"redirect_terminated\": \"A\"\n }\n ],\n \"status_details\": \"Atendente 1\",\n \"word_spottings\": [],\n \"attendant_email\": null,\n \"billed_duration\": \"60.0\",\n \"call_terminated\": \"A\",\n \"dialer_tab_path\": null,\n \"ring_duration_a\": \"0.0\",\n \"ring_duration_b\": \"7.0\",\n \"ring_duration_c\": \"0.0\",\n \"attendant_number\": null,\n \"inbound_duration\": \"25.88\",\n \"my_status_info_1\": \"Ddd 12\",\n \"my_status_info_2\": null,\n \"my_status_info_3\": null,\n \"post_attendances\": [\n {\n \"name\": \"Pesquisa\",\n \"digits\": null,\n \"status\": \"7\",\n \"selected_option\": \"35\"\n }\n ],\n \"selected_options\": [\n \"9\",\n \"1\"\n ],\n \"queue_dialer_name\": null,\n \"zendesk_ticket_id\": null,\n \"my_status_complement_1\": \"Teste my status\",\n \"my_status_complement_2\": null,\n \"business_hours_complement\": null,\n \"attendant_extension_number\": null\n }\n}"}],"_postman_id":"e2fd4ba2-7d06-428b-9492-395f950f83cb"}],"id":"d68a95f8-c97a-4f61-af88-04a53f2a5f24","description":"

Webhooks são integrações configuradas na sua conta que escutarão a certos eventos do Atende Simples. Quando um evento ocorrer, o Atende Simples enviará uma requisição HTTP POST (notificação) para a URL configurada no webhook.

Um evento é um ação que acontece com um determinado recurso do Atende Simples. Por exemplo, um evento ocorre quando uma chamada é atendida.

Dependendo da necessidade da sua integração, os webhooks podem ser úteis para atualizar um sistema de tickets externo, gerar um relatório no seu sistema ou executar tarefas diversas.

* Webhooks também são conhecidos como Callbacks ou Reverse API.

","_postman_id":"d68a95f8-c97a-4f61-af88-04a53f2a5f24"}],"event":[{"listen":"prerequest","script":{"id":"5fb8e970-4961-41c4-aae2-86b08051dd35","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"80c601bf-2d97-4286-b01e-2b2d968ba59e","type":"text/javascript","exec":[""]}}]}