API de conexão para facilitar a comunicação entre o Confrapag Desk e nossos fornecedores.
\nna duvida entrar em contato com ti@confrapag.com.br
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33022621","collectionId":"9a550a0e-fdb4-4022-86c9-0280f11ea33d","publishedId":"2sA35G2M8w","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-12-19T11:53:54.000Z"},"item":[{"name":"Sessão","item":[{"name":"Criar sessão","event":[{"listen":"test","script":{"id":"4270108a-2dae-42d1-b6a2-5f672e4ad988","exec":["if(responseCode.code >=200 && responseCode.code <=299){"," var jsonData = JSON.parse(responseBody);",""," postman.setEnvironmentVariable('SessionID', jsonData.SessionID);","}"],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"6860d48a-4620-4370-b9f6-40721564f407","exec":[""],"type":"text/javascript"}}],"id":"dd9bb0eb-7596-42e3-b990-d045f6811a39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UserLogin\":\"{{UserLogin}}\",\n \"Password\":\"{{Password}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/session/create","description":"Endpoint de autenticação para geração do \"SessionID\".
\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"UserID\": 1,\n \"SessionID\": \"a0uShqmDGXkiSyPRjmFnPH2vRH4yPc8J\"\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"SessionCreate.AuthFail\",\n \"ErrorMessage\": \"SessionCreate: Authorization failing!\"\n }\n}\n\nObtenha informações da sessão online.
\nExemplo de uso:
\n{\n \"SessionID\": \"a0uShqmDGXkiSyPRjmFnPH2vRH4yPc8J\"\n}\n\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"SessionData\": [\n {\n \"Key\": \"AdminCommunicationLogPageShown\",\n \"Value\": \"25\"\n },\n {\n \"Value\": \"2000\",\n \"Key\": \"AdminDynamicFieldsOverviewPageShown\"\n },\n {\n \"Value\": \"2021-05-26 14:48:07\",\n \"Key\": \"ChangeTime\"\n },\n {\n \"Key\": \"CreateTime\",\n \"Value\": \"2021-05-26 14:48:07\"\n },\n {\n \"Value\": \"GenericInterface\",\n \"Key\": \"SessionSource\"\n },\n {\n \"Key\": \"UserAuthBackend\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"UserChangeOverviewSmallPageShown\",\n \"Value\": \"25\"\n },\n {\n \"Value\": \"25\",\n \"Key\": \"UserConfigItemOverviewSmallPageShown\"\n },\n {\n \"Key\": \"UserCreateNextMask\",\n \"Value\": \"\"\n },\n {\n \"Key\": \"UserCreateWorkOrderNextMask\",\n \"Value\": \"AgentITSMWorkOrderZoom\"\n },\n {\n \"Key\": \"UserEmail\",\n \"Value\": \"confrapag@confrapag\"\n },\n {\n \"Value\": \"25\",\n \"Key\": \"UserFAQJournalOverviewSmallPageShown\"\n },\n {\n \"Value\": \"25\",\n \"Key\": \"UserFAQOverviewSmallPageShown\"\n },\n {\n \"Value\": \"Admin\",\n \"Key\": \"UserFirstname\"\n },\n {\n \"Key\": \"UserFullname\",\n \"Value\": \"Admin Confrapagdesk\"\n },\n {\n \"Value\": \"1\",\n \"Key\": \"UserID\"\n },\n {\n \"Value\": \"Yes\",\n \"Key\": \"UserIsGroupRo[admin]\"\n },\n {\n \"Key\": \"UserIsGroupRo[itsm-change-builder]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroupRo[itsm-change-manager]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroupRo[itsm-change]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroupRo[itsm-configitem]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroupRo[itsm-service]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroupRo[stats]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroupRo[users]\",\n \"Value\": \"Yes\"\n },\n {\n \"Value\": \"Yes\",\n \"Key\": \"UserIsGroup[admin]\"\n },\n {\n \"Value\": \"Yes\",\n \"Key\": \"UserIsGroup[itsm-change-builder]\"\n },\n {\n \"Key\": \"UserIsGroup[itsm-change-manager]\",\n \"Value\": \"Yes\"\n },\n {\n \"Key\": \"UserIsGroup[itsm-change]\",\n \"Value\": \"Yes\"\n },\n {\n \"Value\": \"Yes\",\n \"Key\": \"UserIsGroup[itsm-configitem]\"\n },\n {\n \"Value\": \"Yes\",\n \"Key\": \"UserIsGroup[itsm-service]\"\n },\n {\n \"Value\": \"Yes\",\n \"Key\": \"UserIsGroup[stats]\"\n },\n {\n \"Key\": \"UserIsGroup[users]\",\n \"Value\": \"Yes\"\n },\n {\n \"Value\": \"1622315527\",\n \"Key\": \"UserLastLogin\"\n },\n {\n \"Key\": \"UserLastLoginTimestamp\",\n \"Value\": \"2021-05-29 19:12:07\"\n },\n {\n \"Value\": \"1622315528\",\n \"Key\": \"UserLastRequest\"\n },\n {\n \"Value\": \"ConfrapagDesk\",\n \"Key\": \"UserLastname\"\n },\n {\n \"Key\": \"UserLogin\",\n \"Value\": \"confrapag@confrapag\"\n },\n {\n \"Key\": \"UserLoginFailed\",\n \"Value\": \"0\"\n },\n {\n \"Key\": \"UserRefreshTime\",\n \"Value\": \"0\"\n },\n {\n \"Value\": \"127.0.0.1\",\n \"Key\": \"UserRemoteAddr\"\n },\n {\n \"Value\": \"insomnia/2021.3.0\",\n \"Key\": \"UserRemoteUserAgent\"\n },\n {\n \"Value\": \"1622315528\",\n \"Key\": \"UserSessionStart\"\n },\n {\n \"Key\": \"UserStoredFilterColumns-AgentTicketQueue\",\n \"Value\": \"{}\"\n },\n {\n \"Value\": \"25\",\n \"Key\": \"UserSurveyOverviewSmallPageShown\"\n },\n {\n \"Key\": \"UserTicketOverviewAgentTicketQueue\",\n \"Value\": \"Preview\"\n },\n {\n \"Key\": \"UserTicketOverviewMediumPageShown\",\n \"Value\": \"20\"\n },\n {\n \"Value\": \"15\",\n \"Key\": \"UserTicketOverviewPreviewPageShown\"\n },\n {\n \"Value\": \"25\",\n \"Key\": \"UserTicketOverviewSmallPageShown\"\n },\n {\n \"Value\": null,\n \"Key\": \"UserTitle\"\n },\n {\n \"Value\": \"User\",\n \"Key\": \"UserType\"\n },\n {\n \"Value\": \"1\",\n \"Key\": \"ValidID\"\n }\n ]\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"SessionGet.AuthFail\",\n \"ErrorMessage\": \"SessionGet: Authorization failing!\"\n }\n}\n\nUse esta pasta para endpoints relacionados à autenticação do usuário no Confradesk.
\n","_postman_id":"ef4ec8ea-9659-43f8-a4f5-8420e1c29952"},{"name":"Estados","item":[{"name":"Obtenha todos os estados disponíveis","id":"446fcc9a-4e73-401e-90ea-ff8f34bea1fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"SessionID\":\"{{SessionID}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/state/search","description":"Obtenha todos os estados disponíveis no confradesk, aqui estão os status que mudam ao longo do atendimento do chamado.
\nExemplo de uso:
\n{\n \"SessionID\": \"vbX9n8cxJSdig0QODzl3Vrl74ip6jNGP\"\n}\n\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"Items\": [\n {\n \"Value\": \"closed successful\",\n \"Key\": \"2\"\n },\n {\n \"Value\": \"removed\",\n \"Key\": \"5\"\n },\n {\n \"Value\": \"new\",\n \"Key\": \"1\"\n },\n {\n \"Key\": \"3\",\n \"Value\": \"closed unsuccessful\"\n },\n {\n \"Value\": \"closed with workaround\",\n \"Key\": \"10\"\n },\n {\n \"Key\": \"9\",\n \"Value\": \"merged\"\n },\n {\n \"Key\": \"8\",\n \"Value\": \"pending auto close-\"\n },\n {\n \"Value\": \"open\",\n \"Key\": \"4\"\n },\n {\n \"Key\": \"7\",\n \"Value\": \"pending auto close+\"\n },\n {\n \"Key\": \"6\",\n \"Value\": \"pending reminder\"\n }\n ]\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"StateSearch.AuthFail\",\n \"ErrorMessage\": \"StateSearch: Authorization failing!\"\n }\n}\n\nExibe os status dos tickets
\n","_postman_id":"db6359df-affe-47da-9bd8-6c33498f718f"},{"name":"Ticket","item":[{"name":"Pesquise o ID de um ticket","id":"3e85aefc-3064-4102-8c14-b4c993a4fb81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"SessionID\":\"{{SessionID}}\",\n \"TicketNumber\":\"2024032810000031\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/ticket/search","description":"Pesquise o ID de um ou mais tickets.
\nLembrando que SessionID é obtido atraves do endpoint criar sessão.
\nExemplo de uso:
\n{\n \"SessionID\": \"a0uShqmDGXkiSyPRjmFnPH2vRH4yPc8J\",\n \"TicketNumber\": [\"2021052910000021\"],\n}\n\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"TicketID\": [\n \"4\"\n ]\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"TicketSearch.AuthFail\",\n \"ErrorMessage\": \"TicketSearch: Authorization failing!\"\n }\n}\n\nExemplo de uso:
\n{\n \"SessionID\": \"a0uShqmDGXkiSyPRjmFnPH2vRH4yPc8J\",\n \"TicketNumber\": [\"2021052910000021\"]\n}\n\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"Length\": 500,\n \"Total\": 1,\n \"Tickets\": [\n {\n \"Created\": \"2021-05-29 19:25:05\",\n \"TypeID\": 1,\n \"Service\": \"teste\",\n \"StateID\": 1,\n \"CustomerUserID\": \"ricardo.silva\",\n \"SLA\": \"teste\",\n \"CreateBy\": 1,\n \"UnlockTimeout\": 1622316305,\n \"State\": \"new\",\n \"Title\": \"Teste Attachment\",\n \"CustomerID\": \"CONFRAPAGDESK\",\n \"TicketNumber\": \"2021052910000021\",\n \"Priority\": \"1 very low\",\n \"FirstResponse\": \"2021-05-29 19:25:05\",\n \"OwnerID\": 1,\n \"LockID\": 1,\n \"Age\": 848212,\n \"Owner\": \"confrapag@confrapag\",\n \"ArchiveFlag\": \"n\",\n \"RealTillTimeNotUsed\": 0,\n \"EscalationUpdateTime\": 0,\n \"EscalationResponseTime\": 0,\n \"ServiceID\": 1,\n \"Type\": \"Unclassified\",\n \"ChangeBy\": 1,\n \"SLAID\": 1,\n \"FirstResponseInMin\": 0,\n \"StateType\": \"new\",\n \"ResponsibleID\": 1,\n \"EscalationSolutionTime\": 0,\n \"Changed\": \"2021-05-29 19:25:06\",\n \"Queue\": \"fornecedor\",\n \"PriorityID\": 1,\n \"GroupID\": 1,\n \"TicketID\": 4,\n \"UntilTime\": 0,\n \"Lock\": \"unlock\",\n \"Article\": [\n {\n \"MessageID\": \"\",\n \"CreateBy\": 1,\n \"From\": \"ricardo.silva@confrapag\",\n \"IncomingTime\": 1622316305,\n \"CreateTime\": \"2021-05-29 19:25:05\",\n \"References\": \"\",\n \"ReplyTo\": \"\",\n \"InReplyTo\": \"\",\n \"ArticleID\": 36,\n \"ContentCharset\": \"utf-8\",\n \"To\": \"raw\",\n \"Charset\": \"utf-8\",\n \"IsVisibleForCustomer\": 1,\n \"Subject\": \"Teste Attachment\",\n \"MimeType\": \"text/plain\",\n \"ChangeTime\": \"2021-05-29 19:25:05\",\n \"Body\": \"Teste Attachment\",\n \"SenderType\": \"agent\",\n \"ChangeBy\": 1,\n \"Cc\": \"\",\n \"Bcc\": \"\",\n \"SenderTypeID\": \"1\",\n \"ArticleNumber\": 1,\n \"ContentType\": \"text/plain; charset=utf-8\",\n \"CommunicationChannelID\": 1,\n \"TicketID\": 4\n }\n ],\n \"Responsible\": \"confrapag@confrapag\",\n \"QueueID\": 1,\n \"EscalationTime\": 0\n }\n ],\n \"Start\": 1\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"TicketSearch.AuthFail\",\n \"ErrorMessage\": \"TicketSearch: Authorization failing!\"\n }\n}\n\nO FileID é determinado pela quantidade de anexos em um Article.
\nSe no Article tiver 4 anexos, a ordem dos ID's será 1, 2, 3 e 4.
\nExemplo de uso:
\n{\n \"SessionID\": \"a0uShqmDGXkiSyPRjmFnPH2vRH4yPc8J\",\n \"TicketNumber\": [\"2021052910000021\"],\n \"OrderBy\": [\"Down\", \"Up\"],\n \"SortBy\": [\"Priority\", \"Age\"]\n}\n\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"Length\": 500,\n \"Total\": 1,\n \"Tickets\": [\n {\n \"Created\": \"2021-05-29 19:25:05\",\n \"TypeID\": 1,\n \"Service\": \"teste\",\n \"StateID\": 1,\n \"CustomerUserID\": \"ricardo.silva\",\n \"SLA\": \"teste\",\n \"CreateBy\": 1,\n \"UnlockTimeout\": 1622316305,\n \"State\": \"new\",\n \"Title\": \"Teste Attachment\",\n \"CustomerID\": \"CONFRAPAGDESK\",\n \"TicketNumber\": \"2021052910000021\",\n \"Priority\": \"1 very low\",\n \"FirstResponse\": \"2021-05-29 19:25:05\",\n \"OwnerID\": 1,\n \"LockID\": 1,\n \"Age\": 848212,\n \"Owner\": \"confrapag@confrapag\",\n \"ArchiveFlag\": \"n\",\n \"RealTillTimeNotUsed\": 0,\n \"EscalationUpdateTime\": 0,\n \"EscalationResponseTime\": 0,\n \"ServiceID\": 1,\n \"Type\": \"Unclassified\",\n \"ChangeBy\": 1,\n \"SLAID\": 1,\n \"FirstResponseInMin\": 0,\n \"StateType\": \"new\",\n \"ResponsibleID\": 1,\n \"EscalationSolutionTime\": 0,\n \"Changed\": \"2021-05-29 19:25:06\",\n \"Queue\": \"fornecedor\",\n \"PriorityID\": 1,\n \"GroupID\": 1,\n \"TicketID\": 4,\n \"UntilTime\": 0,\n \"Lock\": \"unlock\",\n \"Article\": [\n {\n \"MessageID\": \"\",\n \"CreateBy\": 1,\n \"From\": \"ricardo.silva@confrapag\",\n \"IncomingTime\": 1622316305,\n \"CreateTime\": \"2021-05-29 19:25:05\",\n \"References\": \"\",\n \"ReplyTo\": \"\",\n \"InReplyTo\": \"\",\n \"ArticleID\": 36,\n \"ContentCharset\": \"utf-8\",\n \"To\": \"raw\",\n \"Charset\": \"utf-8\",\n \"IsVisibleForCustomer\": 1,\n \"Subject\": \"Teste Attachment\",\n \"MimeType\": \"text/plain\",\n \"ChangeTime\": \"2021-05-29 19:25:05\",\n \"Body\": \"Teste Attachment\",\n \"SenderType\": \"agent\",\n \"ChangeBy\": 1,\n \"Cc\": \"\",\n \"Bcc\": \"\",\n \"SenderTypeID\": \"1\",\n \"ArticleNumber\": 1,\n \"ContentType\": \"text/plain; charset=utf-8\",\n \"CommunicationChannelID\": 1,\n \"TicketID\": 4\n }\n ],\n \"Responsible\": \"confrapag@confrapag\",\n \"QueueID\": 1,\n \"EscalationTime\": 0\n }\n ],\n \"Start\": 1\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"TicketSearch.AuthFail\",\n \"ErrorMessage\": \"TicketSearch: Authorization failing!\"\n }\n}\n\nExemplo de uso:
\n{\n \"SessionID\": \"a0uShqmDGXkiSyPRjmFnPH2vRH4yPc8J\",\n \"TicketNumber\": [\"2021052910000021\"]\n}\n\nExemplo de sucesso:
\nHTTP/1.1 200 Success\n{\n \"Length\": 500,\n \"Total\": 1,\n \"Tickets\": [\n {\n \"Created\": \"2021-05-29 19:25:05\",\n \"TypeID\": 1,\n \"Service\": \"teste\",\n \"StateID\": 1,\n \"CustomerUserID\": \"ricardo.silva\",\n \"SLA\": \"teste\",\n \"CreateBy\": 1,\n \"UnlockTimeout\": 1622316305,\n \"State\": \"new\",\n \"Title\": \"Teste Attachment\",\n \"CustomerID\": \"CONFRAPAGDESK\",\n \"TicketNumber\": \"2021052910000021\",\n \"Priority\": \"1 very low\",\n \"FirstResponse\": \"2021-05-29 19:25:05\",\n \"OwnerID\": 1,\n \"LockID\": 1,\n \"Age\": 848212,\n \"Owner\": \"confrapag@confrapag\",\n \"ArchiveFlag\": \"n\",\n \"RealTillTimeNotUsed\": 0,\n \"EscalationUpdateTime\": 0,\n \"EscalationResponseTime\": 0,\n \"ServiceID\": 1,\n \"Type\": \"Unclassified\",\n \"ChangeBy\": 1,\n \"SLAID\": 1,\n \"FirstResponseInMin\": 0,\n \"StateType\": \"new\",\n \"ResponsibleID\": 1,\n \"EscalationSolutionTime\": 0,\n \"Changed\": \"2021-05-29 19:25:06\",\n \"Queue\": \"fornecedor\",\n \"PriorityID\": 1,\n \"GroupID\": 1,\n \"TicketID\": 4,\n \"UntilTime\": 0,\n \"Lock\": \"unlock\",\n \"Article\": [\n {\n \"MessageID\": \"\",\n \"CreateBy\": 1,\n \"From\": \"ricardo.silva@confrapag\",\n \"IncomingTime\": 1622316305,\n \"CreateTime\": \"2021-05-29 19:25:05\",\n \"References\": \"\",\n \"ReplyTo\": \"\",\n \"InReplyTo\": \"\",\n \"ArticleID\": 36,\n \"ContentCharset\": \"utf-8\",\n \"To\": \"raw\",\n \"Charset\": \"utf-8\",\n \"IsVisibleForCustomer\": 1,\n \"Subject\": \"Teste Attachment\",\n \"MimeType\": \"text/plain\",\n \"ChangeTime\": \"2021-05-29 19:25:05\",\n \"Body\": \"Teste Attachment\",\n \"SenderType\": \"agent\",\n \"ChangeBy\": 1,\n \"Cc\": \"\",\n \"Bcc\": \"\",\n \"SenderTypeID\": \"1\",\n \"ArticleNumber\": 1,\n \"ContentType\": \"text/plain; charset=utf-8\",\n \"CommunicationChannelID\": 1,\n \"TicketID\": 4\n }\n ],\n \"Responsible\": \"confrapag@confrapag\",\n \"QueueID\": 1,\n \"EscalationTime\": 0\n }\n ],\n \"Start\": 1\n}\n\nExemplo de erro:
\nHTTP/1.1 200 Success\n{\n \"Error\": {\n \"ErrorCode\": \"TicketSearch.AuthFail\",\n \"ErrorMessage\": \"TicketSearch: Authorization failing!\"\n }\n}\n\nNa criação dos tickets, poucos campos são obrigatórios, e você pode ser guiado pelos retornos de falha para adicionar os campos caso receba erro na hora de criar um novo chamado.
\nO número do QueueID deve ser obtido no momento da integração.
\nEm CommunicationChannelID é o meio de comunicação da mensagem:
\n1 para E-mail
\n2 para Fone
\n3 para OTRS
\nCaso opte por utilizar o CommunicationChannelID passando o ID 1, vai ser obrigatório passar a propriedade From no Article com um e-mail válido.
\nNo body de exemplo estão comentados todos os campos opcionais.
\nRequer SessionID válido.
\n","urlObject":{"path":["v1.0","ticket","create"],"host":["{{baseUrl}}api"],"query":[],"variable":[]}},"response":[{"id":"46c5da3b-10e1-43e8-9b67-e37f0b960a91","name":"Criar um chamado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SessionID\": \"\",\r\n // \"ControlSearch\": {\r\n // \"States\": [\r\n // \"new\",\r\n // \"open\"\r\n // ]\r\n // },\r\n // \"IgnoreOnUpdate\": [\r\n // \"Ticket::Queue\",\r\n // \"Ticket::State\"\r\n // ],\r\n \"Ticket\": {\r\n \"Title\": \"Criação de novo chamado OTRS\",\r\n \"QueueID\": 147,\r\n // \"LockID\": 1,\r\n // \"SLAID\": 4,\r\n // \"SLA\": \"Inicial\",\r\n // \"ServiceID\": 49,\r\n // \"Service\": \"teste\",\r\n // \"Lock\": \"unlock\",\r\n \"TypeID\": 1,\r\n // \"Type\": \"Incident\",\r\n \"StateID\": 1,\r\n // \"State\": \"new\",\r\n \"PriorityID\": 1,\r\n // \"Priority\": \"1 very low\",\r\n \"CustomerUser\": \"confrapag@confrapag\"\r\n },\r\n \"Article\": {\r\n \"CommunicationChannelID\": 3,\r\n // \"IsVisibleForCustomer\": 1,\r\n // \"SenderTypeID\": 1,\r\n // \"SenderType\": \"agent\",\r\n // \"AutoResponseType\": \"auto reply\",\r\n // \"From\": \"confrapag@confrapag\",\r\n \"ContentType\": \"text/plain; charset=UTF-8\",\r\n \"Subject\": \"Assunto do chamado\",\r\n \"Body\": \"mensagem do chamado\",\r\n // \"MimeType\": \"text/plain\",\r\n // \"Charset\": \"UTF-8\",\r\n // \"HistoryType\": \"NewTicket\",\r\n // \"HistoryComment\": \"Test history\",\r\n \"TimeUnit\": 1\r\n // \"NoAgentNotify\": 1,\r\n // \"ForceNotificationToUserID\": [\r\n // 1\r\n // ],\r\n // \"ExcludeNotificationToUserID\": [\r\n // 1\r\n // ],\r\n // \"ExcludeMuteNotificationToUserID\": [\r\n // 1\r\n // ]\r\n },\r\n \"DynamicField\": [\r\n {\r\n \"Name\": \"acquire\",\r\n \"Value\": \"F5\"\r\n }\r\n // {\r\n // \"Name\": \"nomela\",\r\n // \"Value\": \"la dna\"\r\n // }\r\n ]\r\n // ,\r\n // \"Attachment\": [\r\n // {\r\n // \"Content\": \"codigo em base64\",\r\n // \"ContentType\": \"image/png\",\r\n // \"Filename\": \"print.png\"\r\n // }\r\n // ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://desk.confrapag.com.br/api/v1.0/ticket/create"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 18 Dec 2025 18:10:30 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"X-Served-By","value":"desk.confrapag.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"TicketID\": \"40449\",\n \"TicketNumber\": \"2025121810000503\",\n \"ArticleID\": 205970\n}"}],"_postman_id":"2ab70675-fc10-4ea0-a949-3fc0a9baffd6"},{"name":"Atualizar um chamado","id":"b7a36a3b-7ac6-425b-bba3-2f825da937bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"SessionID\": \"{{SessionID}}\",\n// \"ControlSearch\": {\n// \"DynamicField_TicketKey\": {\n// \"Equals\": \"teste\"\n// },\n// \"States\": [\"new\", \"open\"]\n// },\n// \"IgnoreOnUpdate\": [\n// \"Ticket::Queue\",\n// \"Ticket::State\"\n// ],\n// \"TicketID\": \"40449\",\n \"TicketNumber\": \"2025121810000503\",\n \"Ticket\": {\n // \"Title\": \"Testando mensagem de atualização\"\n // \"QueueID\": 8,\n // \"Queue\": \"teste\",\n // \"LockID\": 1,\n // \"Lock\": \"unlock\",\n // \"TypeID\": 2,\n // \"Type\": \"Incident\",\n // //\"ServiceID\": 1,\n // //\"Service\": \"teste\",\n // //\"SLAID\": 1,\n // //\"SLA\": \"teste\",\n \"StateID\": 4\n // \"State\": \"open\",\n // \"PriorityID\": 1,\n // \"Priority\": \"1 very low\",\n // \"OwnerID\": 1,\n // \"Owner\": \"confrapag@confrapag\",\n //\"ResponsibleID\": 1,\n //\"Responsible\": \"confrapag@confrapag\",\n // \"CustomerUser\": \"confrapag@confrapag\",\n // \"Body\": \"Teste via API ok - body\"\n // \"PendingTime\": {\n // \"Year\": 2022,\n // \"Month\": 12,\n // \"Day\": 23,\n // \"Hour\": 23,\n // \"Minute\": 5\n // }\n },\n \"Article\": {\n // \"CommunicationChannel\": \"Email\",\n \"CommunicationChannelID\": 3,\n // \"IsVisibleForCustomer\": 1,\n // \"SenderTypeID\": 3,\n // \"SenderType\": \"customer\",\n // \"AutoResponseType\": \"auto reply\",\n // \"From\": \"confrapag@confrapag\",\n \"ContentType\": \"text/plain; charset=UTF-8\",\n \"Body\": \"Atualização de ticket com ticket nº do chamado alterando status para aberto\",\n \"Subject\": \"Atualizando assunto\"\n // \"MimeType\": \"text/plain\",\n // \"Charset\": \"UTF-8\",\n // \"HistoryType\": \"NewTicket\",\n // \"HistoryComment\": \"Test history\",\n // \"TimeUnit\": 1,\n // \"NoAgentNotify\": 1,\n // \"ForceNotificationToUserID\": [1],\n // \"ExcludeNotificationToUserID\": [1],\n // \"ExcludeMuteNotificationToUserID\": [1]\n }\n// \"DynamicField\": [ \n// {\n// \"Name\": \"TicketKey\",\n// \"Value\": \"teste\"\n// }\n// ],\n// \"Attachment\": [\n// {\n// \"Content\": \"77u/VGVzdGUgUmljYXJkbw==\",\n// \"ContentType\": \"text/plain\",\n// \"Filename\": \"Teste.txt\"\n// }\t\t\n// ]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/ticket/update","description":"Na atualização dos tickets, poucos campos são obrigatórios, e você pode ser guiado pelos retornos de falha para adicionar os campos caso receba erro na hora de criar um novo chamado.
\nPara definir o ticket a ser atualizado é preciso passar o TicketID ou o TicketNumber.
\nÉ importante passar o StateID para atualizar o status do chamado, inclusive para fechá-lo.
\nOs valores dos status podem ser obtidos na parte de \"Estados\" nesta documentação.
\nEm CommunicationChannelID é o meio de comunicação da mensagem:
\n1 para E-mail
\n2 para Fone
\n3 para OTRS
\nCaso opte por utilizar o CommunicationChannelID passando o ID 1, vai ser obrigatório passar a propriedade From no Article com um e-mail válido.
\nNo body de exemplo estão comentados todos os campos opcionais.
\n","urlObject":{"path":["v1.0","ticket","update"],"host":["{{baseUrl}}api"],"query":[],"variable":[]}},"response":[{"id":"f9d26644-179f-4a31-b1ed-dabf3b8974bc","name":"Atualizar um chamado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"SessionID\": \"\",\n// \"ControlSearch\": {\n// \"DynamicField_TicketKey\": {\n// \"Equals\": \"teste\"\n// },\n// \"States\": [\"new\", \"open\"]\n// },\n// \"IgnoreOnUpdate\": [\n// \"Ticket::Queue\",\n// \"Ticket::State\"\n// ],\n// \"TicketID\": \"40449\",\n \"TicketNumber\": \"2025121810000503\",\n \"Ticket\": {\n // \"Title\": \"Testando mensagem de atualização\"\n // \"QueueID\": 8,\n // \"Queue\": \"teste\",\n // \"LockID\": 1,\n // \"Lock\": \"unlock\",\n // \"TypeID\": 2,\n // \"Type\": \"Incident\",\n // //\"ServiceID\": 1,\n // //\"Service\": \"teste\",\n // //\"SLAID\": 1,\n // //\"SLA\": \"teste\",\n \"StateID\": 4\n // \"State\": \"open\",\n // \"PriorityID\": 1,\n // \"Priority\": \"1 very low\",\n // \"OwnerID\": 1,\n // \"Owner\": \"confrapag@confrapag\",\n //\"ResponsibleID\": 1,\n //\"Responsible\": \"confrapag@confrapag\",\n // \"CustomerUser\": \"confrapag@confrapag\",\n // \"Body\": \"Teste via API ok - body\"\n // \"PendingTime\": {\n // \"Year\": 2022,\n // \"Month\": 12,\n // \"Day\": 23,\n // \"Hour\": 23,\n // \"Minute\": 5\n // }\n },\n \"Article\": {\n // \"CommunicationChannel\": \"Email\",\n \"CommunicationChannelID\": 3,\n // \"IsVisibleForCustomer\": 1,\n // \"SenderTypeID\": 3,\n // \"SenderType\": \"customer\",\n // \"AutoResponseType\": \"auto reply\",\n // \"From\": \"confrapag@confrapag\",\n \"ContentType\": \"text/plain; charset=UTF-8\",\n \"Body\": \"Atualização de ticket com ticket nº do chamado alterando status para aberto\",\n \"Subject\": \"Atualizando assunto\"\n // \"MimeType\": \"text/plain\",\n // \"Charset\": \"UTF-8\",\n // \"HistoryType\": \"NewTicket\",\n // \"HistoryComment\": \"Test history\",\n // \"TimeUnit\": 1,\n // \"NoAgentNotify\": 1,\n // \"ForceNotificationToUserID\": [1],\n // \"ExcludeNotificationToUserID\": [1],\n // \"ExcludeMuteNotificationToUserID\": [1]\n }\n// \"DynamicField\": [ \n// {\n// \"Name\": \"TicketKey\",\n// \"Value\": \"teste\"\n// }\n// ],\n// \"Attachment\": [\n// {\n// \"Content\": \"77u/VGVzdGUgUmljYXJkbw==\",\n// \"ContentType\": \"text/plain\",\n// \"Filename\": \"Teste.txt\"\n// }\t\t\n// ]\n}","options":{"raw":{"language":"json"}}},"url":"https://desk.confrapag.com.br/api/v1.0/ticket/update"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 18 Dec 2025 19:20:57 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"71"},{"key":"Connection","value":"keep-alive"},{"key":"X-Served-By","value":"desk.confrapag.com.br"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"TicketNumber\": \"2025121810000503\",\n \"TicketID\": 40449,\n \"ArticleID\": 206030\n}"}],"_postman_id":"b7a36a3b-7ac6-425b-bba3-2f825da937bc"}],"id":"37e9b1ee-afc7-4483-aa6d-ac4b56440cce","description":"Operações relacionadas a leitura e manipulação de tickets.
\n","_postman_id":"37e9b1ee-afc7-4483-aa6d-ac4b56440cce"},{"name":"Filas","item":[{"name":"Tickets por fila","id":"8e3e7ce7-2a0e-4f5b-bc07-eed1d6525c27","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"SessionID\": \"{{SessionID}}\",\n \"QueueIDs\": [\"147\"],\n //\"States\": [\"open\"]\n \"StateIDs\": [\"1\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/ticket/search","description":"Obtenha os ID's dos tickets em sua fila.
\nPara obter os tickets por status tipo (novos, abertos entre outros estados) é importante passar o StateIDs no array como no exemplo do body dos estados que quer se obter os chamados.
\n","urlObject":{"path":["v1.0","ticket","search"],"host":["{{baseUrl}}api"],"query":[],"variable":[]}},"response":[{"id":"a41c2437-4680-4323-a13c-d97af97d019d","name":"Tickets por fila","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"SessionID\": \"{{SessionID}}\",\n \"QueueIDs\": [\"147\"],\n // \"States\": [\"open\"]\n \"StateIDs\": [\"1\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/ticket/search"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 18 Dec 2025 17:52:40 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"keep-alive"},{"key":"X-Served-By","value":"desk.confrapag.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"TicketID\": [\n \"39558\",\n \"38357\"\n ]\n}"}],"_postman_id":"8e3e7ce7-2a0e-4f5b-bc07-eed1d6525c27"}],"id":"207af183-2e22-4a7e-97e2-f7218e53a768","_postman_id":"207af183-2e22-4a7e-97e2-f7218e53a768","description":""},{"name":"Tipos","item":[{"name":"Obter os tipo de chamado","id":"2537b88f-9d58-4d5a-896b-baf84f5fb79f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SessionID\":\"{{SessionID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1.0/type/search","urlObject":{"path":["api","v1.0","type","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"01cce8fc-b66a-49f8-871f-101f8a857fce","name":"Obter os tipo de chamado","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SessionID\":\"{{SessionID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/api/v1.0/type/search"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 18 Dec 2025 17:53:37 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"193"},{"key":"Connection","value":"keep-alive"},{"key":"X-Served-By","value":"desk.confrapag.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"Value\": \"Não classificado\",\n \"Key\": \"1\"\n },\n {\n \"Key\": \"4\",\n \"Value\": \"Requisição\"\n },\n {\n \"Key\": \"6\",\n \"Value\": \"Solicitar Alteração\"\n },\n {\n \"Value\": \"Problema\",\n \"Key\": \"5\"\n },\n {\n \"Value\": \"Incidente\",\n \"Key\": \"2\"\n }\n ]\n}"}],"_postman_id":"2537b88f-9d58-4d5a-896b-baf84f5fb79f"}],"id":"b8408a11-af83-49b1-b8ba-5131824a72a6","_postman_id":"b8408a11-af83-49b1-b8ba-5131824a72a6","description":""},{"name":"Prioridade","item":[{"name":"Obter os tipos de prioridades","id":"6e8581cc-aadc-4b4c-9d70-ca39706a0b91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SessionID\":\"{{SessionID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/priority/search","urlObject":{"path":["v1.0","priority","search"],"host":["{{baseUrl}}api"],"query":[],"variable":[]}},"response":[{"id":"1d62fdab-24f4-4f47-b555-09e00b508fe8","name":"Obter os tipos de prioridades","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"SessionID\":\"{{SessionID}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}api/v1.0/priority/search"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"openresty"},{"key":"Date","value":"Thu, 18 Dec 2025 17:53:46 GMT"},{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Content-Length","value":"166"},{"key":"Connection","value":"keep-alive"},{"key":"X-Served-By","value":"desk.confrapag.com.br"}],"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"Value\": \"2 low\",\n \"Key\": \"2\"\n },\n {\n \"Key\": \"5\",\n \"Value\": \"5 very high\"\n },\n {\n \"Value\": \"3 normal\",\n \"Key\": \"3\"\n },\n {\n \"Value\": \"1 very low\",\n \"Key\": \"1\"\n },\n {\n \"Key\": \"4\",\n \"Value\": \"4 high\"\n }\n ]\n}"}],"_postman_id":"6e8581cc-aadc-4b4c-9d70-ca39706a0b91"}],"id":"ef15bbea-5852-4aad-afe0-72183b328ce2","_postman_id":"ef15bbea-5852-4aad-afe0-72183b328ce2","description":""}]}