Pular para o conteúdo
MSP Desk para desenvolvedores

Aplica um modelo de mensagem a este ticket

GET
/v1/tickets/{ticketId}/message-templates/{templateId}
Code sample: Shell / cURL
curl --request GET \
  --url https://public-api.mspdesk.com.br/v1/tickets/1/message-templates/7 \
  --header 'Authorization: Bearer <token>'

Escopo exigido: tickets:read. Devolve templateId, name e body — o texto do modelo com os placeholders já trocados pelos dados deste ticket. É a mesma operação que a tela faz antes de abrir o editor.

Sem assunto e sem lista de anexos, porque o produto não tem nenhum dos dois: o modelo de mensagem não guarda assunto, e os arquivos do modelo não são anexados à nota. Para anexar um arquivo, envie-o em POST /v1/tickets/{ticketId}/attachments e passe o id em attachmentIds da resposta ou do encaminhamento.

Exige apenas tickets:read, e funciona também em ticket na lixeira: ler o texto de um modelo não escreve nada. Um modelo de outra empresa responde 404 not_found.

Autorizações

Seção intitulada “Authorizations”

Parâmetros

Seção intitulada “Parameters”

Parâmetros de caminho

Seção intitulada “Path Parameters”
ticketId
required
integer format: int64

ID do ticket

Exemplo
1
templateId
required
integer format: int64

ID do modelo de mensagem

Exemplo
7

Respostas

Seção intitulada “Responses”

200

Seção intitulada “200”

O modelo resolvido para o ticket

Media typeapplication/json

Modelo de mensagem com os placeholders já resolvidos para o ticket.

object
body

Texto do modelo com os placeholders já trocados pelos dados deste ticket, em HTML. É o mesmo texto que a tela insere no editor.

string
nullable
name

Nome do modelo.

string
nullable
templateId

Identificador do modelo aplicado.

integer format: int64
nullable
Exemplo
{
  "body": "<p>Olá, Beatriz. Para seguirmos com o chamado 18342, precisamos de acesso remoto ao seu computador. Podemos conectar hoje às 15h?</p>",
  "name": "Solicitação de acesso remoto",
  "templateId": 7
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

400

Seção intitulada “400”

Requisição malformada ou parâmetros de consulta inválidos

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

401

Seção intitulada “401”

Chave de API ausente, inválida, revogada ou expirada

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

403

Seção intitulada “403”

Acesso negado: empresa inativa (account_inactive), API pública desabilitada para a empresa (public_api_disabled), escopo liberado só com a API pública (scope_requires_public_api) ou escopo insuficiente (insufficient_scope)

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

404

Seção intitulada “404”

Recurso inexistente, de outra empresa, ou rota inexistente

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

429

Seção intitulada “429”

Limite de uso atingido (rate_limited); o campo layer indica a camada: ip, company, key, operation ou concurrency

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo

Retry-After
integer format: int32

Segundos até poder repetir

500

Seção intitulada “500”

Erro interno inesperado

Media typeapplication/problem+json

Erro no formato RFC 9457 (application/problem+json).

object
code
required

Código estável do erro, para tratamento programático.

string
detail
required

Explicação legível deste erro específico.

string
errors

Erros de campo — presente quando a falha vem de validação de campo.

Array<object>
object
code

Código estável do erro de campo.

string
Allowed values: required too_long too_short invalid_value invalid_format unknown_field unsupported_operator unsupported_field out_of_range not_found inactive inconsistent_reference not_applicable
field

Campo com erro, em notação de ponto/colchete. Ausente quando o erro não é de um campo específico.

string
nullable
message

Mensagem traduzida no locale da requisição.

string
layer

Presente só no 429

string
Allowed values: ip company key operation concurrency
operation

Presente só quando layer=operation

string
Allowed values: report pdf upload
requestId

Identificador da requisição — informe-o ao suporte ao reportar um erro.

string
requiredScope

Presente só no 403 insufficient_scope

string
status
required

Status HTTP da resposta.

integer format: int32
title
required

Título curto e legível do erro.

string
type
required

URI que identifica o tipo do erro.

string
Exemplo
{
  "code": "not_found",
  "detail": "O recurso solicitado não foi encontrado.",
  "errors": [
    {
      "code": "required"
    }
  ],
  "layer": "ip",
  "operation": "report",
  "requestId": "7f3a9c2e-4b1d-4f7a-9e0c-2b8d6a1f3c55",
  "status": 404,
  "title": "Recurso não encontrado",
  "type": "https://developers.mspdesk.com.br/erros/#not_found"
}

Cabeçalhos

Seção intitulada “Headers”
RateLimit-Limit
integer format: int32

Capacidade do balde mais restritivo consumido nesta requisição

RateLimit-Remaining
integer format: int32

Requisições restantes nesse balde

RateLimit-Reset
integer format: int32

Segundos até o balde encher de novo