{"info":{"_postman_id":"7209db63-a4c8-4102-9f62-c0cda45d88c8","name":"Contact Center API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"9483797","collectionId":"7209db63-a4c8-4102-9f62-c0cda45d88c8","publishedId":"2s93JtP3Ey","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"1E90FF"},"publishDate":"2025-02-17T21:06:06.000Z"},"item":[{"name":"Authentication","item":[{"name":"Login and Get Token","id":"2d80e630-416b-429e-9a0f-ff65cc97dbe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\": \"MyUserName\",\r\n \"password\": \"myPa$$w0rd\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/account/accesstoken","description":"

Autentica o utilizador e devolve o token necessário autenticar com o método Bearer Token os restantes pedidos à API.

\n

No Body do pedido deve ser enviado um objeto JSON com as seguintes propriedades:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropriedadeTipoDescrição
usernameStringNome de utilizador, geralmente o email.
passwordStringa password do utilizador.
\n

Como Resposta obtem-se um objeto JSON como o seguinte:

\n
{\n   \"redirectToken\": \"redirectToken\",\n    \"token\": \"Token\"\n}\n\n\n
\n

Em que só o token é usado para autorização nos restantes métodos da API.

\n

O redirectToken destina~se a uso interno e pode ser descartado.

\n","urlObject":{"path":["account","accesstoken"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"ad64e03b-5a77-4fd3-86d1-bb45e4c82e8e","name":"Response 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"username\" : \"user@domain.tld\",\r\n \"password\" : \"myPa$$w0rd\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/account/accesstoken"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Fri, 10 Mar 2023 14:56:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"redirectToken\": \"JYdbaPeuEQjnNP5EzucwC18A25gFYnnsGAwG\",\n \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1laWRlbnRpZmllciI6IjY3IiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFYXRpc3RhIiwidGVuYW50aWQiOiI3IiwidGltZXpuZWluZm8iOiJHTVQgU3RhbmRhcmQgVGltZSIsImNvdW50cnljb2RlIjoiMzUxIiwiY291bnRyeWlzb2NvZGUiOiJQVCIsImNvdW50cnluYW1lIjoiUG9ydHVnYWwiLCJncm91cGkIjoiNiIsImh0dHA6Ly9zY2hlbWFzLm1pY3Jvc29mdC5jb20vd3MvMjAwOC8wNi9pZGVudGl0eS9jbGFpbXMpbmlzdHJhdGlvbi5hcHAiLCJvcGVyYXRvci5ob21lLmFzciIsIm9wZXJhdG9yLmhvbWUuYW5zd2VyZWRDYWxscyIsIm9wZXJhdG9yLmhvbWUudG90YWxDb252ZXJzYXRpb24iLCJvcGVyYXRvci5ob21lLmF2ZXJhZ2VUYWxrVGltZSIsIm9wZXJhdG9yLmF1dGhlbnRpY2F0aW9uIiwib3BlcmF0b3IuYnJlYWtzLmFjY2VzcyIsIm9wZXJhdG9yLmNhbXBhaWducy5hY2Nlc3MiLCJvcGVyYXRvci5jYWxscy5yZXBvcnRzLmFjY2VzcyIsIm9wZXJhdG9yLmNhbGxzLnJlcG9ydHMuZXhwb3J0Iiwib3BlcmF0b3IuY2FsbHMucmVwb3J0cy5yZWNvcmRpbmdzIiwib3BlcmF0b3IuY2FsbHMuc21zIiwib3BlcmF0b3IuY2FsbHMuY2VydGlmaWVkU01TIiwib3BlcmF0b3IuY2FsbHMuZW1haWwiLCJvcGVyYXRvci5jb250YWN0cy5hY2Nlc3MiLCJvcGVyYXRvci5jb250YWN0cy5zbXMiLCJvcGVyYXRvci5jb250YWN0cy5lbWFpbCIsIm9wZXJhdG9yLmNvbnRhY3RzLnRhc2tzLmFjY2VzcyIsIm9wZXJhdG9yLmNvbnRhY3RzLnRhc2tzLm1hbmFnZSIsIm9wZXJhdG9yLmNvbnRhY3RzLnRhc2tzLnF1ZXVlTWFuYWdlIiwib3BlcmF0b3IuY29udGFjdHMubWFuYWdlIiwib3BlcmF0b3IuY29udGFjdHMuYWxsIiwib3BlcmF0b3IuZW1haWwuc210cCIsIm9wZXJhdG9yLmVtYWlsLmltYXAiLCJvcGVyYXRvci5iZXRhIiwib3BlcmF0b3IuY29udmVyc2F0aW9ucy5hY2Nlc3MiLCJvcGVyYXRvci5jb252ZXJzYXRpb25zLmludGVybmFsY2hhdCIsIm9wZXJhdG9yLmNhbGxzLmxhc3RDYWxscy41Il0sImV4cCI6MTY3ODQ4ODk4OX0.y4H2Zwo35FZpJe-nqxMv2PBePd-VtjU2zyTwurFHZNk\"\n}"}],"_postman_id":"2d80e630-416b-429e-9a0f-ff65cc97dbe4"}],"id":"94528598-beda-430c-97ae-7d45a3766a99","description":"\n","_postman_id":"94528598-beda-430c-97ae-7d45a3766a99"},{"name":"Contact Management","item":[{"name":"Contacts","item":[{"name":"Get CRM Contact by ID","id":"58780590-9363-46a7-9ea9-e3fbbc2bba71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"url":"{{ApiBase}}/contact/getcontactbyid?id={{ContactID}}","description":"

Obtem um contacto através do seu ID.

\n

Aceita como parametros:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParâmetroTipoDescrição
idinteiroO Identificador do Contacto
\n

Como resposta devolve um bjeto JSON como o seguinte:

\n
{\n    \"id\": 8014,\n    \"name\": \"João Ratão\",\n    \"avatar\": null,\n    \"userID\": 6,\n    \"isPrivate\": false,\n    \"companyName\": null,\n    \"companyID\": 0,\n    \"callID\": 0,\n    \"companyFields\": null,\n    \"contactFields\": [\n        {\n            \"id\": 48999,\n            \"formFieldID\": 3,\n            \"value\": \"my work place\",\n            \"label\": \"work\"\n        }\n    ]\n}\n\n
\n","urlObject":{"path":["contact","getcontactbyid"],"host":["{{ApiBase}}"],"query":[{"key":"id","value":"{{ContactID}}"}],"variable":[]}},"response":[{"id":"8db5a1bf-f217-4854-af2a-908c0ff78bc4","name":"Response 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{ApiBase}}/contact/getcontactbyid?id=8014","host":["{{ApiBase}}"],"path":["contact","getcontactbyid"],"query":[{"key":"id","value":"8014"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Fri, 10 Mar 2023 14:44:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 8014,\n \"name\": \"João Ratão\",\n \"avatar\": null,\n \"userID\": 6,\n \"isPrivate\": false,\n \"companyName\": null,\n \"companyID\": 0,\n \"callID\": 0,\n \"companyFields\": null,\n \"contactFields\": [\n {\n \"id\": 48999,\n \"formFieldID\": 3,\n \"value\": \"batatas\",\n \"label\": \"work\"\n }\n ]\n}"}],"_postman_id":"58780590-9363-46a7-9ea9-e3fbbc2bba71"},{"name":"Get CRM Contact Form Fields","id":"fada61bb-44ec-4008-8c61-b83f21b47a7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"graphql","graphql":{"query":"","variables":""}},"url":"{{ApiBase}}/contact/getcontactformfields","description":"\n

Devolve uma estrutura JSON como a seguinte:

\n
[\n  {\n    \"id\": 1,\n    \"source\": 2,\n    \"type\": 0,\n    \"name\": \"job\",\n    \"defaultValue\": null,\n    \"isRequired\": false,\n    \"options\": null\n  },\n  {\n    \"id\": 2,\n    \"source\": 2,\n    \"type\": 11,\n    \"name\": \"company\",\n    \"defaultValue\": null,\n    \"isRequired\": false,\n    \"options\": null\n  },\n  {\n    \"id\": 3,\n    \"source\": 2,\n    \"type\": 12,\n    \"name\": \"phone\",\n    \"defaultValue\": null,\n    \"isRequired\": false,\n    \"options\": [\n      \"work\",\n      \"home\",\n      \"mobilePhone\",\n      \"other\"\n    ]\n  }\n]\n\n
\n

Chama-se a atenção para as propriedades source e type que representam respetivamente a que tipo de contacto e o tipo de campo a que estão associados, conforme os enums seguintes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
sourcetype
Company = 1,
Contact = 2		Text = 0
TextArea = 1
Checkbox = 2
Numeric = 3
Date = 4
DateTime = 5
Radio = 8
Select = 9
SelectMulti = 10
\n
","urlObject":{"path":["contact","getcontactformfields"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"f8a9741e-1007-4e44-af08-c8dd17ddb709","name":"Response 200","originalRequest":{"method":"GET","header":[],"body":{"mode":"graphql","graphql":{"query":"","variables":""}},"url":"{{ApiBase}}/contact/getcontactformfields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Fri, 10 Mar 2023 14:20:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 1,\n \"source\": 2,\n \"type\": 0,\n \"name\": \"job\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": null\n },\n {\n \"id\": 2,\n \"source\": 2,\n \"type\": 11,\n \"name\": \"company\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": null\n },\n {\n \"id\": 3,\n \"source\": 2,\n \"type\": 12,\n \"name\": \"phone\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"work\",\n \"home\",\n \"mobilePhone\",\n \"other\"\n ]\n },\n {\n \"id\": 4,\n \"source\": 2,\n \"type\": 13,\n \"name\": \"email\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"work\",\n \"home\"\n ]\n },\n {\n \"id\": 5,\n \"source\": 2,\n \"type\": 14,\n \"name\": \"url\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"Website\",\n \"Linkedin\",\n \"Twitter\",\n \"Facebook\",\n \"Instagram\"\n ]\n },\n {\n \"id\": 7,\n \"source\": 2,\n \"type\": 9,\n \"name\": \"status\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"lead\",\n \"prospect\",\n \"customer\",\n \"inactive\",\n \"general\"\n ]\n },\n {\n \"id\": 8,\n \"source\": 2,\n \"type\": 10,\n \"name\": \"tags\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"Tag 1\",\n \"Tag 2\",\n \"Tag 3\",\n \"Tag 4\",\n \"Tag 5\"\n ]\n },\n {\n \"id\": 9,\n \"source\": 2,\n \"type\": 9,\n \"name\": \"source\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"advertisement\",\n \"email\",\n \"partner\"\n ]\n },\n {\n \"id\": 10,\n \"source\": 2,\n \"type\": 1,\n \"name\": \"notes\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": null\n },\n {\n \"id\": 11,\n \"source\": 1,\n \"type\": 12,\n \"name\": \"phone\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"work\",\n \"home\",\n \"mobilePhone\",\n \"other\"\n ]\n },\n {\n \"id\": 12,\n \"source\": 1,\n \"type\": 0,\n \"name\": \"nif\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": null\n },\n {\n \"id\": 15,\n \"source\": 2,\n \"type\": 5,\n \"name\": \"Data\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": null\n },\n {\n \"id\": 16,\n \"source\": 1,\n \"type\": 14,\n \"name\": \"url\",\n \"defaultValue\": null,\n \"isRequired\": false,\n \"options\": [\n \"Website\",\n \"Linkedin\",\n \"Twitter\",\n \"Facebook\",\n \"Instagram\"\n ]\n }\n]"}],"_postman_id":"fada61bb-44ec-4008-8c61-b83f21b47a7c"},{"name":"Add CRM Contact","id":"fcdfa7b6-1e43-4ced-a8d8-18bca5f175a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"João Ratinho\",\r\n \"userId\": 6,\r\n \"isPrivate\" : true,\r\n \"contactFields\": [{\r\n \"id\": 0,\r\n \"formFieldID\": 3,\r\n \"value\": \"351210000000\",\r\n \"label\": \"work\"\r\n },{\r\n \"id\": 0,\r\n \"formFieldID\": 3,\r\n \"value\": \"351910000000\",\r\n \"label\": \"personal\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/addcontact","description":"

Permite adicionar um contacto, utilizando no body uma estrutura JSON como em baixo.

\n

Nessa estrutura, teremos que ter em conta os tipos dos campos como descrito em \"Get ContactForm Fields\".

\n

Assim, passamos a explicar os atributos mais importantes da estrutura exemplo:

\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
AtributoDescrição
userIdO ID do utilizador do sistema a quem vai ser atribuído o contacto.
ou Null caso não se queira atrubuír a um utilizador.
isPrivateSe true o contacto apenas será visto no sistema pelo utilizador a que foi atribuído através do userId
contactFields [ ]
Array de objetos Form Field
contactFields[ ].idDeve ser 0 quando adiciona um contacto. ( neste caso será sempre 0)
Ou o id do Form Field quando faz update (no end point seguinte)
contactFields[ ].formFieldIDRepresenta o tipo de campo tal como na tabela apresentada em \"Get Contact Form Fields\"
\n

Como Resposta obtemos um id, inteiro, que representa o Id do contacto criado.

\n

NOTA: OS NÚMEROS DE TELEFONE E DE TELEMÓVEL DEVEM SER ENVIADOS COM O COUNTRY CODE E SEM 00 NEM SINAL +.

\n","urlObject":{"path":["contact","addcontact"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"b85847e4-b841-4e51-8239-063f7987c7da","name":"Response 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"Fonseca\",\r\n \"userId\": 6,\r\n \"isPrivate\" : true,\r\n \"contactFields\": [{\r\n \"id\": \"0\",\r\n \"formFieldID\": 3,\r\n \"value\": \"123456789\",\r\n \"label\": \"work\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/addcontact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Fri, 10 Mar 2023 14:45:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"8017"}],"_postman_id":"fcdfa7b6-1e43-4ced-a8d8-18bca5f175a6"},{"name":"Update CRM Contact","id":"bd23c77f-1eb5-4b11-99d5-e2a1bed1898b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 8014,\r\n \"name\": \"João Ratão\",\r\n \"userId\": 6,\r\n \"isPrivate\" : true,\r\n \"contactFields\": [{\r\n \"id\": 48999,\r\n \"formFieldID\": 3,\r\n \"value\": \"batatas\",\r\n \"label\": \"work\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/updatecontact","description":"

Permite fazer Update de um contacto.

\n

A estrutura do contacto deve ser enviada no body e será atualizado o contacto que tiver o respetivo id.

\n

Como resultado, devolve um objeto JSON que corresponde ao contacto alterado.

\n","urlObject":{"path":["contact","updatecontact"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"e667f09d-9586-4a71-9660-9cb2677a8529","name":"Response 200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 8014,\r\n \"name\": \"João Ratão\",\r\n \"userId\": 6,\r\n \"isPrivate\" : true,\r\n \"contactFields\": [{\r\n \"id\": 48999,\r\n \"formFieldID\": 3,\r\n \"value\": \"batatas\",\r\n \"label\": \"work\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/updatecontact"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Fri, 10 Mar 2023 14:40:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 8014,\n \"name\": \"João Ratão\",\n \"avatar\": null,\n \"userID\": 6,\n \"isPrivate\": false,\n \"companyName\": null,\n \"companyID\": 0,\n \"callID\": 0,\n \"companyFields\": null,\n \"contactFields\": [\n {\n \"id\": 48999,\n \"formFieldID\": 3,\n \"value\": \"batatas\",\n \"label\": \"work\"\n }\n ]\n}"}],"_postman_id":"bd23c77f-1eb5-4b11-99d5-e2a1bed1898b"}],"id":"9834d45a-519d-46bb-a374-079093a3b16a","description":"
    \n
  • Contactos
    • \n
