> ## Documentation Index > Fetch the complete documentation index at: https://doc.allcomtelecom.com/llms.txt > Use this file to discover all available pages before exploring further. # Envia mensagem de “modo” aos terminais > Autenticação: Token Bearer Limitação de taxa: sim (grupo SEND de métodos) Autorização: Conta de usuário ## OpenAPI ````yaml POST /api/v{version}/terminal/mode openapi: 3.0.1 info: title: OpenAPI Auth Store description: API de exemplo para demonstração de autenticação e obtenção de tokens. license: name: Allcom Telecom version: 1.0.0 servers: - url: >- https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1 security: [] paths: /api/v{version}/terminal/mode: post: tags: - Terminal summary: Envia uma mensagem de 'modo' para terminais de destino (Autenticação) description: "Autenticação: Token Bearer\r\n\r\nLimitação de taxa: sim (grupo SEND de métodos)\r\n\r\nAutorização: Conta de usuário" parameters: - name: version in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/ModeMessage' example: - DestinationID: 01008988SKY5909 UserMessageID: 2097 Mode: 1 WakeupInterval: 2 text/json: schema: type: array items: $ref: '#/components/schemas/ModeMessage' example: - DestinationID: 01008988SKY5909 UserMessageID: 2097 Mode: 1 WakeupInterval: 2 application/*+json: schema: type: array items: $ref: '#/components/schemas/ModeMessage' example: - DestinationID: 01008988SKY5909 UserMessageID: 2097 Mode: 1 WakeupInterval: 2 responses: '200': description: >- Chamada realizada com sucesso. Verifique o ErrorID para possíveis erros. content: application/json: schema: $ref: '#/components/schemas/SubmitMessagesResponse' example: Submissions: - ID: 10844864715 DestinationID: 01008988SKY5909 UserMessageID: 2097 OTAMessageSize: 202 OperationMode: null - ID: 10844864716 DestinationID: 01008988SKY5900 UserMessageID: 2098 OTAMessageSize: 202 OperationMode: null - ErrorID: 21827 UserMessageID: 2099 OperationMode: null '401': description: Quando falha a autenticação e autorização. content: application/json: example: Quando falha a autenticação e autorização. '429': description: >- Quando o usuário ultrapassa o limite provisionado de requisições para o endpoint da API, será retornado o código HTTP 429 “Muitas Requisições”. content: application/json: example: >- Quando o usuário ultrapassa o limite provisionado de requisições para o endpoint da API, será retornado o código HTTP 429 “Muitas Requisições”. components: schemas: ModeMessage: description: Uma classe que representa uma mensagem de modo de terminal to-mobile. properties: DestinationID: description: Destino da mensagem (ID principal do terminal). example: 01008988SKY5909 UserMessageID: description: "O UserMessageID é o número de identificação da mensagem do cliente. O cliente deve fornecer um ID de mensagem se quiser mapear para o número do Gateway - o ID na classe FowardSubmission.\r\nO Gateway não armazena o UserMessageID em nenhum lugar." example: 2097 Mode: description: "Modo do terminal. Opções possíveis incluem:\r\n- **0**: ALWAYS_ON (se ALWAYS_ON estiver definido, WakeupInterval será ignorado)\r\n- **1**: WAKE_UP [IDP e OGx]\r\n- **2**: RECEIVE_ON_SEND [somente OGx] (se RECEIVE_ON_SEND estiver definido, WakeupInterval será ignorado)\r\n- **3**: HYBRID [somente OGx]" WakeupInterval: description: "Intervalo de ativação do terminal. Opções possíveis incluem:\r\n- **0**: IDP/OGx: Operação normal\r\n- **1**: IDP/OGx: 30 segundos\r\n- **2**: IDP/OGx: 60 segundos\r\n- **3**: IDP/OGx: 2 minutos\r\n- **4**: IDP/OGx: 3 minutos\r\n- **5**: IDP/OGx: 5 minutos\r\n- **6**: IDP/OGx: 10 minutos\r\n- **7**: IDP/OGx: 15 minutos\r\n- **8**: IDP/OGx: 20 minutos\r\n- **9**: IDP/OGx: 30 minutos\r\n- **10**: IDP/OGx: 60 minutos\r\n- **11**: OGx: 2 horas\r\n- **12**: OGx: 3 horas\r\n- **13**: OGx: 6 horas\r\n- **14**: OGx: 12 horas\r\n- **15**: OGx: 24 horas" SubmitMessagesResponse: type: object properties: ErrorID: type: integer description: >- Presente apenas em caso de falha. O valor ErrorID serve como referência para entender a causa do erro. format: int32 nullable: true example: 0 Submissions: type: array items: $ref: '#/components/schemas/SubmitMessageResult' description: Array com informações sobre submissões de mensagens FW nullable: true additionalProperties: false description: Resposta da submissão de mensagens. SubmitMessageResult: type: object properties: ID: type: integer description: >- ID da mensagem to-mobile gerado pelo Gateway. O cliente pode usar este ID para consultar o status da mensagem. O valor do ID pode reiniciar para 1 após atingir o máximo para seu tipo. Pode ser omitido se não houver valor válido disponível ou necessário. format: int64 nullable: true example: 10844864715 DestinationID: type: string description: >- Número de identificação (Prime ID) do terminal ou ID fornecido pelo usuário em caso de erro. nullable: true example: 01008988SKY5909 ErrorID: type: integer description: |- Número do erro ou zero se a mensagem foi aceita pelo Gateway. Pode ser omitido se não houver erro. format: int32 nullable: true example: 0 UserMessageID: type: integer description: >- Se enviado junto com a mensagem, o Gateway retorna este número para permitir mapear IDs locais (UserMessageID) para IDs do Gateway (ID). Pode ser omitido se não houver valor válido disponível ou necessário. format: int64 nullable: true example: 2097 OTAMessageSize: type: integer description: >- Tamanho da mensagem Over-the-air em bytes. Pode ser omitido se não houver valor válido disponível ou necessário. format: int32 nullable: true OperationMode: type: integer description: |- Modo operacional do terminal: 0 - ALWAYS_ON (IDP ou OGx) 1 - WAKE_UP (IDP ou OGx) 2 - RECEIVE_ON_SEND (apenas OGx) 3 - HYBRID (apenas OGx) Pode ser omitido se o modo for ALWAYS_ON. format: int32 nullable: true ScheduledSendUTC: type: string description: >- Se o terminal estiver em modo WAKE_UP ou HYBRID, contém o horário estimado para transmissão. Pode ser omitido se o modo for ALWAYS_ON. nullable: true TerminalWakeupPeriod: type: integer description: >- Período de wake-up do terminal em segundos se estiver em modo WAKE_UP ou HYBRID. Pode ser omitido se o modo for ALWAYS_ON. format: int32 nullable: true additionalProperties: false description: >- Informações sobre uma mensagem enviada retornadas pelo serviço. Cada objeto contém informações de uma mensagem to-mobile submetida. Em caso de erro (ErrorID > 0), o ID da mensagem não será definido. Contudo, NetworkID e UserMessageID, se definidos, são retornados. ````