Record a finished IVR call

Appends a LockIvrCallCompleted event (telephony-api, after a call to a resident ends). The lock keeps only a derived list of its last 50 calls. A callId already among those 50 is not recorded again (a retried delivery appends no second event).

curl -X POST "https://api.spkey.co/locks/123/RecordIvrCall" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}'

import requests
import json

url = "https://api.spkey.co/locks/123/RecordIvrCall"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.spkey.co/locks/123/RecordIvrCall", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}`)

    req, err := http.NewRequest("POST", "https://api.spkey.co/locks/123/RecordIvrCall", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
    req.Header.Set("X-API-Key", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.spkey.co/locks/123/RecordIvrCall')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}'

response = http.request(request)
puts response.body

{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}

POST

/locks/{id}/RecordIvrCall

POST

Target server for requests. Edit to use your own host.

Bearer Token (JWT)

Bearer Tokenstring

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

API Key (header: X-API-Key)

X-API-Keystring

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.

Lock ID (numeric)

Content-Typestring

The media type of the request body

Options: application/json

Min length: 1 • Max length: 128

Min length: 1

Options: opened, denied, timeout, no_answer, busy, failed, ended

resultstringnull

Options: open_failed, dial_failed, guest_not_connected, talk_limit, hangup_client, hangup_resident, provider_error,

choicestringnull

Options: 0, 1, 9,

Min length: 1

countrystringnull

Min length: 1

createdAtstring

Format: date-time

answeredAtstring

Format: date-time

Format: date-time

durationSecsinteger

Min: 0

Request Preview

Response

Response will appear here after sending the request

Authentication

Authorizationstring

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

X-API-Keystring

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Lock ID (numeric)

Body

application/json

Allowed values:openeddeniedtimeoutno_answerbusyfailedended

resultstring,null

Allowed values:open_faileddial_failedguest_not_connectedtalk_limithangup_clienthangup_residentprovider_error

choicestring,null

Allowed values:019

countrystring,null

createdAtstring

answeredAtstring

durationSecsinteger

Responses

successboolean

Required

aggregateIdstring

Required

versionnumber

Required

eventobject,null

Required

Was this page helpful?

curl -X POST "https://api.spkey.co/locks/123/RecordIvrCall" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}'

import requests
import json

url = "https://api.spkey.co/locks/123/RecordIvrCall"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.spkey.co/locks/123/RecordIvrCall", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}`)

    req, err := http.NewRequest("POST", "https://api.spkey.co/locks/123/RecordIvrCall", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
    req.Header.Set("X-API-Key", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.spkey.co/locks/123/RecordIvrCall')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
  "callId": "example_string",
  "userId": "example_string",
  "status": "opened",
  "result": "null",
  "choice": "null",
  "provider": "example_string",
  "country": "null",
  "language": "example_string",
  "createdAt": "2024-12-25T10:00:00Z",
  "answeredAt": "2024-12-25T10:00:00Z",
  "endedAt": "2024-12-25T10:00:00Z",
  "durationSecs": 42
}'

response = http.request(request)
puts response.body

{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}

{
  "error": "Bad Request",
  "message": "The request contains invalid parameters or malformed data",
  "code": 400,
  "details": [
    {
      "field": "email",
      "message": "Invalid email format"
    }
  ]
}