\n","_postman_id":"9834d45a-519d-46bb-a374-079093a3b16a"},{"name":"Companies","item":[{"name":"Get Company by ID","id":"0cdf1092-1f54-455a-a19e-0ca5a159d424","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ApiBase}}/contact/getcompanybyid?id={{companyId}}","description":"

Obtem os dados de uma empresa fornecendo como parâmetro o seu Id.

\n

Como resultado, devolve uma estrutura JSON como a seguinte:

\n
{\n    \"id\": 952,\n    \"name\": \"Coimbra's Company Ltd.\",\n    \"avatar\": null,\n    \"fields\": [\n        {\n            \"id\": 145,\n            \"formFieldID\": 11,\n            \"value\": \"351239xxxxxx\",\n            \"label\": \"other\"\n        },\n        {\n            \"id\": 162,\n            \"formFieldID\": 12,\n            \"value\": \"5xxxxxxxx\",\n            \"label\": null\n        }\n    ]\n}\n\n
\n","urlObject":{"path":["contact","getcompanybyid"],"host":["{{ApiBase}}"],"query":[{"key":"id","value":"{{companyId}}"}],"variable":[]}},"response":[{"id":"d160c5f9-a24d-42ce-a7b8-0f63f9bf2015","name":"Resposta 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{ApiBase}}/contact/getcompanybyid?id={{companyId}}","host":["{{ApiBase}}"],"path":["contact","getcompanybyid"],"query":[{"key":"id","value":"{{companyId}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Tue, 14 Mar 2023 18:15:14 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 952,\n \"name\": \"Coimbra's Company Ltd.\",\n \"avatar\": null,\n \"fields\": [\n {\n \"id\": 145,\n \"formFieldID\": 11,\n \"value\": \"351239\",\n \"label\": \"other\"\n },\n {\n \"id\": 162,\n \"formFieldID\": 12,\n \"value\": \"5xxxxxxxx\",\n \"label\": null\n }\n ]\n}"}],"_postman_id":"0cdf1092-1f54-455a-a19e-0ca5a159d424"},{"name":"Get All Companies","id":"aa93c886-99da-419a-aeaf-e54a84d5a84f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ApiBase}}/contact/getallcompanies","description":"

Obtem a lista de todas as empresas existentes no sistema.

\n

Necessita apenas da Autorização por Bearer Token.

\n

Como resposta obtem um array JSON com a s empresas existentes:

\n
[\n    {\n        \"id\": 952,\n        \"name\": \"Coimbra's Company Ltd.\",\n        \"avatar\": null,\n        \"fields\": {\n            \"phone\": \"351239\",\n            \"nif\": \"5xxxxxxxx\"\n        }\n    },\n    {\n        \"id\": 957,\n        \"name\": \"Empresa Teste\",\n        \"avatar\": null,\n        \"fields\": {\n            \"phone\": \"3512\",\n            \"nif\": \"5XXXXXXXX\",\n            \"url\": \"https://www.mydomain.tld\"\n        }\n    },\n    {\n        \"id\": 975,\n        \"name\": \"My Test Company Ltd.\",\n        \"avatar\": null,\n        \"fields\": {\n            \"phone\": \"Coimbra\",\n            \"nif\": \"5xxxxxxxx\"\n        }\n    }\n]\n\n
\n","urlObject":{"path":["contact","getallcompanies"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"d4b51e8d-b55d-4a8d-8228-1a34bddaff47","name":"Resposta 200","originalRequest":{"method":"GET","header":[],"url":"{{ApiBase}}/contact/getallcompanies"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Tue, 14 Mar 2023 18:13:28 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 952,\n \"name\": \"Coimbra's Company Ltd.\",\n \"avatar\": null,\n \"fields\": {\n \"phone\": \"351239\",\n \"nif\": \"5xxxxxxxx\"\n }\n },\n {\n \"id\": 957,\n \"name\": \"Empresa Teste\",\n \"avatar\": null,\n \"fields\": {\n \"phone\": \"3512\",\n \"nif\": \"5XXXXXXXX\",\n \"url\": \"https://www.mydomain.tld\"\n }\n },\n {\n \"id\": 975,\n \"name\": \"My Test Company Ltd.\",\n \"avatar\": null,\n \"fields\": {\n \"phone\": \"Coimbra\",\n \"nif\": \"5xxxxxxxx\"\n }\n }\n]"}],"_postman_id":"aa93c886-99da-419a-aeaf-e54a84d5a84f"},{"name":"Add Company","id":"b5b0765f-ed38-482a-82fc-49888a0b3509","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My Test Company Ltd.\",\r\n \"fields\": [{\r\n \"id\": 0,\r\n \"formFieldID\": 0,\r\n \"value\": \"Coimbra\",\r\n \"label\": \"Cidade\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/addcompany","urlObject":{"path":["contact","addcompany"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"9b6e6885-ce02-4cd2-8c94-32f671048d7a","name":"Resposta 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"My Test Company Ltd.\",\r\n \"fields\": [{\r\n \"id\": 0,\r\n \"formFieldID\": 0,\r\n \"value\": \"Coimbra\",\r\n \"label\": \"Cidade\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/addcompany"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Tue, 14 Mar 2023 17:24:35 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b5b0765f-ed38-482a-82fc-49888a0b3509"},{"name":"Update Company","id":"21d18f8b-99f7-47b1-b2ea-d717a3142a65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 952,\r\n \"name\": \"Coimbra's Company\",\r\n \"fields\": [{\r\n \"id\": 145,\r\n \"formFieldID\": 0,\r\n \"value\": \"Cidade\",\r\n \"label\": \"Coimbra\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/updatecompany","urlObject":{"path":["contact","updatecompany"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"3035cf9d-d3b8-4164-a46a-45d079d4f0af","name":"Resposta 200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 952,\r\n \"name\": \"Coimbra's Company Ltd.\",\r\n \"fields\": [{\r\n \"id\": 145,\r\n \"formFieldID\": 0,\r\n \"value\": \"Cidade\",\r\n \"label\": \"Coimbra\"\r\n }]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/contact/updatecompany"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Tue, 14 Mar 2023 17:42:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 952,\n \"name\": \"Coimbra's Company Ltd.\",\n \"avatar\": null,\n \"fields\": [\n {\n \"id\": 145,\n \"formFieldID\": 11,\n \"value\": \"Cidade\",\n \"label\": \"Coimbra\"\n }\n ]\n}"}],"_postman_id":"21d18f8b-99f7-47b1-b2ea-d717a3142a65"}],"id":"4f65a92f-559c-4a2f-8e57-be9719c6b299","description":"
    \n
  • Empresas
    • \n
\n","_postman_id":"4f65a92f-559c-4a2f-8e57-be9719c6b299"}],"id":"699b50d9-8b3a-4964-8ac8-f1acc7d352a5","description":"
    \n
  • Gestão de Contactos
    • \n
\n","_postman_id":"699b50d9-8b3a-4964-8ac8-f1acc7d352a5"},{"name":"Calls","item":[{"name":"Calls Download Audio","id":"460d074f-d2cf-4312-9123-48fc2586944d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ApiBase}}Call/AudioDownload?session={{session}}","description":"

