Skip to main content
POST
/
v1
/
core
/
recordings
/
upload
Create a recording from a phone call
curl --request POST \
  --url https://api.siro.ai/v1/core/recordings/upload \
  --header 'Content-Type: application/json' \
  --header 'x-siro-auth-token: <api-key>' \
  --data '
{
  "fileUrl": "<string>",
  "fileType": "<string>",
  "title": "<string>",
  "userId": "<string>",
  "userEmail": "<string>",
  "userPhone": "<string>",
  "organizationId": "<string>",
  "conversationType": "<string>",
  "dateCreated": "2023-11-07T05:31:56Z",
  "integrationConnectionId": "<string>",
  "crmObjects": [
    {
      "objectType": "Opportunity",
      "objectId": "<string>"
    }
  ],
  "contactName": "<string>",
  "contactPhone": "<string>",
  "result": "closed"
}
'
{
  "data": {
    "recordingId": "<string>"
  },
  "cursor": "<string>",
  "pageSize": 123,
  "limit": 123,
  "total": 123,
  "hasNextPage": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.siro.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-siro-auth-token
string
header
default:<oauth-access-token>
required

OAuth access token for user-scoped requests (Authorization Code or machine-to-machine). Send header x-siro-auth-token: . Not an organization API key.

Body

application/json
​
fileUrl
string<uri>
required

Download URL from the signed-urls endpoint (the downloadUrl returned by POST /v1/core/recordings/signed-urls).

​
fileType
string
required

File type (limited to mp3, aac, wav)

​
title
string

Title of the recording.

​
userId
string

ID of the user who created the recording.

​
userEmail
string

Email of the user who created the recording

​
userPhone
string

Phone number of the user who created the recording

​
organizationId
string

ID of the organization associated with the recording.

​
conversationType
string

Conversation type for the recording to be analyzed against. Falls back to default conversation type

​
dateCreated
string<date-time>

When the recording was created.

​
integrationConnectionId
string

Integration Connection Id.

​
crmObjects
object[]

CRM objects to link to the recording.

​
contactName
string

Contact name for purposes of linking to CRM objects. Ignored if CRM objects are passed.

​
contactPhone
string

Contact phone number for purposes of linking to CRM objects. Ignored if CRM objects are passed.

​
result
enum<string>
Available options:
closed,
not closed,
in progress

Response

Create a recording from a phone call

​
data
object
required
​
cursor
​
pageSize
number
​
limit
number
​
total
number | null
​
hasNextPage
boolean