Infinity logo
API docs by Redocly

Infinity Call Event API (beta)

Download OpenAPI specification:

Call Event API

Authorizations:
ApiKey
Request Body schema: application/json
required
type
string
Enum: "update" "completed" "end" "start" "answered"

Optional. Defaults to 'completed' if not provided.

direction
required
string
Enum: "in" "out"

Only out supported during beta

customer_id
string

A Unique reference for the Customer who was dialled. If supplied, no lookups will be done internally and this value will be used to link any attribution data related to this customer_id to the call. If not supplied, lookups will be performed to link attribution data to the found customer. It is recommended to omit this field in order to allow the system to perform lookups and ensure this data is linked correctly.

installation_id
required
integer <int64>
reference
required
string

A Unique reference for this call. If not supplied, one will be generated

session_id
string

A Unique reference for the session that this call is part of. If supplied, this value will be used to link any attribution data related to this session to the call. If not supplied, lookups will be performed to link attribution data to the found session. It is recommended to omit this field in order to allow the system to perform lookups and ensure this data is linked correctly.

object

Map of Custom Variables you want to store alongside this call event

object (Agent)
required
object (Durations)
object (Marketing)
required
object (Numbers)

Phone numbers in E.164 format

object (Recording)
required
object (Times)

Responses

Request samples

Content type
application/json
{
  • "type": "update",
  • "direction": "in",
  • "customer_id": "string",
  • "installation_id": 0,
  • "reference": "string",
  • "session_id": "string",
  • "custom_variables": {
    },
  • "agent": {
    },
  • "durations": {
    },
  • "marketing": {
    },
  • "numbers": {
    },
  • "recording": {
    },
  • "times": {
    }
}

Response samples

Content type
application/json
{
  • "reference": "2ddb20b8-e0e3-45ae-a638-42610b990a6a",
  • "recording": {}
}