Permite fazer download do ficheiro de audio associado a uma chamada, identificada por \"session\"

\n

( a disponibilizar brevemente )

\n","urlObject":{"path":["AudioDownload"],"host":["{{ApiBase}}Call"],"query":[{"key":"session","value":"{{session}}"}],"variable":[]}},"response":[],"_postman_id":"460d074f-d2cf-4312-9123-48fc2586944d"},{"name":"Queue Calls","id":"58dc33a8-1e6a-48a0-8b33-d710761ca342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{ApiBase}}/queue/getqueuecalls?day=2025-01-15&queue=400","description":"

Permite obter as chamadas de uma fila específica realizadas num dia específico.

\n","urlObject":{"path":["queue","getqueuecalls"],"host":["{{ApiBase}}"],"query":[{"key":"day","value":"2025-01-15"},{"key":"queue","value":"400"}],"variable":[]}},"response":[],"_postman_id":"58dc33a8-1e6a-48a0-8b33-d710761ca342"}],"id":"f96f2641-4395-4c92-9800-748626169eeb","_postman_id":"f96f2641-4395-4c92-9800-748626169eeb","description":""},{"name":"Webphone Integration","item":[{"name":"Embed webphone by GET ou Iframe","id":"d5f3ba3e-093f-4855-a57b-6129bfe11c63","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{iFrameBase}}/?iframe=default&apiKey={{apiKey}}&number={{number }}&layout={{layout}}&autocall={{autocall}}","description":"

