Baixe a documentação técnica da API Device Swap
Detalhes da solução
- Versão da API: Device Swap In 0.1.0
- Autor: TIM Brazil
- Data: 05/10/2025
Para outros detalhes, confira o Swagger da API.
Conheça as funcionalidades
Operações do Device Swap:
Check
Verifica se houve uma troca de aparelho associada ao número consultado dentro de um período determinado (por padrão, até 6 meses retroativos).
Retrieve Date
Recupera a data exata em que ocorreu a última troca de aparelho vinculada ao número informado.
Descubra os retornos da API
Retornos de sucesso
/Check
- Status: 200 | Código: OK
- Retorna se uma troca de aparelho ocorreu nos últimos 6 meses
- Swapped: true/false
/Retrieve Date
- Status: 200 | Código: OK
- Contém informações sobre quando ocorreu a alteração do aparelho nos últimos 6 meses
- latestDeviceChange: YYYY/MM/DD ou Null
Retornos de erro
- Status: 500
- Code: INTERNAL
- Message: 'Internal server error'
- Status: 503
- Code: UNAVAILABLE
- Message: 'Service unavailable'
- Status: 400
- Code: INVALID_ARGUMENT
- Message:'Client specified an invalid argument, request body or query param'
- Status: 401
- Code: UNAUTHENTICATED
- Message: ‘Request not authenticated due to missing, invalid, or expired credentials’
- Status: 403
- Code: PERMISSION_DENIED
- Message: ‘Client does not have sufficient permissions to perform this action.'
- Status: 403
- Code: INVALID_TOKEN_CONTEXT
- Message: ‘Phone number cannot be deducted from access token context'
- Status: 404
- Code: NOT_FOUND
- Message: ‘The specified resource is not found.’
Download API Swagger