> ## 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.

# Solicita cancelamento de mensagens enviadas

> 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}/submit/cancellations
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}/submit/cancellations:
    post:
      tags:
        - Submit
      summary: >-
        Envia pedidos de cancelamento para mensagens to-mobile selecionadas.
        (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:
                type: integer
                format: int64
            example:
              - 10844864715
              - 10844864716
              - 10844864823
              - 10844864825
          text/json:
            schema:
              type: array
              items:
                type: integer
                format: int64
            example:
              - 10844864715
              - 10844864716
              - 10844864823
              - 10844864825
          application/*+json:
            schema:
              type: array
              items:
                type: integer
                format: int64
            example:
              - 10844864715
              - 10844864716
              - 10844864823
              - 10844864825
      responses:
        '200':
          description: >-
            Chamada realizada com sucesso. Verifique o ErrorID para possíveis
            erros.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmitCancellationsResponse'
              example:
                Cancellations:
                  - ID: 10844864715
                    CancellationStatus: 1
                    CancelRequestID: 10844869023
        '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:
    SubmitCancellationsResponse:
      type: object
      properties:
        ErrorID:
          type: integer
          description: >-
            Presente somente em caso de falha. O valor ErrorID serve como
            referência para entender a causa do erro.
          format: int32
          nullable: true
          example: 0
        Cancellations:
          type: array
          items:
            $ref: '#/components/schemas/SubmitCancellationResult'
          description: Array com informações sobre cancelamentos de mensagens FW
          nullable: true
      additionalProperties: false
      description: Resposta do endpoint de cancelamento ('cancel').
    SubmitCancellationResult:
      type: object
      properties:
        ID:
          type: integer
          description: ID da mensagem to-mobile que está sendo cancelada.
          format: int64
          nullable: true
          example: 10844864715
        CancellationStatus:
          type: integer
          description: |-
            Status do pedido de cancelamento:
              1 - Mensagem cancelada imediatamente pois ainda não foi enviada.
              2 - Mensagem já encerrada e não pode ser cancelada.
              3 - Mensagem submetida, tentando cancelar. O ID do pedido de cancelamento estará disponível na resposta.
            Pode ser omitido na resposta.
          format: int32
          nullable: true
        CancelRequestID:
          type: integer
          description: >-
            ID da mensagem to-mobile do pedido de cancelamento. O status do
            cancelamento dependerá do status dessa mensagem.
          format: int64
          nullable: true
        ErrorID:
          type: integer
          description: >-
            Número do erro caso tenha ocorrido algum problema ao tentar cancelar
            a mensagem.

            Pode ser omitido se não houver erro.
          format: int32
          nullable: true
          example: 0
      additionalProperties: false
      description: >-
        Informações sobre um pedido de cancelamento submetido retornado pelo
        serviço.

        Cada objeto contém os dados de um pedido de cancelamento.

        Em caso de erro (ErrorID > 0), o ID da mensagem não será definido.

````