Para utilizar a integração do webphone, deve pedir à Let's Call uma Api Key e o URL ue lhe permitirá usar a funcionalidade.

\n

Uma vez na posse da KEY e da URL, pode usar o comando get com os seguintes parametros:

\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\n\n
ParametroTipoDescrição
iframeconstante = defaultDeve ser usada a constante \"default\", não tem outra função
apiKeystringA Key fornecida pela Let's Call
numberstringO numero de telefone para onde fazer a ligação
layoutbooleanComo mostra os controles da chamada:
true - Conjunto de controles básicos
false - Conjunto de controles completo
autocallbooleanInicia automaticamente a chamada:
true - inicia a chamada imediatamente.
false - espera que seja premido o botão de inicio de chamada.
\n

O código HTML seguinte pode ser usado como teste para verificar os parâmetros explicados, ou como base para embeber como iframe na aplicação a customizar.

\n
<html>\n<head>\n    <style>\n        body {\n            background-color: #252423;\n            color: var(--whiteColor);\n            margin: 0 auto;\n            color: white;\n        }\n​\n        .container {\n            margin: 0 auto;\n            width: 300px;\n        }\n​\n        .container>div {\n            margin-top: 10px;\n            margin-bottom: 10px;\n        }\n​\n        #webphone {\n            width: 330px;\n            height: 500px;\n            border: none;\n            box-shadow: 0px 0px 1px 1px var(--blackColor);\n        }\n​\n        #keypad {\n            display: none;\n            margin-top: 5px;\n        }\n​\n        #keypad.active {\n            display: block;\n        }\n​\n        #keypad button {\n            margin: 3px;\n        }\n    </style>\n</head>\n​\n<body>\n    <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class=\"container\">\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <textarea style=\"width: 300px; height:75px;\" type=\"text\" id=\"urlOutput\"></textarea>\n        </div>\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <label>Url</label>\n            <input type=\"text\" id=\"url\" value=\"\" />\n        </div>\n​\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <label>Key (Optional)</label>\n                            value=\"\" />\n        </div>\n​\n\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <label>Number</label>\n            <input type=\"text\" id=\"number\" value=\"\" />\n​\n            <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n                <label>CLI (Optional)</label>\n                <input type=\"text\" id=\"cli\" value=\"\" />\n            </div>\n        </div>\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <label>Layout</label>\n            <input type=\"radio\" name=\"layout\" value=\"false\" checked>\n            <label>Default</label>\n            <input type=\"radio\" name=\"layout\" value=\"true\">\n            <label>Basic</label>\n        </div>\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <label>Auto Call</label>\n            <input type=\"radio\" name=\"autoCall\" value=\"true\">\n            <label>Yes</label>\n            <input type=\"radio\" name=\"autoCall\" value=\"false\" checked>\n            <label>No</label>\n        </div>\n​\n\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <button id=\"clickToCall\">Click to call</button>\n            <button id=\"getToCall\">Get to call</button>\n        </div>\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <button id=\"hangup\">Hangup</button>\n            <button id=\"mute_unmute\">Mute/Unmute</button>\n            <button id=\"hold_unhold\">Hold/Unhold</button>\n        </div>\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' class='preserveHtml'>\n            <button id=\"toggleKeypad\">keypad</button>\n            <div class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"keypad\">\n                <button onclick=\"pad('1')\">1</button>\n                <button onclick=\"pad('2')\">2</button>\n                <button onclick=\"pad('3')\">3</button>\n                <button onclick=\"pad('4')\">4</button>\n                <button onclick=\"pad('5')\">5</button>\n                <button onclick=\"pad('6')\">6</button>\n                <button onclick=\"pad('7')\">7</button>\n                <button onclick=\"pad('8')\">8</button>\n                <button onclick=\"pad('9')\">9</button>\n                <button onclick=\"pad('*')\">*</button>\n                <button onclick=\"pad('0')\">0</button>\n                <button onclick=\"pad('#')\">#</button>\n            </div>\n        </div>\n​\n        <div class='preserveHtml' class='preserveHtml' class='preserveHtml' id=\"callEvent\">...</div>\n​\n        <iframe id=\"webphone\" allow=\"microphone *\"></iframe>\n    </div>\n    <script>\n        const regex = new RegExp('^[0-9*]+$');\n        //Talvez quando fizerem o login no vosso lado, registem as credenciais na localstorage do browser algo do gênero\n        const apiKey = \"\";\n​\n        window.onload = function () {\n            const _urlOutput = document.getElementById(\"urlOutput\");\n            const _url = document.getElementById(\"url\");\n            const _key = document.getElementById(\"key\");\n            const _number = document.getElementById(\"number\");\n            const _cli = document.getElementById(\"cli\");\n            const _iframe = document.getElementById(\"webphone\");\n            const _callEvent = document.getElementById(\"callEvent\");\n            const _layouts = document.getElementsByName(\"layout\");\n            const _autoCall = document.getElementsByName(\"autoCall\");\n            const _keypad = document.getElementById(\"keypad\");\n​\n            //ADICIONA EVENTOS DA IFRAME PARA O PAI\n            //É POSSIVEL MELHORAR OS EVENTOS DEPOIS\n            window.addEventListener('message', function (e) {\n                //EVENTOS VEM AQUI, DE CHAMADA DE ENTRADA\n                console.error(e.data);\n                //VERIFICAR ORIGIN = e.origion != \"xpto\" return;\n                _callEvent.innerHTML = JSON.stringify(e.data);\n            }, false);\n​\n            document.getElementById(\"clickToCall\").addEventListener(\"click\", function () {\n                _callEvent.innerHTML = \"...\";\n                let number = getNumber();\n                if (number == null) {\n                    return;\n                }\n​\n                if (_iframe.getAttribute(\"src\") == null) {\n                    _iframe.setAttribute(\"src\", _url.value + \"?iframe=default\");\n                    _iframe.onload = function () {\n                        send(number);\n                        return;\n                    }\n                }\n                send(number);\n            });\n​\n            document.getElementById(\"getToCall\").addEventListener(\"click\", function () {\n                _callEvent.innerHTML = \"...\";\n                if (getNumber() == null) {\n                    return;\n                }\n​\n                _iframe.setAttribute(\"src\", _urlOutput.value);\n            });\n​\n            document.getElementById(\"hangup\").addEventListener(\"click\", function () {\n                let data = {\n                    action: 0\n                };\n​\n                _iframe.contentWindow.postMessage(data, _urlOutput.value);\n            });\n​\n            document.getElementById(\"mute_unmute\").addEventListener(\"click\", function () {\n                let data = {\n                    action: 1\n                };\n​\n                _iframe.contentWindow.postMessage(data, _urlOutput.value);\n            });\n​\n            document.getElementById(\"hold_unhold\").addEventListener(\"click\", function () {\n                let data = {\n                    action: 2\n                };\n​\n                _iframe.contentWindow.postMessage(data, _urlOutput.value);\n            });\n​\n            document.getElementById(\"toggleKeypad\").addEventListener(\"click\", function () {\n                if (_keypad.classList.contains(\"active\")) {\n                    _keypad.classList.remove(\"active\");\n                    return;\n                }\n​\n                _keypad.classList.add(\"active\");\n            });\n​\n            function send(number) {\n                let data = {\n                    number: number,\n                    layout: getLayout(),\n                    autoCall: getAutoCall(),\n                    cli: getCLI()\n                };\n​\n                _iframe.contentWindow.postMessage(data, _url.value + \"?iframe=default\");\n            }\n​\n            function getNumber() {\n                let number = _number.value.trim();\n                if (number.length == 0 || !regex.test(number)) {\n                    return null;\n                }\n​\n                return number;\n            }\n​\n            function getCLI() {\n                let cli = _cli.value.trim();\n                if (cli.length == 0 || !regex.test(cli)) {\n                    return null;\n                }\n​\n                return cli;\n            }\n​\n            function getLayout() {\n                for (i = 0; i < _layouts.length; i++) {\n                    if (_layouts[i].checked) {\n                        return _layouts[i].value;\n                    }\n                }\n​\n                return _layouts[0].value;\n            }\n​\n            function getAutoCall() {\n                for (i = 0; i < _autoCall.length; i++) {\n                    if (_autoCall[i].checked) {\n                        return _autoCall[i].value;\n                    }\n                }\n​\n                return _autoCall[0].value;\n            }\n​\n            _url.addEventListener(\"input\", function () {\n                buildURL();\n            });\n​\n            _key.addEventListener(\"input\", function () {\n                buildURL();\n            });\n​\n            _number.addEventListener(\"input\", function () {\n                buildURL();\n            });\n​\n            _cli.addEventListener(\"input\", function () {\n                buildURL();\n            });\n​\n            _layouts.forEach((x) => {\n                x.addEventListener(\"change\", function () {\n                    buildURL();\n                });\n            });\n​\n            _autoCall.forEach((x) => {\n                x.addEventListener(\"change\", function () {\n                    buildURL();\n                });\n            });\n​\n            buildURL();\n​\n            function buildURL() {\n                if (_url.value.length > 0) {\n                    _urlOutput.value = _url.value + \"?iframe=default\";\n                }\n​\n                if (key.value.length > 0) {\n                    _urlOutput.value += \"&apiKey=\" + key.value;\n                }\n​\n                let number = getNumber();\n                if (number != null && number.length > 0) {\n                    _urlOutput.value += \"&number=\" + number;\n                }\n​\n                let cli = getCLI();\n                if (cli != null && cli.length > 0) {\n                    _urlOutput.value += \"&cli=\" + cli;\n                }\n​\n                _urlOutput.value += \"&layout=\" + getLayout();\n                _urlOutput.value += \"&autocall=\" + getAutoCall();\n            }\n        }\n​\n        function pad(key) {\n            const iframe = document.getElementById(\"webphone\");\n            const url = document.getElementById(\"url\");\n            if (iframe == null || url == null) {\n                return;\n            }\n​\n            let data = {\n                action: 3,\n                key: key\n            };\n​\n            iframe.contentWindow.postMessage(data, url.value);\n        }\n    </script>\n</body>\n​\n</html>\n\n
\n","urlObject":{"path":[""],"host":["{{iFrameBase}}"],"query":[{"key":"iframe","value":"default"},{"key":"apiKey","value":"{{apiKey}}"},{"key":"number","value":"{{number }}"},{"key":"layout","value":"{{layout}}"},{"key":"autocall","value":"{{autocall}}"}],"variable":[]}},"response":[],"_postman_id":"d5f3ba3e-093f-4855-a57b-6129bfe11c63"}],"id":"7ad74a59-c875-46df-b33e-72445717da6e","description":"

Pode integrar-se a funcionalidae de emitir chamadas a pedido ou em iframe.

\n","_postman_id":"7ad74a59-c875-46df-b33e-72445717da6e"},{"name":"Web Hooks","item":[{"name":"Web Hook","id":"881139e9-ebc4-4217-8b0e-d91f82e14e07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{userURL}","description":"

O Contact Center Let's Call tem a possibilidade de enviar pedidos POST para um URL fornecido, (Web Hook).

\n

O pedido envia três tipos de estruturas JSON, conforme a informação disponível. As estruturas são identificadas pelo campo Type e podem ser do tipo:

\n

Call ( Type = 0 )

\n
{\n  \"type\": 0,\n  \"callID\": \"02164EF91C81400001E56282@TB007612_VOIPB.MG02_pbx-1\",\n  \"direction\": 0,\n  \"duration\": 11,\n  \"state\": 1,\n  \"caller\": \"35193000000\",\n  \"callee\": \"35121000000\",\n  \"cause\": \"Rejeitado\",\n  \"operatorName\": \"user 1\",\n  \"operatorEmail\": \"user1@domain.tld\"\n}\n\n

Relativo à estrutra Call, defenimos os seguintes enums:

\n
\n

public enum Direction
{
Incoming = 0,
Outgoing = 1
}

\n
\n
\n

public enum State
{
Answered = 1,
AnsweredElseWhere = 4,
NotAnswered = 5,
}

\n
\n

Form ( Type = 1 )

\n
 {\n \"type\": 1,\n  \"callID\": \"02164EF91C81400001E56282@TB007612_VOIPB.MG02_pbx-1\",\n  \"name\": \"Campanha\",\n  \"fields\": {\n    \"Tipo Text\": \"Outro form aleatorio\",\n    \"TAG BOX\": \"ok,sim\",\n    \"Date\": \"2023-04-14\",\n    \"DateTime\": \"2023-04-14 13:40:00\"\n  }\n}\n\n

Typification ( Type = 2 )

\n
{\n  \"type\": 2,\n  \"callID\": \"02164EF91C81400001E56282@TB007612_VOIPB.MG02_pbx-1\",\n  \"typification\": \"Tipificaçao geral\"\n}\n\n
","urlObject":{"host":["{userURL}"],"query":[],"variable":[]}},"response":[],"_postman_id":"881139e9-ebc4-4217-8b0e-d91f82e14e07"}],"id":"822d4435-e022-445e-b7a0-406c80fb414e","description":"

O utilizador pode defenir ,no portal de administração, um URL que permitirá que o Contact Center envie dados parauma aplicação personalizada pelo cliente.

\n","_postman_id":"822d4435-e022-445e-b7a0-406c80fb414e"},{"name":"Campaigns","item":[{"name":"Get All Campaigns","id":"ae74d64e-e0e4-4896-b3ad-1ee92e2ffb65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ApiBase}}/campaign","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b189b132-fa3d-418d-b677-a21044ad8681","id":"b189b132-fa3d-418d-b677-a21044ad8681","name":"Campaigns","type":"folder"}},"urlObject":{"path":["campaign"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ae74d64e-e0e4-4896-b3ad-1ee92e2ffb65"},{"name":"Get All Contact and Calls","id":"b038c8e6-bc04-4019-93b9-e2795c4f18ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ApiBase}}/campaign/{{CampaignId}}/contacts","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"b189b132-fa3d-418d-b677-a21044ad8681","id":"b189b132-fa3d-418d-b677-a21044ad8681","name":"Campaigns","type":"folder"}},"urlObject":{"path":["campaign","{{CampaignId}}","contacts"],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b038c8e6-bc04-4019-93b9-e2795c4f18ce"},{"name":"Add Campaign Contact","id":"22bdec6c-a53a-45bb-80b6-f62824516d61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Number\": \"911111111\",\r\n \"Name\" : \" Contacto Teste\", \r\n \"Fields\" : [{\"Key\":\"E-mail\",\"Value\":\"user@domain.tld\"} , {\"Key\":\"Cód. Postal\",\"Value\":\"3000-000\"}, {\"key\":\"key1\", \"Value\":\"Value1\"}]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/campaign/{{CampaignId}}/contact/","description":"

Adiciona um contacto à lista de contactos de uma campanha.

\n

No body do pedido deve enviar-se uma estrutura JSON como em baixo, com os seguintes atributos:

\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
AtributoTipoDescrição
NumberStringNúmero de telefone/telemóvel do contacto
NameStringNome do Contacto.
FieldsJSON Array de Objetos Key/ValueCada par Key/Value representa um campo e respetivo valor que caracteriza o contacto. Se o campo não existir para os outros contactos, da lista,, sera adicionado para todos, embora, claro, com valor vazio.
\n

Como resultado, devolve apenas o código de erro, 200 OK, se correu bem, ou outro, no caso de não ter executado corretamente.

\n

NOTA: O CAMPO NUMBER DEVE SER ENVIADO COM O COUNTRY CODE E SEM 00 NEM SINAL +.

\n","urlObject":{"path":["campaign","{{CampaignId}}","contact",""],"host":["{{ApiBase}}"],"query":[],"variable":[]}},"response":[{"id":"f44fd2d7-d69f-4d5e-90ec-d2d0fc6b3d85","name":"Resposta 200","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Number\": \"911111111\",\r\n \"Name\" : \"Teste API3\", \r\n \"Fields\" : [{\"Key\":\"E-mail\",\"Value\":\"user@domain.tld\"} , {\"Key\":\"Cód. Postal\",\"Value\":\"3000-000\"}, {\"key\":\"key1\", \"Value\":\"Value1\"}]\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{ApiBase}}/campaign/{{CampaignId}}/contact/"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.20.1"},{"key":"Date","value":"Mon, 13 Mar 2023 19:53:03 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"22bdec6c-a53a-45bb-80b6-f62824516d61"}],"id":"b189b132-fa3d-418d-b677-a21044ad8681","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1d0dc6ce-60c6-44b7-9f21-b7203989aca2","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"fda72a98-deeb-4275-9928-0f8415b2df98","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"b189b132-fa3d-418d-b677-a21044ad8681","description":""}]}