> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit details of an inbound call to the CRM.

> Este endpoint permite enviar informações sobre uma chamada recebida para o sistema de CRM. A solicitação deve incluir detalhes como o ID da chamada externa, o status da chamada e os números de telefone envolvidos. Esta operação ajuda no registro e gerenciamento de dados de chamadas recebidas no CRM.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/crm-calling-extensions-v3.json POST /crm/v3/extensions/calling/inbound-call
openapi: 3.0.1
info:
  title: CRM Calling Extensions
  description: Basepom for all HubSpot Projects
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Call SDK Guide
      url: >-
        https://developers.hubspot.com/docs/guides/api/crm/extensions/calling-sdk
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /crm/v3/extensions/calling/inbound-call:
    post:
      tags:
        - Advanced
      summary: Envie detalhes de uma chamada recebida para o CRM.
      description: >-
        Este endpoint permite enviar informações sobre uma chamada recebida para
        o sistema de CRM. A solicitação deve incluir detalhes como o ID da
        chamada externa, o status da chamada e os números de telefone
        envolvidos. Esta operação ajuda no registro e gerenciamento de dados de
        chamadas recebidas no CRM.
      operationId: >-
        post-/crm/v3/extensions/calling/inbound-call_/crm/v3/extensions/calling/inbound-call
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompletedThirdPartyCallRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompletedThirdPartyCallResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.objects.contacts.highly_sensitive.write.v2
        - oauth2:
            - crm.objects.contacts.write
        - oauth2:
            - crm.objects.contacts.sensitive.write.v2
        - oauth2:
            - crm.schemas.contacts.write
components:
  schemas:
    CompletedThirdPartyCallRequest:
      required:
        - createEngagement
        - engagementProperties
        - externalCallId
        - finalCallStatus
        - fromNumber
        - potentialRecipientUserIds
        - toNumber
      type: object
      properties:
        callStartedTimestamp:
          type: string
          description: >-
            A data/hora que indica quando a chamada começou, formatada como uma
            string de data e hora.
          format: date-time
        createEngagement:
          type: boolean
          description: Indica se um engajamento deve ser criado para a chamada.
        durationSeconds:
          type: integer
          description: A duração da chamada em segundos.
          format: int32
        engagementProperties:
          type: object
          additionalProperties:
            type: string
          description: Contém propriedades adicionais relacionadas ao engajamento.
        externalCallId:
          type: string
          description: O identificador exclusivo da chamada de um sistema externo.
        finalCallStatus:
          type: string
          description: >-
            O status final da chamada. Os valores aceitos incluem: BUSY,
            CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD,
            IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN.
          enum:
            - BUSY
            - CALLING_CRM_USER
            - CANCELED
            - COMPLETED
            - CONNECTING
            - FAILED
            - HOLD
            - IN_PROGRESS
            - MISSED
            - NO_ANSWER
            - QUEUED
            - RINGING
            - UNKNOWN
        fromNumber:
          $ref: '#/components/schemas/FormattedPhoneNumber'
        potentialRecipientUserIds:
          type: array
          items:
            type: integer
            format: int32
        toNumber:
          $ref: '#/components/schemas/FormattedPhoneNumber'
        userId:
          type: integer
          description: O ID do usuário associado à chamada.
          format: int32
    CompletedThirdPartyCallResponse:
      required:
        - callerIdMatches
      type: object
      properties:
        callerIdMatches:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/ContactCallerId'
              - $ref: '#/components/schemas/CompanyCallerId'
    FormattedPhoneNumber:
      required:
        - e164Number
        - phoneNumberType
      type: object
      properties:
        e164Number:
          type: string
          description: O número de telefone formatado no padrão E.164.
        extension:
          type: string
          description: O número de ramal associado ao número de telefone.
        phoneNumberType:
          type: string
          description: >-
            O tipo de número de telefone. Os valores aceitos incluem:
            FIXED_LINE, MOBILE, VOIP e outros.
          enum:
            - FIXED_LINE
            - FIXED_LINE_OR_MOBILE
            - MOBILE
            - PAGER
            - PERSONAL_NUMBER
            - PREMIUM_RATE
            - SHARED_COST
            - TOLL_FREE
            - UAN
            - UNKNOWN
            - VOICEMAIL
            - VOIP
    ContactCallerId:
      title: CONTACT
      required:
        - callerIdType
        - objectCoordinates
      type: object
      properties:
        callerIdType:
          type: string
          description: >-
            Especifica o tipo de identificador de chamadas, com o valor padrão
            CONTACT.
          default: CONTACT
          enum:
            - CONTACT
        email:
          type: string
          description: O endereço de e-mail do contato.
        firstName:
          type: string
          description: O nome do contato.
        lastName:
          type: string
          description: O sobrenome do contato.
        objectCoordinates:
          $ref: '#/components/schemas/ObjectCoordinates'
      x-hubspot-sub-type-impl: true
    CompanyCallerId:
      title: COMPANY
      required:
        - callerIdType
        - objectCoordinates
      type: object
      properties:
        callerIdType:
          type: string
          description: >-
            Especifica o tipo de identificador de chamadas, que é definido como
            "COMPANY" por padrão.
          default: COMPANY
          enum:
            - COMPANY
        name:
          type: string
          description: O nome associado ao identificador de chamadas da empresa.
        objectCoordinates:
          $ref: '#/components/schemas/ObjectCoordinates'
      x-hubspot-sub-type-impl: true
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ObjectCoordinates:
      required:
        - objectId
        - objectTypeId
        - portalId
      type: object
      properties:
        objectId:
          type: integer
          description: O identificador exclusivo do objeto.
          format: int64
        objectTypeId:
          type: string
          description: O identificador de tipo para o objeto.
        portalId:
          type: integer
          description: O identificador exclusivo do portal.
          format: int32
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            automation: ''
            crm.extensions_calling_transcripts.read: ''
            crm.extensions_calling_transcripts.write: ''
            crm.objects.contacts.highly_sensitive.read.v2: ''
            crm.objects.contacts.highly_sensitive.write.v2: ''
            crm.objects.contacts.read: ''
            crm.objects.contacts.sensitive.read.v2: ''
            crm.objects.contacts.sensitive.write.v2: ''
            crm.objects.contacts.write: ''
            crm.objects.owners.read: ''
            crm.pipelines.approval.read: ''
            crm.pipelines.governance.write: ''
            crm.schemas.contacts.read: ''
            crm.schemas.contacts.write: ''

````