Transcribe inbound call

POST /crm/v3/extensions/calling/inbound-call

cURL

cURL

curl --request POST \
  --url https://api.hubapi.com/crm/v3/extensions/calling/inbound-call \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "createEngagement": true,
  "engagementProperties": {},
  "externalCallId": "<string>",
  "fromNumber": {
    "e164Number": "<string>",
    "extension": "<string>"
  },
  "potentialRecipientUserIds": [
    123
  ],
  "toNumber": {
    "e164Number": "<string>",
    "extension": "<string>"
  },
  "callStartedTimestamp": "2023-11-07T05:31:56Z",
  "durationSeconds": 123,
  "userId": 123
}
'

200

{
  "callerIdMatches": [
    {
      "callerIdType": "CONTACT",
      "objectCoordinates": {
        "objectId": 123,
        "objectTypeId": "<string>",
        "portalId": 123
      },
      "email": "<string>",
      "firstName": "<string>",
      "lastName": "<string>"
    }
  ]
}

Supported products

Required Scopes

Autorizaciones

oauth2oauth2oauth2oauth2

Authorization · string · header · requerido

The access token received from the authorization server in the OAuth 2.0 flow.

Cuerpo

application/json

createEngagement · boolean · requerido

engagementProperties · object · requerido

Show child attributes

externalCallId · string · requerido

finalCallStatus · enum<string> · requerido

Opciones disponibles: BUSY, CALLING_CRM_USER, CANCELED, COMPLETED, CONNECTING, FAILED, HOLD, IN_PROGRESS, MISSED, NO_ANSWER, QUEUED, RINGING, UNKNOWN

fromNumber · object · requerido

Show child attributes

potentialRecipientUserIds · integer<int32>[] · requerido

toNumber · object · requerido

Show child attributes

callStartedTimestamp · string<date-time>

durationSeconds · integer<int32>

userId · integer<int32>

Respuesta

200

application/json

successful operation

callerIdMatches · (CONTACT · object | COMPANY · object)[] · requerido

CONTACT

COMPANY

Show child attributes