Telkit API 1.0.0

API-dokumentasjon

Alt du kan gjøre med telkit over REST: sende SMS, e-post og brev, ringe ut, lage lyd og lese saldoen. Siden er laget fra API-ets egen OpenAPI-fil, så den viser det API-et tar imot i dag.

Last ned openapi.json Kom i gang

Før du starter

Slik kobler du til

Én nøkkel, vanlige HTTP-kall og JSON. Dette gjelder alle operasjonene under.

AdressenAlle kall går til https://api.dev.telkit.no, under /v1. Du sender og får JSON.
NøkkelenSend API-nøkkelen i headeren Authorization: Bearer <nøkkel>. Du lager nøklene i dashbordet under Utviklere. En nøkkel kan gjelde hele bedriften eller bare én profil.
Test eller ekteEn nøkkel som starter med tk_test_ sender ingenting og koster ingenting. Du får likevel statusene, og svaret har testMode: true. En nøkkel som starter med tk_live_ sender på ordentlig og trekker fra saldoen.
Idempotency-KeySend headeren Idempotency-Key med hvert kall som er merket med den under. Kommer den samme nøkkelen igjen, får du det lagrede svaret tilbake med Idempotency-Replayed: true, og ingenting blir sendt to ganger.
SvaretEt svar som går bra, har ok: true og innholdet i data. Et kall vi avviser, har ok: false og en kode i refused.code. Kodene står under hver operasjon.
BeløpAlle beløp er hele tall i øre, i felt som slutter på Ore. 1 krone er 100 øre.

Send en SMSbash

curl https://api.dev.telkit.no/v1/sms \  -H "Authorization: Bearer $TELKIT_API_KEY" \  -H "Content-Type: application/json" \  -H "Idempotency-Key: ordre-2041-hentemelding" \  -d '{"profile":"nettbutikken","to":"+4791234567","text":"Hei! Pakken din er klar."}'

Når det går brajson

{  "ok": true,  "data": {    "…": "…"  }}

Når vi avviserjson

{  "ok": false,  "refused": {    "code": "insufficient_credits",    "retryable": false  }}

Operasjoner

Det API-et kan gjøre

164 operasjoner. Velg en for å se feltene.

SMS

GET

/v1/sms

Lister SMS-ene, sendte og mottatte. Bruk cursor for å hente neste side.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID
`q`	i spørringen	`string`	Nei	maks 100 tegn
`senderKind`	i spørringen	`"text" \| "reply_number" \| "dedicated"`	Nei
`tab`	i spørringen	`"all" \| "delivered" \| "sent" \| "scheduled" \| "received" \| "failed"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`counts`	`Record<string, integer>`	Ja
`messages`	`object[]`	Ja
`messages[].charged`	`boolean`	Ja
`messages[].counterpart`	`string`	Ja
`messages[].createdAt`	`string`	Ja
`messages[].direction`	`"out" \| "in"`	Ja
`messages[].doneAt`	`string \| null`	Ja
`messages[].errorDesc`	`string \| null`	Ja
`messages[].id`	`string`	Ja	UUID
`messages[].origin`	`"api" \| "dashboard" \| "notice" \| null`	Ja
`messages[].priceOre`	`integer`	Ja	beløp i øre
`messages[].profileId`	`string`	Ja	UUID
`messages[].scheduledAt`	`string \| null`	Ja
`messages[].sender`	`string \| null`	Ja
`messages[].senderKind`	`"text" \| "reply_number" \| "dedicated"`	Ja
`messages[].sentAt`	`string \| null`	Ja
`messages[].state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja
`messages[].testMode`	`boolean`	Ja
`messages[].text`	`string`	Ja
`messages[].threadId`	`string \| null`	Ja
`messages[].units`	`integer`	Ja
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/sms

Idempotency-Key

Sender en SMS, nå eller på et tidspunkt du velger.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`scheduledAt`	`string`	Nei	tidspunkt i ISO 8601
`sender`	`{ kind: "reply_number" } \| { kind: "text", name } \| { kind: "dedicated" }`	Nei
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–2142 tegn
`to`	`string`	Ja	1–32 tegn
`variables`	`Record<string, string>`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`priceOre`	`integer`	Ja	beløp i øre
`scheduledAt`	`string \| null`	Ja
`state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja
`testMode`	`boolean`	Ja
`units`	`integer`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, destination_not_allowlisted, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_off, service_paused, staff_view_read_only
HTTP 404:profile_not_found, template_not_found
HTTP 422:company_required, recipient_invalid, recipient_opted_out, schedule_in_past, sender_not_approved, sms_content_required, sms_too_long, template_variable_missing, template_wrong_service
HTTP 503:service_unavailable

POST

/v1/sms/quote

Regner ut hvor mange SMS-enheter teksten blir og hva den koster. Ingenting blir sendt.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`sender`	`{ kind: "reply_number" } \| { kind: "text", name } \| { kind: "dedicated" }`	Nei
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–2142 tegn
`variables`	`Record<string, string>`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`characters`	`integer`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`senderKind`	`"text" \| "reply_number" \| "dedicated"`	Ja
`text`	`string`	Ja
`unitPriceOre`	`integer`	Ja	beløp i øre
`units`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, staff_view_read_only
HTTP 404:profile_not_found, template_not_found
HTTP 422:company_required, sender_not_approved, sms_content_required, sms_too_long, template_variable_missing, template_wrong_service

GET

/v1/sms/{id}

Henter én SMS med status og pris.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`charged`	`boolean`	Ja
`counterpart`	`string`	Ja
`createdAt`	`string`	Ja
`direction`	`"out" \| "in"`	Ja
`doneAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`origin`	`"api" \| "dashboard" \| "notice" \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`scheduledAt`	`string \| null`	Ja
`sender`	`string \| null`	Ja
`senderKind`	`"text" \| "reply_number" \| "dedicated"`	Ja
`sentAt`	`string \| null`	Ja
`state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja
`testMode`	`boolean`	Ja
`text`	`string`	Ja
`threadId`	`string \| null`	Ja
`units`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:sms_not_found
HTTP 422:company_required

POST

/v1/sms/{id}/cancel

Idempotency-Key

Avbryter en SMS som ikke er sendt ennå.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:sms_not_found
HTTP 409:sms_not_cancellable
HTTP 422:company_required

SMS-kampanjer

GET

/v1/campaigns

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`campaigns`	`object[]`	Ja
`campaigns[].audience`	`string \| null`	Ja
`campaigns[].budgetMonth`	`string \| null`	Ja
`campaigns[].channel`	`"email" \| "sms"`	Ja
`campaigns[].createdAt`	`string`	Ja	tidspunkt i ISO 8601
`campaigns[].delivered`	`integer`	Ja
`campaigns[].dispatched`	`integer`	Ja
`campaigns[].endedAt`	`string \| null`	Ja
`campaigns[].failed`	`integer`	Ja
`campaigns[].fits`	`integer \| null`	Ja
`campaigns[].groupId`	`string \| null`	Ja
`campaigns[].id`	`string`	Ja	UUID
`campaigns[].mode`	`"live" \| "test"`	Ja
`campaigns[].name`	`string`	Ja
`campaigns[].priceOre`	`integer`	Ja	beløp i øre
`campaigns[].profileId`	`string`	Ja	UUID
`campaigns[].recipients`	`integer`	Ja
`campaigns[].refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`campaigns[].released`	`integer`	Ja
`campaigns[].scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`campaigns[].sent`	`integer`	Ja
`campaigns[].skipped`	`integer`	Ja
`campaigns[].startedAt`	`string \| null`	Ja
`campaigns[].state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`campaigns[].templateId`	`string \| null`	Ja
`campaigns[].text`	`string`	Ja
`campaigns[].units`	`integer`	Ja
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/campaigns

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`groupId`	`string`	Nei	UUID
`name`	`string`	Ja	1–200 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`recipients`	`object[]`	Nei	1–100000 elementer
`recipients[].phone`	`string`	Ja	1–32 tegn
`recipients[].variables`	`Record<string, string>`	Nei
`scheduledAt`	`string`	Nei	tidspunkt i ISO 8601
`sender`	`{ kind: "reply_number" } \| { kind: "text", name } \| { kind: "dedicated" }`	Nei
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–2142 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audience`	`string \| null`	Ja
`budgetMonth`	`string \| null`	Ja
`channel`	`"email" \| "sms"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`delivered`	`integer`	Ja
`dispatched`	`integer`	Ja
`endedAt`	`string \| null`	Ja
`failed`	`integer`	Ja
`fits`	`integer \| null`	Ja
`groupId`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`recipients`	`integer`	Ja
`refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`released`	`integer`	Ja
`scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`sent`	`integer`	Ja
`skipped`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`templateId`	`string \| null`	Ja
`text`	`string`	Ja
`units`	`integer`	Ja

Avvisninger

HTTP 402:campaign_unfunded
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, staff_view_read_only
HTTP 404:campaign_group_not_found, profile_not_found, template_not_found
HTTP 422:campaign_recipients_required, campaign_too_many_recipients, campaign_variable_missing, company_required, schedule_in_past, sender_not_approved, sms_content_required, sms_too_long, template_wrong_service

POST

/v1/campaigns/quote

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`groupId`	`string`	Nei	UUID
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`recipients`	`object[]`	Nei	1–100000 elementer
`recipients[].phone`	`string`	Ja	1–32 tegn
`recipients[].variables`	`Record<string, string>`	Nei
`sender`	`{ kind: "reply_number" } \| { kind: "text", name } \| { kind: "dedicated" }`	Nei
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–2142 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`availableOre`	`integer`	Ja	beløp i øre
`budgetLeftOre`	`integer \| null`	Ja
`fits`	`integer`	Ja
`messages`	`integer`	Ja
`optedOut`	`integer`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`recipients`	`integer`	Ja
`short`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`skipped`	`integer`	Ja
`smsLeftToday`	`integer`	Ja
`smsPerDay`	`integer`	Ja
`test`	`boolean`	Ja
`units`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, staff_view_read_only
HTTP 404:campaign_group_not_found, profile_not_found, template_not_found
HTTP 422:campaign_recipients_required, campaign_too_many_recipients, campaign_variable_missing, company_required, sender_not_approved, sms_content_required, sms_too_long, template_wrong_service

GET

/v1/campaigns/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audience`	`string \| null`	Ja
`budgetMonth`	`string \| null`	Ja
`channel`	`"email" \| "sms"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`delivered`	`integer`	Ja
`dispatched`	`integer`	Ja
`endedAt`	`string \| null`	Ja
`failed`	`integer`	Ja
`fits`	`integer \| null`	Ja
`groupId`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`recipients`	`integer`	Ja
`refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`released`	`integer`	Ja
`scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`sent`	`integer`	Ja
`skipped`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`templateId`	`string \| null`	Ja
`text`	`string`	Ja
`units`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:campaign_not_found
HTTP 422:company_required

POST

/v1/campaigns/{id}/cancel

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audience`	`string \| null`	Ja
`budgetMonth`	`string \| null`	Ja
`channel`	`"email" \| "sms"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`delivered`	`integer`	Ja
`dispatched`	`integer`	Ja
`endedAt`	`string \| null`	Ja
`failed`	`integer`	Ja
`fits`	`integer \| null`	Ja
`groupId`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`recipients`	`integer`	Ja
`refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`released`	`integer`	Ja
`scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`sent`	`integer`	Ja
`skipped`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`templateId`	`string \| null`	Ja
`text`	`string`	Ja
`units`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:campaign_not_found
HTTP 409:campaign_not_cancellable
HTTP 422:company_required

Avmeldinger fra SMS

GET

/v1/sms-opt-outs

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`optedOut`	i spørringen	`boolean`	Nei
`profile`	i spørringen	`string`	Nei	1–64 tegn
`profileId`	i spørringen	`string`	Nei	UUID
`q`	i spørringen	`string`	Nei	maks 100 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`nextCursor`	`string \| null`	Ja
`optOuts`	`object[]`	Ja
`optOuts[].id`	`string`	Ja	UUID
`optOuts[].optedInAt`	`string \| null`	Ja
`optOuts[].optedOut`	`boolean`	Ja
`optOuts[].optedOutAt`	`string \| null`	Ja
`optOuts[].phone`	`string`	Ja
`optOuts[].profileId`	`string`	Ja	UUID
`optOuts[].sourceMessageId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/sms-opt-outs

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`number`	`string`	Ja	1–32 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`optedInAt`	`string \| null`	Ja
`optedOut`	`boolean`	Ja
`optedOutAt`	`string \| null`	Ja
`phone`	`string`	Ja
`profileId`	`string`	Ja	UUID
`sourceMessageId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required, recipient_invalid

DELETE

/v1/sms-opt-outs/{number}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`number`	i adressen	`string`	Ja	1–32 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`optedInAt`	`string \| null`	Ja
`optedOut`	`boolean`	Ja
`optedOutAt`	`string \| null`	Ja
`phone`	`string`	Ja
`profileId`	`string`	Ja	UUID
`sourceMessageId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, sms_opt_out_not_found
HTTP 422:company_required, recipient_invalid

E-post

GET

/v1/email

Lister e-postene. Bruk cursor for å hente neste side.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID
`q`	i spørringen	`string`	Nei	maks 100 tegn
`tab`	i spørringen	`"all" \| "delivered" \| "sent" \| "bounced" \| "received"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`counts`	`Record<string, integer>`	Ja
`messages`	`object[]`	Ja
`messages[].charged`	`boolean`	Ja
`messages[].createdAt`	`string`	Ja
`messages[].direction`	`"out" \| "in"`	Ja
`messages[].doneAt`	`string \| null`	Ja
`messages[].errorDesc`	`string \| null`	Ja
`messages[].from`	`string`	Ja
`messages[].fromName`	`string \| null`	Ja
`messages[].id`	`string`	Ja	UUID
`messages[].origin`	`"api" \| "dashboard" \| null`	Ja
`messages[].priceOre`	`integer`	Ja	beløp i øre
`messages[].profileId`	`string \| null`	Ja
`messages[].sentAt`	`string \| null`	Ja
`messages[].state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "bounced" \| "complained" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja
`messages[].subject`	`string`	Ja
`messages[].testMode`	`boolean`	Ja
`messages[].text`	`string`	Ja
`messages[].to`	`string[]`	Ja
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/email

Idempotency-Key

Sender en e-post fra et avsendernavn som er godkjent.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`html`	`string`	Nei	1–1000000 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`senderId`	`string`	Nei	UUID
`subject`	`string`	Nei	1–998 tegn
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–200000 tegn
`to`	`string \| string[]`	Ja
`variables`	`Record<string, string>`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`priceOre`	`integer`	Ja	beløp i øre
`recipients`	`integer`	Ja	minst 1
`state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "bounced" \| "complained" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja
`testMode`	`boolean`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, service_paused, staff_view_read_only
HTTP 404:profile_not_found, template_not_found
HTTP 422:company_required, email_content_required, email_domain_not_verified, email_sender_not_approved, template_variable_missing, template_wrong_service
HTTP 503:service_unavailable

GET

/v1/email/{id}

Henter én e-post med status og pris.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`charged`	`boolean`	Ja
`createdAt`	`string`	Ja
`direction`	`"out" \| "in"`	Ja
`doneAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`from`	`string`	Ja
`fromName`	`string \| null`	Ja
`html`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`origin`	`"api" \| "dashboard" \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string \| null`	Ja
`sentAt`	`string \| null`	Ja
`state`	`"scheduled" \| "queued" \| "in_flight" \| "uncertain" \| "sent" \| "delivered" \| "bounced" \| "complained" \| "failed" \| "cancelled" \| "held_for_balance" \| "received"`	Ja
`subject`	`string`	Ja
`testMode`	`boolean`	Ja
`text`	`string`	Ja
`to`	`string[]`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:email_not_found
HTTP 422:company_required

E-postkampanjer

GET

/v1/email-campaigns

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`campaigns`	`object[]`	Ja
`campaigns[].audience`	`string \| null`	Ja
`campaigns[].budgetMonth`	`string \| null`	Ja
`campaigns[].channel`	`"email" \| "sms"`	Ja
`campaigns[].createdAt`	`string`	Ja	tidspunkt i ISO 8601
`campaigns[].delivered`	`integer`	Ja
`campaigns[].dispatched`	`integer`	Ja
`campaigns[].endedAt`	`string \| null`	Ja
`campaigns[].failed`	`integer`	Ja
`campaigns[].fits`	`integer \| null`	Ja
`campaigns[].groupId`	`string \| null`	Ja
`campaigns[].id`	`string`	Ja	UUID
`campaigns[].mode`	`"live" \| "test"`	Ja
`campaigns[].name`	`string`	Ja
`campaigns[].priceOre`	`integer`	Ja	beløp i øre
`campaigns[].profileId`	`string`	Ja	UUID
`campaigns[].recipients`	`integer`	Ja
`campaigns[].refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`campaigns[].released`	`integer`	Ja
`campaigns[].scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`campaigns[].senderId`	`string \| null`	Ja
`campaigns[].sent`	`integer`	Ja
`campaigns[].skipped`	`integer`	Ja
`campaigns[].startedAt`	`string \| null`	Ja
`campaigns[].state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`campaigns[].subject`	`string`	Ja
`campaigns[].templateId`	`string \| null`	Ja
`campaigns[].text`	`string`	Ja
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/email-campaigns

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`groupId`	`string`	Nei	UUID
`html`	`string`	Nei	1–1000000 tegn
`name`	`string`	Ja	1–200 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`recipients`	`object[]`	Nei	1–100000 elementer
`recipients[].email`	`string`	Ja	e-postadresse, maks 254 tegn
`recipients[].variables`	`Record<string, string>`	Nei
`scheduledAt`	`string`	Nei	tidspunkt i ISO 8601
`senderId`	`string`	Nei	UUID
`subject`	`string`	Nei	1–998 tegn
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–200000 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audience`	`string \| null`	Ja
`budgetMonth`	`string \| null`	Ja
`channel`	`"email" \| "sms"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`delivered`	`integer`	Ja
`dispatched`	`integer`	Ja
`endedAt`	`string \| null`	Ja
`failed`	`integer`	Ja
`fits`	`integer \| null`	Ja
`groupId`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`recipients`	`integer`	Ja
`refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`released`	`integer`	Ja
`scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`senderId`	`string \| null`	Ja
`sent`	`integer`	Ja
`skipped`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`subject`	`string`	Ja
`templateId`	`string \| null`	Ja
`text`	`string`	Ja

Avvisninger

HTTP 402:campaign_unfunded
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, staff_view_read_only
HTTP 404:campaign_group_not_found, profile_not_found, template_not_found
HTTP 422:campaign_recipients_required, campaign_too_many_recipients, campaign_variable_missing, company_required, email_content_required, email_domain_not_verified, email_sender_not_approved, schedule_in_past, template_wrong_service
HTTP 503:service_unavailable

POST

/v1/email-campaigns/quote

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`groupId`	`string`	Nei	UUID
`html`	`string`	Nei	1–1000000 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`recipients`	`object[]`	Nei	1–100000 elementer
`recipients[].email`	`string`	Ja	e-postadresse, maks 254 tegn
`recipients[].variables`	`Record<string, string>`	Nei
`senderId`	`string`	Nei	UUID
`subject`	`string`	Nei	1–998 tegn
`templateId`	`string`	Nei	UUID
`text`	`string`	Nei	1–200000 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`availableOre`	`integer`	Ja	beløp i øre
`budgetLeftOre`	`integer \| null`	Ja
`emails`	`integer`	Ja
`fits`	`integer`	Ja
`optedOut`	`integer`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`recipients`	`integer`	Ja
`short`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`skipped`	`integer`	Ja
`test`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, staff_view_read_only
HTTP 404:campaign_group_not_found, profile_not_found, template_not_found
HTTP 422:campaign_recipients_required, campaign_too_many_recipients, campaign_variable_missing, company_required, email_content_required, email_domain_not_verified, email_sender_not_approved, template_wrong_service
HTTP 503:service_unavailable

GET

/v1/email-campaigns/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audience`	`string \| null`	Ja
`budgetMonth`	`string \| null`	Ja
`channel`	`"email" \| "sms"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`delivered`	`integer`	Ja
`dispatched`	`integer`	Ja
`endedAt`	`string \| null`	Ja
`failed`	`integer`	Ja
`fits`	`integer \| null`	Ja
`groupId`	`string \| null`	Ja
`html`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`recipients`	`integer`	Ja
`refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`released`	`integer`	Ja
`scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`senderId`	`string \| null`	Ja
`sent`	`integer`	Ja
`skipped`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`subject`	`string`	Ja
`templateId`	`string \| null`	Ja
`text`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:campaign_not_found
HTTP 422:company_required

POST

/v1/email-campaigns/{id}/cancel

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audience`	`string \| null`	Ja
`budgetMonth`	`string \| null`	Ja
`channel`	`"email" \| "sms"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`delivered`	`integer`	Ja
`dispatched`	`integer`	Ja
`endedAt`	`string \| null`	Ja
`failed`	`integer`	Ja
`fits`	`integer \| null`	Ja
`groupId`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`recipients`	`integer`	Ja
`refusal`	`"balance" \| "sms_limit" \| "profile_budget" \| "account_paused" \| "sms_off" \| "sender" \| "email_off" \| null`	Ja
`released`	`integer`	Ja
`scheduledAt`	`string`	Ja	tidspunkt i ISO 8601
`senderId`	`string \| null`	Ja
`sent`	`integer`	Ja
`skipped`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"scheduled" \| "sending" \| "done" \| "cancelled" \| "refused"`	Ja
`subject`	`string`	Ja
`templateId`	`string \| null`	Ja
`text`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:campaign_not_found
HTTP 409:campaign_not_cancellable
HTTP 422:company_required

Avmeldinger fra e-post

GET

/v1/email-opt-outs

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`optedOut`	i spørringen	`boolean`	Nei
`q`	i spørringen	`string`	Nei	maks 100 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`nextCursor`	`string \| null`	Ja
`optOuts`	`object[]`	Ja
`optOuts[].address`	`string`	Ja
`optOuts[].id`	`string`	Ja	UUID
`optOuts[].optedInAt`	`string \| null`	Ja
`optOuts[].optedOut`	`boolean`	Ja
`optOuts[].optedOutAt`	`string`	Ja
`optOuts[].sourceCampaignId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, email_opt_out_access_denied, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/email-opt-outs

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`address`	`string`	Ja	e-postadresse, maks 254 tegn
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`address`	`string`	Ja
`id`	`string`	Ja	UUID
`optedInAt`	`string \| null`	Ja
`optedOut`	`boolean`	Ja
`optedOutAt`	`string`	Ja
`sourceCampaignId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, email_opt_out_access_denied, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

DELETE

/v1/email-opt-outs/{address}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`address`	i adressen	`string`	Ja	e-postadresse, maks 254 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`address`	`string`	Ja
`id`	`string`	Ja	UUID
`optedInAt`	`string \| null`	Ja
`optedOut`	`boolean`	Ja
`optedOutAt`	`string`	Ja
`sourceCampaignId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, email_opt_out_access_denied, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:email_opt_out_not_found
HTTP 422:company_required

Brev

GET

/v1/letters

Lister brevene. Bruk cursor for å hente neste side.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID
`q`	i spørringen	`string`	Nei	maks 100 tegn
`tab`	i spørringen	`"all" \| "processing" \| "printed" \| "posted" \| "delivered" \| "failed"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`counts`	`Record<string, integer>`	Ja
`letters`	`object[]`	Ja
`letters[].charged`	`boolean`	Ja
`letters[].colour`	`boolean`	Ja
`letters[].contentKind`	`"pdf" \| "template" \| "text"`	Ja
`letters[].createdAt`	`string`	Ja	tidspunkt i ISO 8601
`letters[].deliveredAs`	`"digital" \| "paper" \| null`	Ja
`letters[].doneAt`	`string \| null`	Ja
`letters[].errorDesc`	`string \| null`	Ja
`letters[].id`	`string`	Ja	UUID
`letters[].origin`	`"api" \| "dashboard"`	Ja
`letters[].pages`	`integer`	Ja
`letters[].priceOre`	`integer`	Ja	beløp i øre
`letters[].profileId`	`string`	Ja	UUID
`letters[].quotedDigitalOre`	`integer \| null`	Ja
`letters[].quotedPaperOre`	`integer`	Ja	beløp i øre
`letters[].recipient`	`object`	Ja
`letters[].recipient.city`	`string`	Ja
`letters[].recipient.lines`	`string[]`	Ja
`letters[].recipient.name`	`string`	Ja
`letters[].recipient.postalCode`	`string`	Ja
`letters[].returnAddress`	`object`	Ja
`letters[].returnAddress.city`	`string`	Ja
`letters[].returnAddress.lines`	`string[]`	Ja
`letters[].returnAddress.name`	`string`	Ja
`letters[].returnAddress.postalCode`	`string`	Ja
`letters[].sentAt`	`string \| null`	Ja
`letters[].sheets`	`integer`	Ja
`letters[].state`	`"queued" \| "in_flight" \| "uncertain" \| "printing" \| "delivered" \| "posted" \| "failed"`	Ja
`letters[].subject`	`string`	Ja
`letters[].testMode`	`boolean`	Ja
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/letters

Idempotency-Key

Sender et brev, digitalt i Digipost eller på papir i posten.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`colour`	`boolean`	Nei
`companyId`	`string`	Nei	UUID
`content`	`{ kind: "pdf", pdfBase64 } \| { kind: "upload", uploadId } \| { kind: "template", templateId, variables } \| { kind: "text", text }`	Ja
`profileId`	`string`	Ja	UUID
`recipient`	`object`	Ja
`recipient.city`	`string`	Ja	1–200 tegn
`recipient.country`	`string`	Nei
`recipient.lines`	`string[]`	Ja	1–2 elementer
`recipient.name`	`string`	Ja	1–200 tegn
`recipient.postalCode`	`string`	Ja
`subject`	`string`	Nei	1–255 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`charged`	`boolean`	Ja
`colour`	`boolean`	Ja
`contentKind`	`"pdf" \| "template" \| "text"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`deliveredAs`	`"digital" \| "paper" \| null`	Ja
`doneAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`origin`	`"api" \| "dashboard"`	Ja
`pages`	`integer`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`quotedDigitalOre`	`integer \| null`	Ja
`quotedPaperOre`	`integer`	Ja	beløp i øre
`recipient`	`object`	Ja
`recipient.city`	`string`	Ja
`recipient.lines`	`string[]`	Ja
`recipient.name`	`string`	Ja
`recipient.postalCode`	`string`	Ja
`returnAddress`	`object`	Ja
`returnAddress.city`	`string`	Ja
`returnAddress.lines`	`string[]`	Ja
`returnAddress.name`	`string`	Ja
`returnAddress.postalCode`	`string`	Ja
`sentAt`	`string \| null`	Ja
`sheets`	`integer`	Ja
`state`	`"queued" \| "in_flight" \| "uncertain" \| "printing" \| "delivered" \| "posted" \| "failed"`	Ja
`subject`	`string`	Ja
`testMode`	`boolean`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, service_paused, staff_view_read_only, verification_required
HTTP 404:profile_not_found, template_not_found
HTTP 409:upload_expired, upload_not_claimable
HTTP 422:company_required, letter_abroad_unavailable, letter_content_required, letter_pdf_invalid, letter_subject_invalid, letter_subject_required, letter_too_many_sheets, letterhead_missing, letterhead_not_approved, recipient_invalid, template_variable_missing, template_wrong_service
HTTP 503:service_unavailable

POST

/v1/letters/quote

Regner ut hva et brev koster. Ingenting blir sendt.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`colour`	`boolean`	Nei
`companyId`	`string`	Nei	UUID
`content`	`{ kind: "pdf", pdfBase64 } \| { kind: "upload", uploadId } \| { kind: "template", templateId, variables } \| { kind: "text", text }`	Ja
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`digitalOre`	`integer \| null`	Ja
`maxSheets`	`integer`	Ja	minst 1
`pages`	`integer`	Ja	minst 1
`paperLines`	`object[]`	Ja
`paperLines[].amountOre`	`integer`	Ja	beløp i øre
`paperLines[].priceKey`	"base_fee.month" \| "base_fee.year" \| "sms.out" \| "sms.out.dedicated" \| "sms.in" \| "dedicated_number.setup" \| "dedicated_number.month" \| "email.out" \| "email.in" \| "call.out.minute" \| "call.in.minute" \| "call.recording.minute" \| "call.transcription.minute" \| "tts.thousand_characters" \| "transcription.batch.minute" \| "transcription.live.minute" \| "app.minute" \| "call.live_transcription.minute" \| "call.speech_input.minute" \| "call.amd" \| "agent.minute" \| "call.stream.minute" \| "call.bot.minute" \| "summary" \| "phone_number.month" \| "letter.paper.domestic" \| "letter.paper.domestic.extra_sheet" \| "letter.paper.abroad" \| "letter.paper.abroad.extra_sheet" \| "letter.colour.sheet" \| "letter.digital"	Ja
`paperLines[].quantity`	`integer`	Ja
`paperLines[].unitPriceOre`	`integer`	Ja	beløp i øre
`paperOre`	`integer`	Ja	beløp i øre
`sheets`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, template_not_found
HTTP 422:company_required, letter_abroad_unavailable, letter_content_required, letter_pdf_invalid, letter_subject_invalid, letter_subject_required, letter_too_many_sheets, letterhead_missing, letterhead_not_approved, recipient_invalid, template_variable_missing, template_wrong_service
HTTP 503:service_unavailable

GET

/v1/letters/{id}

Henter ett brev med status og pris.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`charged`	`boolean`	Ja
`colour`	`boolean`	Ja
`contentKind`	`"pdf" \| "template" \| "text"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`deliveredAs`	`"digital" \| "paper" \| null`	Ja
`doneAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`origin`	`"api" \| "dashboard"`	Ja
`pages`	`integer`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`quotedDigitalOre`	`integer \| null`	Ja
`quotedPaperOre`	`integer`	Ja	beløp i øre
`recipient`	`object`	Ja
`recipient.city`	`string`	Ja
`recipient.lines`	`string[]`	Ja
`recipient.name`	`string`	Ja
`recipient.postalCode`	`string`	Ja
`returnAddress`	`object`	Ja
`returnAddress.city`	`string`	Ja
`returnAddress.lines`	`string[]`	Ja
`returnAddress.name`	`string`	Ja
`returnAddress.postalCode`	`string`	Ja
`sentAt`	`string \| null`	Ja
`sheets`	`integer`	Ja
`state`	`"queued" \| "in_flight" \| "uncertain" \| "printing" \| "delivered" \| "posted" \| "failed"`	Ja
`subject`	`string`	Ja
`testMode`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:letter_not_found
HTTP 422:company_required

Samtaler

GET

/v1/calls

Lister samtalene. Bruk cursor for å hente neste side.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`kind`	i spørringen	`"automatic" \| "browser" \| "inbound" \| "conference" \| "app"`	Nei
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID
`q`	i spørringen	`string`	Nei	maks 100 tegn
`tab`	i spørringen	`"all" \| "answered" \| "missed" \| "failed"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`calls`	`object[]`	Ja
`calls[].answeredAt`	`string \| null`	Ja
`calls[].audioClipId`	`string \| null`	Ja
`calls[].billedMinutes`	`integer \| null`	Ja
`calls[].createdAt`	`string`	Ja
`calls[].direction`	`"outbound" \| "inbound"`	Ja
`calls[].endReason`	`"hangup" \| "busy" \| "no_answer" \| "rejected" \| "limit_reached" \| "media_failed" \| "speech_failed" \| "cancelled" \| "unfunded" \| null`	Ja
`calls[].endedAt`	`string \| null`	Ja
`calls[].errorDesc`	`string \| null`	Ja
`calls[].externalRef`	`string \| null`	Ja
`calls[].from`	`string`	Ja
`calls[].fundedMinutes`	`integer`	Ja
`calls[].id`	`string`	Ja	UUID
`calls[].kind`	`"automatic" \| "browser" \| "inbound" \| "conference" \| "app"`	Ja
`calls[].metadata`	`Record<string, string>`	Ja
`calls[].origin`	`"api" \| "dashboard" \| null`	Ja
`calls[].priceOre`	`integer \| null`	Ja
`calls[].profileId`	`string`	Ja	UUID
`calls[].recording`	`boolean`	Ja
`calls[].repeat`	`boolean`	Ja
`calls[].reservedMinutes`	`integer`	Ja
`calls[].seconds`	`integer \| null`	Ja
`calls[].state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja
`calls[].testMode`	`boolean`	Ja
`calls[].text`	`string \| null`	Ja
`calls[].to`	`string`	Ja
`calls[].transcription`	`boolean`	Ja
`calls[].ttsPriceOre`	`integer \| null`	Ja
`calls[].unitPriceOre`	`integer`	Ja	beløp i øre
`counts`	`Record<string, integer>`	Ja
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/calls

Idempotency-Key

Ringer et nummer og leser opp en tekst eller spiller av et lydklipp.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`amd`	`object`	Nei
`amd.clipId`	`string`	Nei	UUID
`amd.mode`	`"detect" \| "hangup_on_machine" \| "voicemail_drop"`	Ja
`amd.text`	`string`	Nei	1–80000 tegn
`amd.voice`	`"no_female" \| "no_male" \| "en_female"`	Nei
`audioClipId`	`string`	Nei	UUID
`companyId`	`string`	Nei	UUID
`conference`	`boolean`	Nei
`externalRef`	`string`	Nei	1–200 tegn
`from`	`string`	Nei	1–32 tegn
`liveTranscription`	`"off" \| "caller" \| "all"`	Nei
`maxMinutes`	`integer`	Nei	1–240
`metadata`	`Record<string, string>`	Nei
`participants`	`object[]`	Nei	maks 20 elementer
`participants[].displayName`	`string`	Nei	1–100 tegn
`participants[].externalRef`	`string`	Nei	1–200 tegn
`participants[].kind`	`"app"`	Ja
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Nei
`repeat`	`boolean`	Nei
`stream`	`object`	Nei
`stream.audio`	`"talk" \| "listen"`	Nei
`stream.customParameters`	`Record<string, string>`	Nei
`stream.endpointId`	`string`	Ja	1–200 tegn
`stream.listen`	`{ mode: "single", participantId } \| { mode: "mixed" }`	Nei
`stream.maxMinutes`	`integer`	Nei	1–120
`stream.reconnect`	`boolean`	Nei
`summary`	`boolean`	Nei
`text`	`string`	Nei	1–80000 tegn
`to`	`string`	Nei	1–32 tegn
`transcription`	`boolean`	Nei
`voice`	`"no_female" \| "no_male" \| "en_female"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`answeredAt`	`string \| null`	Ja
`audioClipId`	`string \| null`	Ja
`billedMinutes`	`integer \| null`	Ja
`createdAt`	`string`	Ja
`direction`	`"outbound" \| "inbound"`	Ja
`endReason`	`"hangup" \| "busy" \| "no_answer" \| "rejected" \| "limit_reached" \| "media_failed" \| "speech_failed" \| "cancelled" \| "unfunded" \| null`	Ja
`endedAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`externalRef`	`string \| null`	Ja
`from`	`string`	Ja
`fundedMinutes`	`integer`	Ja
`id`	`string`	Ja	UUID
`kind`	`"automatic" \| "browser" \| "inbound" \| "conference" \| "app"`	Ja
`metadata`	`Record<string, string>`	Ja
`origin`	`"api" \| "dashboard" \| null`	Ja
`participants`	`object[]`	Ja
`participants[].audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`participants[].billedMinutes`	`integer \| null`	Ja
`participants[].callId`	`string`	Ja	UUID
`participants[].connection`	`{ token, url } \| null`	Ja
`participants[].currentCallId`	`string`	Ja	UUID
`participants[].displayName`	`string \| null`	Ja
`participants[].endReason`	`string \| null`	Ja
`participants[].externalRef`	`string \| null`	Ja
`participants[].id`	`string`	Ja	UUID
`participants[].joinedAt`	`string \| null`	Ja
`participants[].kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`participants[].leftAt`	`string \| null`	Ja
`participants[].muted`	`boolean`	Ja
`participants[].phone`	`string \| null`	Ja
`participants[].priceOre`	`integer \| null`	Ja
`participants[].role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`participants[].seconds`	`integer \| null`	Ja
`participants[].state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Ja
`repeat`	`boolean`	Ja
`reservedMinutes`	`integer`	Ja
`seconds`	`integer \| null`	Ja
`state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja
`testMode`	`boolean`	Ja
`text`	`string \| null`	Ja
`to`	`string`	Ja
`transcription`	`boolean`	Ja
`ttsPriceOre`	`integer \| null`	Ja
`unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, destination_not_allowlisted, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_off, service_paused, staff_view_read_only, verification_required
HTTP 404:audio_not_found, profile_not_found
HTTP 422:audio_text_too_long, call_content_required, call_participants_full, capability_unavailable, company_required, number_not_found, recipient_blocked, recipient_invalid, stream_limit_reached, voice_unavailable, webhook_endpoint_not_registered
HTTP 503:service_unavailable, summary_unavailable

GET

/v1/calls/{id}

Henter én samtale med status, varighet og pris.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`answeredAt`	`string \| null`	Ja
`audioClipId`	`string \| null`	Ja
`billedMinutes`	`integer \| null`	Ja
`createdAt`	`string`	Ja
`direction`	`"outbound" \| "inbound"`	Ja
`endReason`	`"hangup" \| "busy" \| "no_answer" \| "rejected" \| "limit_reached" \| "media_failed" \| "speech_failed" \| "cancelled" \| "unfunded" \| null`	Ja
`endedAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`externalRef`	`string \| null`	Ja
`from`	`string`	Ja
`fundedMinutes`	`integer`	Ja
`id`	`string`	Ja	UUID
`kind`	`"automatic" \| "browser" \| "inbound" \| "conference" \| "app"`	Ja
`metadata`	`Record<string, string>`	Ja
`origin`	`"api" \| "dashboard" \| null`	Ja
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Ja
`repeat`	`boolean`	Ja
`reservedMinutes`	`integer`	Ja
`seconds`	`integer \| null`	Ja
`state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja
`testMode`	`boolean`	Ja
`text`	`string \| null`	Ja
`to`	`string`	Ja
`transcription`	`boolean`	Ja
`ttsPriceOre`	`integer \| null`	Ja
`unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

PATCH

/v1/calls/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`externalRef`	`string \| null`	Nei
`metadata`	`Record<string, string>`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`answeredAt`	`string \| null`	Ja
`audioClipId`	`string \| null`	Ja
`billedMinutes`	`integer \| null`	Ja
`createdAt`	`string`	Ja
`direction`	`"outbound" \| "inbound"`	Ja
`endReason`	`"hangup" \| "busy" \| "no_answer" \| "rejected" \| "limit_reached" \| "media_failed" \| "speech_failed" \| "cancelled" \| "unfunded" \| null`	Ja
`endedAt`	`string \| null`	Ja
`errorDesc`	`string \| null`	Ja
`externalRef`	`string \| null`	Ja
`from`	`string`	Ja
`fundedMinutes`	`integer`	Ja
`id`	`string`	Ja	UUID
`kind`	`"automatic" \| "browser" \| "inbound" \| "conference" \| "app"`	Ja
`metadata`	`Record<string, string>`	Ja
`origin`	`"api" \| "dashboard" \| null`	Ja
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Ja
`repeat`	`boolean`	Ja
`reservedMinutes`	`integer`	Ja
`seconds`	`integer \| null`	Ja
`state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja
`testMode`	`boolean`	Ja
`text`	`string \| null`	Ja
`to`	`string`	Ja
`transcription`	`boolean`	Ja
`ttsPriceOre`	`integer \| null`	Ja
`unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/hangup

Idempotency-Key

Legger på en samtale som pågår.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

Styring av samtaler

POST

/v1/calls/{id}/answer

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:call_already_routed, call_not_live
HTTP 422:call_not_inbound, capability_unavailable, company_required, media_tasks_full
HTTP 503:media_capacity_reached

POST

/v1/calls/{id}/move

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`intoCallId`	`string`	Ja	UUID
`participantId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`commandId`	`string`	Ja	UUID
`participant`	`object`	Ja
`participant.audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`participant.billedMinutes`	`integer \| null`	Ja
`participant.callId`	`string`	Ja	UUID
`participant.connection`	`{ token, url } \| null`	Ja
`participant.currentCallId`	`string`	Ja	UUID
`participant.displayName`	`string \| null`	Ja
`participant.endReason`	`string \| null`	Ja
`participant.externalRef`	`string \| null`	Ja
`participant.id`	`string`	Ja	UUID
`participant.joinedAt`	`string \| null`	Ja
`participant.kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`participant.leftAt`	`string \| null`	Ja
`participant.muted`	`boolean`	Ja
`participant.phone`	`string \| null`	Ja
`participant.priceOre`	`integer \| null`	Ja
`participant.role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`participant.seconds`	`integer \| null`	Ja
`participant.state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, participant_not_found
HTTP 409:call_not_live, participant_not_connected
HTTP 422:call_participants_full, capability_unavailable, company_required, move_not_allowed

POST

/v1/calls/{id}/reject

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`state`	`"preparing" \| "queued" \| "dialing" \| "uncertain" \| "ringing" \| "answered" \| "ended" \| "unanswered" \| "failed" \| "cancelled"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:call_already_routed, call_not_live
HTTP 422:call_not_inbound, company_required

GET

/v1/calls/{id}/transfer

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`data`	`{ callId, completedAt, createdAt, errorCode, id, kind, participantId, state, targetParticipantId, to, transferorId } \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/transfer

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`kind`	`"cold" \| "warm"`	Nei
`participantId`	`string`	Nei	UUID
`to`	`string`	Ja	1–32 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"cold" \| "warm"`	Ja
`participantId`	`string`	Ja	UUID
`state`	`"dialing" \| "consulting" \| "completed" \| "cancelled" \| "failed"`	Ja
`targetParticipantId`	`string`	Ja	UUID
`to`	`string`	Ja
`transferorId`	`string \| null`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, destination_not_allowlisted, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:call_not_found, participant_not_found
HTTP 409:call_already_routed, call_not_answered, call_not_live, participant_not_connected, transfer_active
HTTP 422:call_participants_full, capability_unavailable, company_required, number_not_found, recipient_blocked, recipient_invalid

POST

/v1/calls/{id}/transfer/cancel

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`transferId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"cold" \| "warm"`	Ja
`participantId`	`string`	Ja	UUID
`state`	`"dialing" \| "consulting" \| "completed" \| "cancelled" \| "failed"`	Ja
`targetParticipantId`	`string`	Ja	UUID
`to`	`string`	Ja
`transferorId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, transfer_not_found
HTTP 409:transfer_not_active
HTTP 422:company_required

POST

/v1/calls/{id}/transfer/complete

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`transferId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"cold" \| "warm"`	Ja
`participantId`	`string`	Ja	UUID
`state`	`"dialing" \| "consulting" \| "completed" \| "cancelled" \| "failed"`	Ja
`targetParticipantId`	`string`	Ja	UUID
`to`	`string`	Ja
`transferorId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, transfer_not_found
HTTP 409:transfer_not_active
HTTP 422:company_required

Deltakere i samtaler

GET

/v1/calls/{id}/participants

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`participants`	`object[]`	Ja
`participants[].audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`participants[].billedMinutes`	`integer \| null`	Ja
`participants[].callId`	`string`	Ja	UUID
`participants[].connection`	`{ token, url } \| null`	Ja
`participants[].currentCallId`	`string`	Ja	UUID
`participants[].displayName`	`string \| null`	Ja
`participants[].endReason`	`string \| null`	Ja
`participants[].externalRef`	`string \| null`	Ja
`participants[].id`	`string`	Ja	UUID
`participants[].joinedAt`	`string \| null`	Ja
`participants[].kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`participants[].leftAt`	`string \| null`	Ja
`participants[].muted`	`boolean`	Ja
`participants[].phone`	`string \| null`	Ja
`participants[].priceOre`	`integer \| null`	Ja
`participants[].role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`participants[].seconds`	`integer \| null`	Ja
`participants[].state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/participants

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`participant`	`{ displayName, kind: "phone", to } \| { displayName, externalRef, kind: "app" } \| { agentId, kind: "agent" } \| { displayName, externalRef, kind: "bot", maxMinutes }`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`connection`	`{ token, url } \| null`	Ja
`currentCallId`	`string`	Ja	UUID
`displayName`	`string \| null`	Ja
`endReason`	`string \| null`	Ja
`externalRef`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`joinedAt`	`string \| null`	Ja
`kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`leftAt`	`string \| null`	Ja
`muted`	`boolean`	Ja
`phone`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`seconds`	`integer \| null`	Ja
`state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, destination_not_allowlisted, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:agent_not_found, call_not_found
HTTP 409:call_not_live
HTTP 422:call_participants_full, capability_unavailable, company_required, number_not_found, recipient_blocked, recipient_invalid
HTTP 503:media_capacity_reached

PATCH

/v1/calls/{id}/participants/{participantId}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`participantId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`audioMode`	`"talk" \| "listen" \| "whisper"`	Nei
`companyId`	`string`	Nei	UUID
`held`	`boolean`	Nei
`muted`	`boolean`	Nei
`whisperTo`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`connection`	`{ token, url } \| null`	Ja
`currentCallId`	`string`	Ja	UUID
`displayName`	`string \| null`	Ja
`endReason`	`string \| null`	Ja
`externalRef`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`joinedAt`	`string \| null`	Ja
`kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`leftAt`	`string \| null`	Ja
`muted`	`boolean`	Ja
`phone`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`seconds`	`integer \| null`	Ja
`state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, participant_not_found
HTTP 409:participant_not_connected, participant_not_live
HTTP 422:capability_unavailable, company_required

DELETE

/v1/calls/{id}/participants/{participantId}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`participantId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`connection`	`{ token, url } \| null`	Ja
`currentCallId`	`string`	Ja	UUID
`displayName`	`string \| null`	Ja
`endReason`	`string \| null`	Ja
`externalRef`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`joinedAt`	`string \| null`	Ja
`kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`leftAt`	`string \| null`	Ja
`muted`	`boolean`	Ja
`phone`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`seconds`	`integer \| null`	Ja
`state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, participant_not_found
HTTP 409:participant_is_call
HTTP 422:company_required

POST

/v1/calls/{id}/participants/{participantId}/token

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`participantId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`connection`	`{ token, url } \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, participant_not_found
HTTP 409:call_not_live, participant_not_live
HTTP 422:company_required
HTTP 503:service_unavailable

Tilby samtaler til brukere og telefoner

POST

/v1/calls/{id}/offers

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`memberIds`	`string[]`	Nei	maks 20 elementer
`phones`	`string[]`	Nei	maks 20 elementer
`ringSeconds`	`integer`	Nei	5–120

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`acceptedBy`	`string \| null`	Ja
`acceptedParticipantId`	`string \| null`	Ja
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`expiresAt`	`string`	Ja
`id`	`string`	Ja	UUID
`memberIds`	`string[]`	Ja
`phones`	`string[]`	Ja
`ringSeconds`	`integer`	Ja	minst 1
`skippedMemberIds`	`string[]`	Ja
`state`	`"open" \| "accepted" \| "cancelled" \| "expired"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, destination_not_allowlisted, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:call_already_routed, call_not_live, offer_active
HTTP 422:call_participants_full, company_required, number_not_found, offer_member_unknown, offer_targets_invalid, recipient_blocked, recipient_invalid

GET

/v1/calls/{id}/offers/{offerId}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`offerId`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`acceptedBy`	`string \| null`	Ja
`acceptedParticipantId`	`string \| null`	Ja
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`expiresAt`	`string`	Ja
`id`	`string`	Ja	UUID
`memberIds`	`string[]`	Ja
`phones`	`string[]`	Ja
`ringSeconds`	`integer`	Ja	minst 1
`skippedMemberIds`	`string[]`	Ja
`state`	`"open" \| "accepted" \| "cancelled" \| "expired"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, offer_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/offers/{offerId}/cancel

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`offerId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`acceptedBy`	`string \| null`	Ja
`acceptedParticipantId`	`string \| null`	Ja
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`expiresAt`	`string`	Ja
`id`	`string`	Ja	UUID
`memberIds`	`string[]`	Ja
`phones`	`string[]`	Ja
`ringSeconds`	`integer`	Ja	minst 1
`skippedMemberIds`	`string[]`	Ja
`state`	`"open" \| "accepted" \| "cancelled" \| "expired"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, offer_not_found
HTTP 422:company_required

Lyd og tastetrykk i samtaler

POST

/v1/calls/{id}/dtmf

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`digits`	`string`	Ja	1–64 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`commandId`	`string \| null`	Ja
`createdAt`	`string`	Ja
`digits`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`ending`	`"finished" \| "stopped" \| null`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"play" \| "say" \| "gather" \| "hold_music" \| "dtmf" \| "transcribe" \| "amd"`	Ja
`outcome`	`"digits" \| "speech" \| "timeout" \| "stopped" \| null`	Ja
`participantId`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`replays`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "running" \| "done" \| "failed" \| "uncertain"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:audio_not_found, call_not_found, participant_not_found
HTTP 409:call_not_live, participant_not_live
HTTP 422:audio_text_too_long, capability_unavailable, company_required, media_tasks_full, voice_unavailable
HTTP 503:media_capacity_reached, service_unavailable

POST

/v1/calls/{id}/gather

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`choices`	`object[]`	Nei	maks 20 elementer
`choices[].id`	`string`	Ja	1–64 tegn
`choices[].phrases`	`string[]`	Ja	1–10 elementer
`companyId`	`string`	Nei	UUID
`finishKey`	`"0" \| "1" \| "2" \| "3" \| "4" \| "5" \| "6" \| "7" \| "8" \| "9" \| "*" \| "#"`	Nei
`input`	`"dtmf" \| "speech"[]`	Nei	1–2 elementer
`language`	`"no" \| "en"`	Nei
`maxDigits`	`integer`	Nei	1–64
`participantId`	`string`	Nei	UUID
`prompt`	`{ clipId } \| { text, voice }`	Nei
`timeoutSeconds`	`integer`	Nei	1–300

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`commandId`	`string \| null`	Ja
`createdAt`	`string`	Ja
`digits`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`ending`	`"finished" \| "stopped" \| null`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"play" \| "say" \| "gather" \| "hold_music" \| "dtmf" \| "transcribe" \| "amd"`	Ja
`outcome`	`"digits" \| "speech" \| "timeout" \| "stopped" \| null`	Ja
`participantId`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`replays`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "running" \| "done" \| "failed" \| "uncertain"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:audio_not_found, call_not_found, participant_not_found
HTTP 409:call_not_live, participant_not_live
HTTP 422:audio_text_too_long, capability_unavailable, company_required, media_tasks_full, voice_unavailable
HTTP 503:media_capacity_reached, service_unavailable

POST

/v1/calls/{id}/media/stop

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`taskId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`commandId`	`string \| null`	Ja
`tasks`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, media_task_not_found
HTTP 409:call_not_live, media_task_not_live
HTTP 422:company_required

GET

/v1/calls/{id}/media/{taskId}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`taskId`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`commandId`	`string \| null`	Ja
`createdAt`	`string`	Ja
`digits`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`ending`	`"finished" \| "stopped" \| null`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"play" \| "say" \| "gather" \| "hold_music" \| "dtmf" \| "transcribe" \| "amd"`	Ja
`outcome`	`"digits" \| "speech" \| "timeout" \| "stopped" \| null`	Ja
`participantId`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`replays`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "running" \| "done" \| "failed" \| "uncertain"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, media_task_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/play

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`clipId`	`string`	Nei	UUID
`companyId`	`string`	Nei	UUID
`loop`	`boolean`	Nei
`participantId`	`string`	Nei	UUID
`sound`	`"hold"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`commandId`	`string \| null`	Ja
`createdAt`	`string`	Ja
`digits`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`ending`	`"finished" \| "stopped" \| null`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"play" \| "say" \| "gather" \| "hold_music" \| "dtmf" \| "transcribe" \| "amd"`	Ja
`outcome`	`"digits" \| "speech" \| "timeout" \| "stopped" \| null`	Ja
`participantId`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`replays`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "running" \| "done" \| "failed" \| "uncertain"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:audio_not_found, call_not_found, participant_not_found
HTTP 409:call_not_live, participant_not_live
HTTP 422:audio_text_too_long, capability_unavailable, company_required, media_tasks_full, voice_unavailable
HTTP 503:media_capacity_reached, service_unavailable

POST

/v1/calls/{id}/say

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`participantId`	`string`	Nei	UUID
`text`	`string`	Ja	1–80000 tegn
`voice`	`"no_female" \| "no_male" \| "en_female"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`commandId`	`string \| null`	Ja
`createdAt`	`string`	Ja
`digits`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`ending`	`"finished" \| "stopped" \| null`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"play" \| "say" \| "gather" \| "hold_music" \| "dtmf" \| "transcribe" \| "amd"`	Ja
`outcome`	`"digits" \| "speech" \| "timeout" \| "stopped" \| null`	Ja
`participantId`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`replays`	`integer`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "running" \| "done" \| "failed" \| "uncertain"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:audio_not_found, call_not_found, participant_not_found
HTTP 409:call_not_live, participant_not_live
HTTP 422:audio_text_too_long, capability_unavailable, company_required, media_tasks_full, voice_unavailable
HTTP 503:media_capacity_reached, service_unavailable

Kommandoer i samtaler

GET

/v1/calls/{id}/commands/{commandId}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`commandId`	i adressen	`string`	Ja	UUID
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`attempts`	`integer`	Ja
`callId`	`string`	Ja	UUID
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`kind`	`"dial" \| "move" \| "transfer_dial" \| "transfer_complete" \| "recording_start" \| "recording_stop" \| "media_start" \| "media_stop" \| "agent_start" \| "stream_start"`	Ja
`participantId`	`string \| null`	Ja
`result`	`Record<string, any> \| null`	Ja
`state`	`"requested" \| "dispatched" \| "done" \| "failed" \| "uncertain"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, command_not_found
HTTP 422:company_required

Opptak av samtaler

POST

/v1/calls/{id}/recording/start

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`transcription`	`boolean`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`seconds`	`integer \| null`	Ja
`startedAt`	`string`	Ja
`state`	`"recording" \| "stopping" \| "stored" \| "failed"`	Ja
`stopRequestedAt`	`string \| null`	Ja
`storedAt`	`string \| null`	Ja
`testMode`	`boolean`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:call_not_live, recording_active, transcription_taken
HTTP 422:capability_unavailable, company_required

POST

/v1/calls/{id}/recording/stop

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`seconds`	`integer \| null`	Ja
`startedAt`	`string`	Ja
`state`	`"recording" \| "stopping" \| "stored" \| "failed"`	Ja
`stopRequestedAt`	`string \| null`	Ja
`storedAt`	`string \| null`	Ja
`testMode`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:recording_not_active
HTTP 422:company_required

Lydstrømmer fra samtaler til egen server

GET

/v1/calls/{id}/streams

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`streams`	`object[]`	Ja
`streams[].audio`	`"talk" \| "listen"`	Ja
`streams[].billedMinutes`	`integer \| null`	Ja
`streams[].callId`	`string`	Ja	UUID
`streams[].createdAt`	`string`	Ja
`streams[].endReason`	`string \| null`	Ja
`streams[].endedAt`	`string \| null`	Ja
`streams[].endpointId`	`string`	Ja
`streams[].framesDropped`	`integer`	Ja
`streams[].framesIn`	`integer`	Ja
`streams[].framesOut`	`integer`	Ja
`streams[].fundedMinutes`	`integer`	Ja
`streams[].id`	`string`	Ja	UUID
`streams[].listen`	`object`	Ja
`streams[].listen.mode`	`"single" \| "mixed"`	Ja
`streams[].listen.participantId`	`string \| null`	Ja
`streams[].priceOre`	`integer \| null`	Ja
`streams[].reconnect`	`boolean`	Ja
`streams[].seconds`	`integer \| null`	Ja
`streams[].startedAt`	`string \| null`	Ja
`streams[].state`	`"requested" \| "connecting" \| "streaming" \| "ended" \| "failed"`	Ja
`streams[].testMode`	`boolean`	Ja
`streams[].unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/streams

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`audio`	`"talk" \| "listen"`	Nei
`companyId`	`string`	Nei	UUID
`customParameters`	`Record<string, string>`	Nei
`endpointId`	`string`	Ja	1–200 tegn
`listen`	`{ mode: "single", participantId } \| { mode: "mixed" }`	Nei
`maxMinutes`	`integer`	Nei	1–120
`reconnect`	`boolean`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`commandId`	`string \| null`	Ja
`stream`	`object`	Ja
`stream.audio`	`"talk" \| "listen"`	Ja
`stream.billedMinutes`	`integer \| null`	Ja
`stream.callId`	`string`	Ja	UUID
`stream.createdAt`	`string`	Ja
`stream.endReason`	`string \| null`	Ja
`stream.endedAt`	`string \| null`	Ja
`stream.endpointId`	`string`	Ja
`stream.framesDropped`	`integer`	Ja
`stream.framesIn`	`integer`	Ja
`stream.framesOut`	`integer`	Ja
`stream.fundedMinutes`	`integer`	Ja
`stream.id`	`string`	Ja	UUID
`stream.listen`	`object`	Ja
`stream.listen.mode`	`"single" \| "mixed"`	Ja
`stream.listen.participantId`	`string \| null`	Ja
`stream.priceOre`	`integer \| null`	Ja
`stream.reconnect`	`boolean`	Ja
`stream.seconds`	`integer \| null`	Ja
`stream.startedAt`	`string \| null`	Ja
`stream.state`	`"requested" \| "connecting" \| "streaming" \| "ended" \| "failed"`	Ja
`stream.testMode`	`boolean`	Ja
`stream.unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:call_not_found, participant_not_found
HTTP 409:call_not_live
HTTP 422:call_participants_full, capability_unavailable, company_required, stream_limit_reached, webhook_endpoint_not_registered
HTTP 503:media_capacity_reached

GET

/v1/calls/{id}/streams/{streamId}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`streamId`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audio`	`"talk" \| "listen"`	Ja
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`endReason`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`endpointId`	`string`	Ja
`framesDropped`	`integer`	Ja
`framesIn`	`integer`	Ja
`framesOut`	`integer`	Ja
`fundedMinutes`	`integer`	Ja
`id`	`string`	Ja	UUID
`listen`	`object`	Ja
`listen.mode`	`"single" \| "mixed"`	Ja
`listen.participantId`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`reconnect`	`boolean`	Ja
`seconds`	`integer \| null`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "connecting" \| "streaming" \| "ended" \| "failed"`	Ja
`testMode`	`boolean`	Ja
`unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, stream_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/streams/{streamId}/stop

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`streamId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audio`	`"talk" \| "listen"`	Ja
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`endReason`	`string \| null`	Ja
`endedAt`	`string \| null`	Ja
`endpointId`	`string`	Ja
`framesDropped`	`integer`	Ja
`framesIn`	`integer`	Ja
`framesOut`	`integer`	Ja
`fundedMinutes`	`integer`	Ja
`id`	`string`	Ja	UUID
`listen`	`object`	Ja
`listen.mode`	`"single" \| "mixed"`	Ja
`listen.participantId`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`reconnect`	`boolean`	Ja
`seconds`	`integer \| null`	Ja
`startedAt`	`string \| null`	Ja
`state`	`"requested" \| "connecting" \| "streaming" \| "ended" \| "failed"`	Ja
`testMode`	`boolean`	Ja
`unitPriceOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, stream_not_found
HTTP 409:stream_not_live
HTTP 422:company_required

Opptak

GET

/v1/recordings

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`callId`	i spørringen	`string`	Nei	UUID
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–200
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`nextCursor`	`string \| null`	Ja
`recordings`	`object[]`	Ja
`recordings[].billedMinutes`	`integer \| null`	Ja
`recordings[].callId`	`string`	Ja	UUID
`recordings[].errorCode`	`string \| null`	Ja
`recordings[].id`	`string`	Ja	UUID
`recordings[].priceOre`	`integer \| null`	Ja
`recordings[].profileId`	`string`	Ja	UUID
`recordings[].seconds`	`integer \| null`	Ja
`recordings[].startedAt`	`string`	Ja
`recordings[].state`	`"recording" \| "stopping" \| "stored" \| "failed"`	Ja
`recordings[].stopRequestedAt`	`string \| null`	Ja
`recordings[].storedAt`	`string \| null`	Ja
`recordings[].testMode`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

GET

/v1/recordings/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`billedMinutes`	`integer \| null`	Ja
`callId`	`string`	Ja	UUID
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`link`	`{ expiresAt, href } \| null`	Ja
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`seconds`	`integer \| null`	Ja
`startedAt`	`string`	Ja
`state`	`"recording" \| "stopping" \| "stored" \| "failed"`	Ja
`stopRequestedAt`	`string \| null`	Ja
`storedAt`	`string \| null`	Ja
`testMode`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:recording_not_found
HTTP 422:company_required

DELETE

/v1/recordings/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`deleted`	`true`	Ja
`id`	`string`	Ja	UUID

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:recording_not_found
HTTP 422:company_required

Tekst fra samtaler mens de pågår

GET

/v1/calls/{id}/transcription

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`mode`	`"off" \| "caller" \| "all"`	Ja
`streams`	`object[]`	Ja
`streams[].billedMinutes`	`integer \| null`	Ja
`streams[].errorCode`	`string \| null`	Ja
`streams[].gaps`	`integer`	Ja
`streams[].id`	`string`	Ja	UUID
`streams[].participantId`	`string`	Ja	UUID
`streams[].priceOre`	`integer`	Ja	beløp i øre
`streams[].seconds`	`integer`	Ja
`streams[].state`	`"waiting" \| "running" \| "stopped" \| "unfunded" \| "failed"`	Ja
`transcript`	`{ id, language, readyAt, segments, state, text } \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

DELETE

/v1/calls/{id}/transcription

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`deleted`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:transcription_in_progress
HTTP 422:company_required

GET

/v1/calls/{id}/transcription/segments

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`after`	i spørringen	`integer`	Nei
`companyId`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	maks 200

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`head`	`integer`	Ja
`next`	`integer \| null`	Ja
`segments`	`object[]`	Ja
`segments[].endMs`	`integer \| null`	Ja
`segments[].final`	`boolean`	Ja
`segments[].id`	`string`	Ja	UUID
`segments[].language`	`string \| null`	Ja
`segments[].participantId`	`string \| null`	Ja
`segments[].position`	`integer`	Ja	minst 1
`segments[].revision`	`integer`	Ja	minst 1
`segments[].startMs`	`integer \| null`	Ja
`segments[].text`	`string`	Ja
`segments[].updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/transcription/start

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`language`	`"no" \| "en"`	Nei
`mode`	`"caller" \| "all"`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`mode`	`"off" \| "caller" \| "all"`	Ja
`streams`	`object[]`	Ja
`streams[].billedMinutes`	`integer \| null`	Ja
`streams[].errorCode`	`string \| null`	Ja
`streams[].gaps`	`integer`	Ja
`streams[].id`	`string`	Ja	UUID
`streams[].participantId`	`string`	Ja	UUID
`streams[].priceOre`	`integer`	Ja	beløp i øre
`streams[].seconds`	`integer`	Ja
`streams[].state`	`"waiting" \| "running" \| "stopped" \| "unfunded" \| "failed"`	Ja
`transcript`	`{ id, language, readyAt, segments, state, text } \| null`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, limit_reached, membership_required, outbound_paused, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:call_not_live
HTTP 422:capability_unavailable, company_required
HTTP 503:service_unavailable

POST

/v1/calls/{id}/transcription/stop

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`mode`	`"off" \| "caller" \| "all"`	Ja
`streams`	`object[]`	Ja
`streams[].billedMinutes`	`integer \| null`	Ja
`streams[].errorCode`	`string \| null`	Ja
`streams[].gaps`	`integer`	Ja
`streams[].id`	`string`	Ja	UUID
`streams[].participantId`	`string`	Ja	UUID
`streams[].priceOre`	`integer`	Ja	beløp i øre
`streams[].seconds`	`integer`	Ja
`streams[].state`	`"waiting" \| "running" \| "stopped" \| "unfunded" \| "failed"`	Ja
`transcript`	`{ id, language, readyAt, segments, state, text } \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found
HTTP 409:transcription_not_live
HTTP 422:company_required

Tekst fra samtaler

GET

/v1/calls/{id}/transcript

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`doneAt`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`recordingId`	`string`	Ja	UUID
`segments`	`object[]`	Ja
`segments[].channel`	`integer \| null`	Ja
`segments[].endSeconds`	`number \| null`	Ja
`segments[].speaker`	`string \| null`	Ja
`segments[].startSeconds`	`number \| null`	Ja
`segments[].text`	`string`	Ja
`source`	`"after_call" \| "live"`	Ja
`state`	`"pending" \| "in_flight" \| "uncertain" \| "done" \| "failed"`	Ja
`text`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, transcript_not_found
HTTP 422:company_required

GET

/v1/transcripts

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`callId`	i spørringen	`string`	Nei	UUID
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–200
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`nextCursor`	`string \| null`	Ja
`transcripts`	`object[]`	Ja
`transcripts[].callId`	`string`	Ja	UUID
`transcripts[].createdAt`	`string`	Ja
`transcripts[].doneAt`	`string \| null`	Ja
`transcripts[].id`	`string`	Ja	UUID
`transcripts[].language`	`string \| null`	Ja
`transcripts[].priceOre`	`integer \| null`	Ja
`transcripts[].profileId`	`string`	Ja	UUID
`transcripts[].recordingId`	`string`	Ja	UUID
`transcripts[].source`	`"after_call" \| "live"`	Ja
`transcripts[].state`	`"pending" \| "in_flight" \| "uncertain" \| "done" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

GET

/v1/transcripts/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`doneAt`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`string \| null`	Ja
`priceOre`	`integer \| null`	Ja
`profileId`	`string`	Ja	UUID
`recordingId`	`string`	Ja	UUID
`segments`	`object[]`	Ja
`segments[].channel`	`integer \| null`	Ja
`segments[].endSeconds`	`number \| null`	Ja
`segments[].speaker`	`string \| null`	Ja
`segments[].startSeconds`	`number \| null`	Ja
`segments[].text`	`string`	Ja
`source`	`"after_call" \| "live"`	Ja
`state`	`"pending" \| "in_flight" \| "uncertain" \| "done" \| "failed"`	Ja
`text`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcript_not_found
HTTP 422:company_required

DELETE

/v1/transcripts/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`deleted`	`true`	Ja
`id`	`string`	Ja	UUID

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcript_not_found
HTTP 409:transcript_in_progress
HTTP 422:company_required

Sammendrag av samtaler

GET

/v1/calls/{id}/summary

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`state`	`"waiting" \| "dispatched" \| "done" \| "failed" \| "uncertain"`	Ja
`subjectId`	`string`	Ja	UUID
`subjectKind`	`"call" \| "transcription_job"`	Ja
`text`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:call_not_found, summary_not_found
HTTP 422:company_required

POST

/v1/calls/{id}/summary

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`language`	`"no" \| "en"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`state`	`"waiting" \| "dispatched" \| "done" \| "failed" \| "uncertain"`	Ja
`subjectId`	`string`	Ja	UUID
`subjectKind`	`"call" \| "transcription_job"`	Ja
`text`	`string \| null`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:call_not_found
HTTP 422:company_required
HTTP 503:summary_unavailable

AI-agenter

GET

/v1/agents

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`archived`	i spørringen	`boolean`	Nei
`companyId`	i spørringen	`string`	Nei	UUID
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`agents`	`object[]`	Ja
`agents[].archivedAt`	`string \| null`	Ja
`agents[].brain`	`"hosted" \| "webhook"`	Ja
`agents[].createdAt`	`string`	Ja
`agents[].fallbackLine`	`string \| null`	Ja
`agents[].greeting`	`string \| null`	Ja
`agents[].id`	`string`	Ja	UUID
`agents[].language`	`"no" \| "en"`	Ja
`agents[].maxMinutes`	`integer`	Ja	1–120
`agents[].name`	`string`	Ja	1–100 tegn
`agents[].profileId`	`string`	Ja	UUID
`agents[].prompt`	`string \| null`	Ja
`agents[].tools`	`object[]`	Ja
`agents[].tools[].description`	`string`	Ja
`agents[].tools[].inputSchema`	`Record<string, any>`	Ja
`agents[].tools[].name`	`string`	Ja
`agents[].tools[].webhookEndpointId`	`string`	Ja
`agents[].updatedAt`	`string`	Ja
`agents[].voice`	`"no_female" \| "no_male" \| "en_female"`	Ja
`agents[].webhookEndpointId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/agents

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`brain`	`"hosted" \| "webhook"`	Ja
`companyId`	`string`	Nei	UUID
`fallbackLine`	`string \| null`	Nei
`greeting`	`string \| null`	Nei
`language`	`"no" \| "en"`	Ja
`maxMinutes`	`integer`	Nei	1–120
`name`	`string`	Ja	1–100 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`prompt`	`string \| null`	Nei
`tools`	`object[]`	Nei	maks 8 elementer
`tools[].description`	`string`	Ja	1–1000 tegn
`tools[].inputSchema`	`Record<string, any>`	Ja
`tools[].name`	`string`	Ja	1–64 tegn
`tools[].webhookEndpointId`	`string`	Ja	1–100 tegn
`voice`	`"no_female" \| "no_male" \| "en_female"`	Ja
`webhookEndpointId`	`string \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`brain`	`"hosted" \| "webhook"`	Ja
`createdAt`	`string`	Ja
`fallbackLine`	`string \| null`	Ja
`greeting`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`maxMinutes`	`integer`	Ja	1–120
`name`	`string`	Ja	1–100 tegn
`profileId`	`string`	Ja	UUID
`prompt`	`string \| null`	Ja
`tools`	`object[]`	Ja
`tools[].description`	`string`	Ja
`tools[].inputSchema`	`Record<string, any>`	Ja
`tools[].name`	`string`	Ja
`tools[].webhookEndpointId`	`string`	Ja
`updatedAt`	`string`	Ja
`voice`	`"no_female" \| "no_male" \| "en_female"`	Ja
`webhookEndpointId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:agent_brain_incomplete, agent_tool_name_taken, company_required, webhook_endpoint_not_registered

GET

/v1/agents/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`brain`	`"hosted" \| "webhook"`	Ja
`createdAt`	`string`	Ja
`fallbackLine`	`string \| null`	Ja
`greeting`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`maxMinutes`	`integer`	Ja	1–120
`name`	`string`	Ja	1–100 tegn
`profileId`	`string`	Ja	UUID
`prompt`	`string \| null`	Ja
`tools`	`object[]`	Ja
`tools[].description`	`string`	Ja
`tools[].inputSchema`	`Record<string, any>`	Ja
`tools[].name`	`string`	Ja
`tools[].webhookEndpointId`	`string`	Ja
`updatedAt`	`string`	Ja
`voice`	`"no_female" \| "no_male" \| "en_female"`	Ja
`webhookEndpointId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:agent_not_found
HTTP 422:company_required

PATCH

/v1/agents/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`brain`	`"hosted" \| "webhook"`	Nei
`companyId`	`string`	Nei	UUID
`fallbackLine`	`string \| null`	Nei
`greeting`	`string \| null`	Nei
`language`	`"no" \| "en"`	Nei
`maxMinutes`	`integer`	Nei	1–120
`name`	`string`	Nei	1–100 tegn
`prompt`	`string \| null`	Nei
`tools`	`object[]`	Nei	maks 8 elementer
`tools[].description`	`string`	Ja	1–1000 tegn
`tools[].inputSchema`	`Record<string, any>`	Ja
`tools[].name`	`string`	Ja	1–64 tegn
`tools[].webhookEndpointId`	`string`	Ja	1–100 tegn
`voice`	`"no_female" \| "no_male" \| "en_female"`	Nei
`webhookEndpointId`	`string \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`brain`	`"hosted" \| "webhook"`	Ja
`createdAt`	`string`	Ja
`fallbackLine`	`string \| null`	Ja
`greeting`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`maxMinutes`	`integer`	Ja	1–120
`name`	`string`	Ja	1–100 tegn
`profileId`	`string`	Ja	UUID
`prompt`	`string \| null`	Ja
`tools`	`object[]`	Ja
`tools[].description`	`string`	Ja
`tools[].inputSchema`	`Record<string, any>`	Ja
`tools[].name`	`string`	Ja
`tools[].webhookEndpointId`	`string`	Ja
`updatedAt`	`string`	Ja
`voice`	`"no_female" \| "no_male" \| "en_female"`	Ja
`webhookEndpointId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:agent_not_found, profile_not_found
HTTP 422:agent_brain_incomplete, agent_tool_name_taken, company_required, webhook_endpoint_not_registered

DELETE

/v1/agents/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`brain`	`"hosted" \| "webhook"`	Ja
`createdAt`	`string`	Ja
`fallbackLine`	`string \| null`	Ja
`greeting`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`maxMinutes`	`integer`	Ja	1–120
`name`	`string`	Ja	1–100 tegn
`profileId`	`string`	Ja	UUID
`prompt`	`string \| null`	Ja
`tools`	`object[]`	Ja
`tools[].description`	`string`	Ja
`tools[].inputSchema`	`Record<string, any>`	Ja
`tools[].name`	`string`	Ja
`tools[].webhookEndpointId`	`string`	Ja
`updatedAt`	`string`	Ja
`voice`	`"no_female" \| "no_male" \| "en_female"`	Ja
`webhookEndpointId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:agent_not_found
HTTP 422:company_required

Ferdige telefonløsninger

GET

/v1/dialer-sessions/{sessionId}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`sessionId`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`session`	`object`	Ja
`session.createdAt`	`string`	Ja
`session.current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`session.done`	`integer`	Ja
`session.entries`	`object[] \| null`	Ja
`session.from`	`string`	Ja
`session.id`	`string`	Ja	UUID
`session.mode`	`"live" \| "test"`	Ja
`session.name`	`string`	Ja
`session.pending`	`integer`	Ja
`session.profileId`	`string`	Ja	UUID
`session.seller`	`string`	Ja
`session.skipped`	`integer`	Ja
`session.solutionId`	`string`	Ja	UUID
`session.state`	`"active" \| "paused" \| "finished"`	Ja
`session.total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:dialer_session_not_found
HTTP 422:company_required

POST

/v1/dialer-sessions/{sessionId}/entries/{entryId}/outcome

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`entryId`	i adressen	`string`	Ja	UUID
`sessionId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`doNotCall`	`boolean`	Nei
`note`	`string`	Nei	maks 200 tegn
`outcome`	`string`	Ja	1–40 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`session`	`object`	Ja
`session.createdAt`	`string`	Ja
`session.current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`session.done`	`integer`	Ja
`session.entries`	`object[] \| null`	Ja
`session.from`	`string`	Ja
`session.id`	`string`	Ja	UUID
`session.mode`	`"live" \| "test"`	Ja
`session.name`	`string`	Ja
`session.pending`	`integer`	Ja
`session.profileId`	`string`	Ja	UUID
`session.seller`	`string`	Ja
`session.skipped`	`integer`	Ja
`session.solutionId`	`string`	Ja	UUID
`session.state`	`"active" \| "paused" \| "finished"`	Ja
`session.total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:dialer_session_not_found
HTTP 409:dialer_entry_closed
HTTP 422:company_required, dialer_outcome_unknown

POST

/v1/dialer-sessions/{sessionId}/next

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`sessionId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`call`	`{ callId, connection, entryId, participant } \| null`	Ja
`refused`	`{ code, entryId } \| null`	Ja
`session`	`object`	Ja
`session.createdAt`	`string`	Ja
`session.current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`session.done`	`integer`	Ja
`session.entries`	`object[] \| null`	Ja
`session.from`	`string`	Ja
`session.id`	`string`	Ja	UUID
`session.mode`	`"live" \| "test"`	Ja
`session.name`	`string`	Ja
`session.pending`	`integer`	Ja
`session.profileId`	`string`	Ja	UUID
`session.seller`	`string`	Ja
`session.skipped`	`integer`	Ja
`session.solutionId`	`string`	Ja	UUID
`session.state`	`"active" \| "paused" \| "finished"`	Ja
`session.total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:dialer_session_not_found
HTTP 409:dialer_outcome_required, dialer_session_finished, dialer_session_paused
HTTP 422:company_required, dialer_seller_number_missing

POST

/v1/dialer-sessions/{sessionId}/pause

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`sessionId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`session`	`object`	Ja
`session.createdAt`	`string`	Ja
`session.current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`session.done`	`integer`	Ja
`session.entries`	`object[] \| null`	Ja
`session.from`	`string`	Ja
`session.id`	`string`	Ja	UUID
`session.mode`	`"live" \| "test"`	Ja
`session.name`	`string`	Ja
`session.pending`	`integer`	Ja
`session.profileId`	`string`	Ja	UUID
`session.seller`	`string`	Ja
`session.skipped`	`integer`	Ja
`session.solutionId`	`string`	Ja	UUID
`session.state`	`"active" \| "paused" \| "finished"`	Ja
`session.total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:dialer_session_not_found
HTTP 409:dialer_session_finished
HTTP 422:company_required

POST

/v1/dialer-sessions/{sessionId}/resume

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`sessionId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`session`	`object`	Ja
`session.createdAt`	`string`	Ja
`session.current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`session.done`	`integer`	Ja
`session.entries`	`object[] \| null`	Ja
`session.from`	`string`	Ja
`session.id`	`string`	Ja	UUID
`session.mode`	`"live" \| "test"`	Ja
`session.name`	`string`	Ja
`session.pending`	`integer`	Ja
`session.profileId`	`string`	Ja	UUID
`session.seller`	`string`	Ja
`session.skipped`	`integer`	Ja
`session.solutionId`	`string`	Ja	UUID
`session.state`	`"active" \| "paused" \| "finished"`	Ja
`session.total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:dialer_session_not_found
HTTP 409:dialer_session_finished
HTTP 422:company_required

GET

/v1/solutions

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`archived`	i spørringen	`boolean`	Nei
`companyId`	i spørringen	`string`	Nei	UUID
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`solutions`	`object[]`	Ja
`solutions[].archivedAt`	`string \| null`	Ja
`solutions[].config`	`Record<string, any>`	Ja
`solutions[].createdAt`	`string`	Ja
`solutions[].id`	`string`	Ja	UUID
`solutions[].kind`	`"ivr" \| "support_line" \| "conference_room" \| "voicemail" \| "dialer"`	Ja
`solutions[].name`	`string`	Ja
`solutions[].profileId`	`string`	Ja	UUID
`solutions[].updatedAt`	`string`	Ja
`solutions[].version`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/solutions

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`config`	`Record<string, any>`	Ja
`kind`	`"ivr" \| "support_line" \| "conference_room" \| "voicemail" \| "dialer"`	Ja
`name`	`string`	Ja	1–100 tegn
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`config`	`Record<string, any>`	Ja
`createdAt`	`string`	Ja
`id`	`string`	Ja	UUID
`kind`	`"ivr" \| "support_line" \| "conference_room" \| "voicemail" \| "dialer"`	Ja
`name`	`string`	Ja
`profileId`	`string`	Ja	UUID
`updatedAt`	`string`	Ja
`version`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, live_key_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required, solution_config_invalid, solution_kind_unavailable

GET

/v1/solutions/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`config`	`Record<string, any>`	Ja
`createdAt`	`string`	Ja
`id`	`string`	Ja	UUID
`kind`	`"ivr" \| "support_line" \| "conference_room" \| "voicemail" \| "dialer"`	Ja
`name`	`string`	Ja
`profileId`	`string`	Ja	UUID
`updatedAt`	`string`	Ja
`version`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required

PATCH

/v1/solutions/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`config`	`Record<string, any>`	Nei
`name`	`string`	Nei	1–100 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`config`	`Record<string, any>`	Ja
`createdAt`	`string`	Ja
`id`	`string`	Ja	UUID
`kind`	`"ivr" \| "support_line" \| "conference_room" \| "voicemail" \| "dialer"`	Ja
`name`	`string`	Ja
`profileId`	`string`	Ja	UUID
`updatedAt`	`string`	Ja
`version`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, live_key_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_config_invalid, solution_kind_unavailable

DELETE

/v1/solutions/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`archivedAt`	`string \| null`	Ja
`config`	`Record<string, any>`	Ja
`createdAt`	`string`	Ja
`id`	`string`	Ja	UUID
`kind`	`"ivr" \| "support_line" \| "conference_room" \| "voicemail" \| "dialer"`	Ja
`name`	`string`	Ja
`profileId`	`string`	Ja	UUID
`updatedAt`	`string`	Ja
`version`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, live_key_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required

POST

/v1/solutions/{id}/availability

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`available`	`boolean`	Ja
`companyId`	`string`	Nei	UUID
`memberId`	`string`	Nei	1–128 tegn
`phone`	`string`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`agents`	`object[]`	Ja
`agents[].available`	`boolean`	Ja
`agents[].busy`	`boolean`	Ja
`agents[].kind`	`"member" \| "phone"`	Ja
`agents[].memberId`	`string \| null`	Ja
`agents[].phone`	`string \| null`	Ja
`missedCallbacks`	`object[]`	Ja
`missedCallbacks[].askedAt`	`string`	Ja
`missedCallbacks[].callId`	`string`	Ja	UUID
`missedCallbacks[].endedAt`	`string`	Ja
`missedCallbacks[].outcome`	`"callback_expired" \| "callback_unanswered" \| "refused"`	Ja
`missedCallbacks[].phone`	`string`	Ja
`mode`	`"live" \| "test"`	Ja
`open`	`boolean`	Ja
`solutionId`	`string`	Ja	UUID
`talking`	`integer`	Ja
`waiting`	`object[]`	Ja
`waiting[].callId`	`string`	Ja	UUID
`waiting[].from`	`string`	Ja
`waiting[].state`	`"waiting" \| "offering" \| "connected" \| "done" \| "callback"`	Ja
`waiting[].waitingSince`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, live_key_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_kind_mismatch, support_agent_unknown

GET

/v1/solutions/{id}/dialer-sessions

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`sessions`	`object[]`	Ja
`sessions[].createdAt`	`string`	Ja
`sessions[].current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`sessions[].done`	`integer`	Ja
`sessions[].entries`	`object[] \| null`	Ja
`sessions[].from`	`string`	Ja
`sessions[].id`	`string`	Ja	UUID
`sessions[].mode`	`"live" \| "test"`	Ja
`sessions[].name`	`string`	Ja
`sessions[].pending`	`integer`	Ja
`sessions[].profileId`	`string`	Ja	UUID
`sessions[].seller`	`string`	Ja
`sessions[].skipped`	`integer`	Ja
`sessions[].solutionId`	`string`	Ja	UUID
`sessions[].state`	`"active" \| "paused" \| "finished"`	Ja
`sessions[].total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_kind_mismatch

POST

/v1/solutions/{id}/dialer-sessions

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`entries`	`object[]`	Ja	1–500 elementer
`entries[].externalRef`	`string`	Nei	1–200 tegn
`entries[].name`	`string`	Nei	1–100 tegn
`entries[].phone`	`string`	Ja	1–32 tegn
`name`	`string`	Nei	1–100 tegn
`seller`	`string`	Ja	1–200 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`session`	`object`	Ja
`session.createdAt`	`string`	Ja
`session.current`	`{ callId, calledAt, doneAt, externalRef, id, name, note, outcome, phone, position, refusal, skipReason, state } \| null`	Ja
`session.done`	`integer`	Ja
`session.entries`	`object[] \| null`	Ja
`session.from`	`string`	Ja
`session.id`	`string`	Ja	UUID
`session.mode`	`"live" \| "test"`	Ja
`session.name`	`string`	Ja
`session.pending`	`integer`	Ja
`session.profileId`	`string`	Ja	UUID
`session.seller`	`string`	Ja
`session.skipped`	`integer`	Ja
`session.solutionId`	`string`	Ja	UUID
`session.state`	`"active" \| "paused" \| "finished"`	Ja
`session.total`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, dialer_seller_number_missing, solution_kind_mismatch

POST

/v1/solutions/{id}/join

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`displayName`	`string`	Nei	1–100 tegn
`externalRef`	`string`	Nei	1–200 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`meeting`	`object`	Ja
`meeting.callId`	`string`	Ja	UUID
`meeting.endedAt`	`string \| null`	Ja
`meeting.id`	`string`	Ja	UUID
`meeting.mode`	`"live" \| "test"`	Ja
`meeting.solutionId`	`string`	Ja	UUID
`meeting.startedAt`	`string`	Ja
`participant`	`object`	Ja
`participant.audioMode`	`"talk" \| "listen" \| "whisper"`	Ja
`participant.billedMinutes`	`integer \| null`	Ja
`participant.callId`	`string`	Ja	UUID
`participant.connection`	`{ token, url } \| null`	Ja
`participant.currentCallId`	`string`	Ja	UUID
`participant.displayName`	`string \| null`	Ja
`participant.endReason`	`string \| null`	Ja
`participant.externalRef`	`string \| null`	Ja
`participant.id`	`string`	Ja	UUID
`participant.joinedAt`	`string \| null`	Ja
`participant.kind`	`"phone" \| "app" \| "member" \| "agent" \| "worker" \| "stream" \| "bot"`	Ja
`participant.leftAt`	`string \| null`	Ja
`participant.muted`	`boolean`	Ja
`participant.phone`	`string \| null`	Ja
`participant.priceOre`	`integer \| null`	Ja
`participant.role`	`"primary" \| "leg" \| "member" \| "supervisor"`	Ja
`participant.seconds`	`integer \| null`	Ja
`participant.state`	`"invited" \| "ringing" \| "joined" \| "held" \| "moving" \| "left" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, conference_full, solution_call_refused, solution_kind_mismatch

GET

/v1/solutions/{id}/meetings

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`meetings`	`object[]`	Ja
`meetings[].callId`	`string`	Ja	UUID
`meetings[].endedAt`	`string \| null`	Ja
`meetings[].id`	`string`	Ja	UUID
`meetings[].mode`	`"live" \| "test"`	Ja
`meetings[].solutionId`	`string`	Ja	UUID
`meetings[].startedAt`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_kind_mismatch

GET

/v1/solutions/{id}/queue

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`agents`	`object[]`	Ja
`agents[].available`	`boolean`	Ja
`agents[].busy`	`boolean`	Ja
`agents[].kind`	`"member" \| "phone"`	Ja
`agents[].memberId`	`string \| null`	Ja
`agents[].phone`	`string \| null`	Ja
`missedCallbacks`	`object[]`	Ja
`missedCallbacks[].askedAt`	`string`	Ja
`missedCallbacks[].callId`	`string`	Ja	UUID
`missedCallbacks[].endedAt`	`string`	Ja
`missedCallbacks[].outcome`	`"callback_expired" \| "callback_unanswered" \| "refused"`	Ja
`missedCallbacks[].phone`	`string`	Ja
`mode`	`"live" \| "test"`	Ja
`open`	`boolean`	Ja
`solutionId`	`string`	Ja	UUID
`talking`	`integer`	Ja
`waiting`	`object[]`	Ja
`waiting[].callId`	`string`	Ja	UUID
`waiting[].from`	`string`	Ja
`waiting[].state`	`"waiting" \| "offering" \| "connected" \| "done" \| "callback"`	Ja
`waiting[].waitingSince`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_kind_mismatch

GET

/v1/solutions/{id}/sellers

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`sellers`	`object[]`	Ja
`sellers[].label`	`string`	Ja
`sellers[].number`	`string`	Ja
`sellers[].numberId`	`string`	Ja	UUID
`sellers[].seller`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_kind_mismatch

GET

/v1/support-lines/stats

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`bucket`	i spørringen	`"hour" \| "day"`	Nei
`companyId`	i spørringen	`string`	Nei	UUID
`from`	i spørringen	`string`	Ja	tidspunkt i ISO 8601
`solutionId`	i spørringen	`string`	Nei	UUID
`to`	i spørringen	`string`	Ja	tidspunkt i ISO 8601

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`bucket`	`"hour" \| "day"`	Ja
`byAgent`	`object[]`	Ja
`byAgent[].answerWaitSeconds`	`object`	Ja
`byAgent[].answerWaitSeconds.average`	`integer \| null`	Ja
`byAgent[].answered`	`integer`	Ja
`byAgent[].kind`	`"member" \| "phone"`	Ja
`byAgent[].memberId`	`string \| null`	Ja
`byAgent[].phone`	`string \| null`	Ja
`byAgent[].rings`	`integer`	Ja
`byAgent[].talkSeconds`	`object`	Ja
`byAgent[].talkSeconds.average`	`integer \| null`	Ja
`byAgent[].talkSeconds.total`	`integer`	Ja
`byAgent[].unanswered`	`integer`	Ja
`byBucket`	`object[]`	Ja
`byBucket[].abandoned`	`integer`	Ja
`byBucket[].answerRate`	`number \| null`	Ja
`byBucket[].answerWaitSeconds`	`object`	Ja
`byBucket[].answerWaitSeconds.average`	`integer \| null`	Ja
`byBucket[].answerWaitSeconds.p90`	`integer \| null`	Ja
`byBucket[].answered`	`integer`	Ja
`byBucket[].callbacks`	`integer`	Ja
`byBucket[].calls`	`integer`	Ja
`byBucket[].closed`	`integer`	Ja
`byBucket[].failed`	`integer`	Ja
`byBucket[].inProgress`	`integer`	Ja
`byBucket[].missed`	`integer`	Ja
`byBucket[].overflowed`	`integer`	Ja
`byBucket[].queued`	`integer`	Ja
`byBucket[].start`	`string`	Ja
`byBucket[].talkSeconds`	`object`	Ja
`byBucket[].talkSeconds.average`	`integer \| null`	Ja
`byBucket[].talkSeconds.total`	`integer`	Ja
`byBucket[].waitSeconds`	`object`	Ja
`byBucket[].waitSeconds.average`	`integer \| null`	Ja
`byBucket[].waitSeconds.p90`	`integer \| null`	Ja
`byLine`	`object[]`	Ja
`byLine[].abandoned`	`integer`	Ja
`byLine[].answerRate`	`number \| null`	Ja
`byLine[].answerWaitSeconds`	`object`	Ja
`byLine[].answerWaitSeconds.average`	`integer \| null`	Ja
`byLine[].answerWaitSeconds.p90`	`integer \| null`	Ja
`byLine[].answered`	`integer`	Ja
`byLine[].archived`	`boolean`	Ja
`byLine[].callbacks`	`integer`	Ja
`byLine[].calls`	`integer`	Ja
`byLine[].closed`	`integer`	Ja
`byLine[].failed`	`integer`	Ja
`byLine[].inProgress`	`integer`	Ja
`byLine[].missed`	`integer`	Ja
`byLine[].name`	`string`	Ja
`byLine[].overflowed`	`integer`	Ja
`byLine[].queued`	`integer`	Ja
`byLine[].solutionId`	`string`	Ja	UUID
`byLine[].talkSeconds`	`object`	Ja
`byLine[].talkSeconds.average`	`integer \| null`	Ja
`byLine[].talkSeconds.total`	`integer`	Ja
`byLine[].waitSeconds`	`object`	Ja
`byLine[].waitSeconds.average`	`integer \| null`	Ja
`byLine[].waitSeconds.p90`	`integer \| null`	Ja
`from`	`string`	Ja
`to`	`string`	Ja
`totals`	`object`	Ja
`totals.abandoned`	`integer`	Ja
`totals.answerRate`	`number \| null`	Ja
`totals.answerWaitSeconds`	`object`	Ja
`totals.answerWaitSeconds.average`	`integer \| null`	Ja
`totals.answerWaitSeconds.p90`	`integer \| null`	Ja
`totals.answered`	`integer`	Ja
`totals.callbacks`	`integer`	Ja
`totals.calls`	`integer`	Ja
`totals.closed`	`integer`	Ja
`totals.failed`	`integer`	Ja
`totals.inProgress`	`integer`	Ja
`totals.missed`	`integer`	Ja
`totals.overflowed`	`integer`	Ja
`totals.queued`	`integer`	Ja
`totals.talkSeconds`	`object`	Ja
`totals.talkSeconds.average`	`integer \| null`	Ja
`totals.talkSeconds.total`	`integer`	Ja
`totals.waitSeconds`	`object`	Ja
`totals.waitSeconds.average`	`integer \| null`	Ja
`totals.waitSeconds.p90`	`integer \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:solution_not_found
HTTP 422:company_required, solution_kind_mismatch, support_stats_period_invalid

GET

/v1/voicemails

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–200
`profileId`	i spørringen	`string`	Nei	UUID
`solutionId`	i spørringen	`string`	Nei	UUID
`unread`	i spørringen	`boolean`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`nextCursor`	`string \| null`	Ja
`voicemails`	`object[]`	Ja
`voicemails[].callId`	`string`	Ja	UUID
`voicemails[].createdAt`	`string`	Ja
`voicemails[].from`	`string`	Ja
`voicemails[].id`	`string`	Ja	UUID
`voicemails[].mode`	`"live" \| "test"`	Ja
`voicemails[].profileId`	`string`	Ja	UUID
`voicemails[].readAt`	`string \| null`	Ja
`voicemails[].readBy`	`string \| null`	Ja
`voicemails[].recordingId`	`string \| null`	Ja
`voicemails[].seconds`	`integer`	Ja
`voicemails[].solutionId`	`string`	Ja	UUID
`voicemails[].text`	`string \| null`	Ja
`voicemails[].to`	`string`	Ja
`voicemails[].transcriptId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

GET

/v1/voicemails/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`from`	`string`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`profileId`	`string`	Ja	UUID
`readAt`	`string \| null`	Ja
`readBy`	`string \| null`	Ja
`recordingId`	`string \| null`	Ja
`seconds`	`integer`	Ja
`solutionId`	`string`	Ja	UUID
`text`	`string \| null`	Ja
`to`	`string`	Ja
`transcriptId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:voicemail_not_found
HTTP 422:company_required

DELETE

/v1/voicemails/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`deleted`	`true`	Ja
`id`	`string`	Ja	UUID

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:voicemail_not_found
HTTP 422:company_required

POST

/v1/voicemails/{id}/read

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`read`	`boolean`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callId`	`string`	Ja	UUID
`createdAt`	`string`	Ja
`from`	`string`	Ja
`id`	`string`	Ja	UUID
`mode`	`"live" \| "test"`	Ja
`profileId`	`string`	Ja	UUID
`readAt`	`string \| null`	Ja
`readBy`	`string \| null`	Ja
`recordingId`	`string \| null`	Ja
`seconds`	`integer`	Ja
`solutionId`	`string`	Ja	UUID
`text`	`string \| null`	Ja
`to`	`string`	Ja
`transcriptId`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:voicemail_not_found
HTTP 422:company_required

Lyd

GET

/v1/audio/{id}

Henter ett lydklipp.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`characters`	`integer \| null`	Ja
`createdAt`	`string`	Ja
`errorDesc`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`link`	`{ expiresAt, href } \| null`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`readyAt`	`string \| null`	Ja
`seconds`	`integer \| null`	Ja
`source`	`"tts" \| "upload"`	Ja
`state`	`"pending" \| "in_flight" \| "uncertain" \| "ready" \| "failed"`	Ja
`testMode`	`boolean`	Ja
`text`	`string \| null`	Ja
`voice`	`"no_female" \| "no_male" \| "en_female" \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:audio_not_found
HTTP 422:company_required

POST

/v1/tts

Idempotency-Key

Lager et lydklipp av en tekst med en valgt stemme.

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`name`	`string`	Ja	1–80 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`text`	`string`	Ja	1–80000 tegn
`voice`	`"no_female" \| "no_male" \| "en_female"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`characters`	`integer \| null`	Ja
`createdAt`	`string`	Ja
`errorDesc`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`readyAt`	`string \| null`	Ja
`seconds`	`integer \| null`	Ja
`source`	`"tts" \| "upload"`	Ja
`state`	`"pending" \| "in_flight" \| "uncertain" \| "ready" \| "failed"`	Ja
`testMode`	`boolean`	Ja
`text`	`string \| null`	Ja
`voice`	`"no_female" \| "no_male" \| "en_female" \| null`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_off, service_paused, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:audio_text_too_long, company_required, voice_unavailable
HTTP 503:service_unavailable

Telefonnumre

GET

/v1/number-orders/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`activeAt`	`string \| null`	Ja
`approvedAt`	`string \| null`	Ja
`area`	`"oslo" \| "bergen" \| "trondheim" \| "stavanger" \| "kristiansand" \| "tromso"`	Ja
`assignedTo`	`string \| null`	Ja
`closedAt`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`label`	`string`	Ja
`metadata`	`Record<string, string>`	Ja
`mode`	`"live" \| "test"`	Ja
`monthOre`	`integer`	Ja	beløp i øre
`number`	`string`	Ja
`orderedAt`	`string \| null`	Ja
`phoneNumberId`	`string \| null`	Ja
`profileId`	`string`	Ja	UUID
`refusalReason`	`string \| null`	Ja
`requestedAt`	`string`	Ja	tidspunkt i ISO 8601
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`state`	`"requested" \| "approved" \| "ordering" \| "uncertain" \| "ordered" \| "active" \| "failed" \| "rejected"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:phone_number_order_not_found
HTTP 422:company_required

GET

/v1/numbers

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`monthOre`	`integer`	Ja	beløp i øre
`numbers`	`object[]`	Ja
`numbers[].activeAt`	`string \| null`	Ja
`numbers[].assignedTo`	`string \| null`	Ja
`numbers[].carrier`	`"didww"`	Ja
`numbers[].createdAt`	`string`	Ja	tidspunkt i ISO 8601
`numbers[].decideWithinSeconds`	`integer \| null`	Ja
`numbers[].id`	`string`	Ja	UUID
`numbers[].inboundMode`	`"routing" \| "api" \| "solution"`	Ja
`numbers[].label`	`string`	Ja
`numbers[].metadata`	`Record<string, string>`	Ja
`numbers[].mode`	`"live" \| "test"`	Ja
`numbers[].number`	`string`	Ja
`numbers[].orderId`	`string`	Ja	UUID
`numbers[].profileId`	`string`	Ja	UUID
`numbers[].recording`	`boolean`	Ja
`numbers[].releasedAt`	`string \| null`	Ja
`numbers[].routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`numbers[].solutionId`	`string \| null`	Ja
`numbers[].state`	`"ordered" \| "active" \| "released"`	Ja
`orderable`	`boolean`	Ja
`orders`	`object[]`	Ja
`orders[].activeAt`	`string \| null`	Ja
`orders[].approvedAt`	`string \| null`	Ja
`orders[].area`	`"oslo" \| "bergen" \| "trondheim" \| "stavanger" \| "kristiansand" \| "tromso"`	Ja
`orders[].assignedTo`	`string \| null`	Ja
`orders[].closedAt`	`string \| null`	Ja
`orders[].id`	`string`	Ja	UUID
`orders[].label`	`string`	Ja
`orders[].metadata`	`Record<string, string>`	Ja
`orders[].mode`	`"live" \| "test"`	Ja
`orders[].monthOre`	`integer`	Ja	beløp i øre
`orders[].number`	`string`	Ja
`orders[].orderedAt`	`string \| null`	Ja
`orders[].phoneNumberId`	`string \| null`	Ja
`orders[].profileId`	`string`	Ja	UUID
`orders[].refusalReason`	`string \| null`	Ja
`orders[].requestedAt`	`string`	Ja	tidspunkt i ISO 8601
`orders[].routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`orders[].state`	`"requested" \| "approved" \| "ordering" \| "uncertain" \| "ordered" \| "active" \| "failed" \| "rejected"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/numbers

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`acceptPrice`	`boolean`	Ja
`area`	`"oslo" \| "bergen" \| "trondheim" \| "stavanger" \| "kristiansand" \| "tromso"`	Ja
`assignedTo`	`string \| null`	Nei
`carrierNumberId`	`string`	Ja	1–128 tegn
`companyId`	`string`	Nei	UUID
`label`	`string`	Ja	1–60 tegn
`metadata`	`Record<string, string>`	Nei
`number`	`string`	Ja
`profileId`	`string`	Ja	UUID
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`activeAt`	`string \| null`	Ja
`approvedAt`	`string \| null`	Ja
`area`	`"oslo" \| "bergen" \| "trondheim" \| "stavanger" \| "kristiansand" \| "tromso"`	Ja
`assignedTo`	`string \| null`	Ja
`closedAt`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`label`	`string`	Ja
`metadata`	`Record<string, string>`	Ja
`mode`	`"live" \| "test"`	Ja
`monthOre`	`integer`	Ja	beløp i øre
`number`	`string`	Ja
`orderedAt`	`string \| null`	Ja
`phoneNumberId`	`string \| null`	Ja
`profileId`	`string`	Ja	UUID
`refusalReason`	`string \| null`	Ja
`requestedAt`	`string`	Ja	tidspunkt i ISO 8601
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`state`	`"requested" \| "approved" \| "ordering" \| "uncertain" \| "ordered" \| "active" \| "failed" \| "rejected"`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, destination_not_allowlisted, manager_role_required, membership_required, phone_number_order_limit_reached, role_insufficient, scope_missing, service_off, service_paused, staff_view_read_only, verification_required
HTTP 404:profile_not_found
HTTP 409:phone_number_taken
HTTP 422:company_required, price_not_accepted, routing_clip_invalid, routing_invalid, routing_number_blocked, test_number_invalid
HTTP 503:carrier_unavailable

GET

/v1/numbers/available

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`area`	i spørringen	`"oslo" \| "bergen" \| "trondheim" \| "stavanger" \| "kristiansand" \| "tromso"`	Ja
`companyId`	i spørringen	`string`	Nei	UUID
`contains`	i spørringen	`string \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd
`numbers`	`object[]`	Ja
`numbers[].carrierNumberId`	`string`	Ja
`numbers[].number`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required
HTTP 503:carrier_unavailable

GET

/v1/numbers/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`activeAt`	`string \| null`	Ja
`assignedTo`	`string \| null`	Ja
`carrier`	`"didww"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`decideWithinSeconds`	`integer \| null`	Ja
`id`	`string`	Ja	UUID
`inboundMode`	`"routing" \| "api" \| "solution"`	Ja
`label`	`string`	Ja
`metadata`	`Record<string, string>`	Ja
`mode`	`"live" \| "test"`	Ja
`number`	`string`	Ja
`orderId`	`string`	Ja	UUID
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Ja
`releasedAt`	`string \| null`	Ja
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`solutionId`	`string \| null`	Ja
`state`	`"ordered" \| "active" \| "released"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:phone_number_not_found
HTTP 422:company_required

PATCH

/v1/numbers/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`assignedTo`	`string \| null`	Nei
`companyId`	`string`	Nei	UUID
`decideWithinSeconds`	`integer \| null`	Nei
`inboundMode`	`"routing" \| "api" \| "solution"`	Nei
`label`	`string`	Nei	1–60 tegn
`metadata`	`Record<string, string>`	Nei
`recording`	`boolean`	Nei
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Nei
`solutionId`	`string \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`activeAt`	`string \| null`	Ja
`assignedTo`	`string \| null`	Ja
`carrier`	`"didww"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`decideWithinSeconds`	`integer \| null`	Ja
`id`	`string`	Ja	UUID
`inboundMode`	`"routing" \| "api" \| "solution"`	Ja
`label`	`string`	Ja
`metadata`	`Record<string, string>`	Ja
`mode`	`"live" \| "test"`	Ja
`number`	`string`	Ja
`orderId`	`string`	Ja	UUID
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Ja
`releasedAt`	`string \| null`	Ja
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`solutionId`	`string \| null`	Ja
`state`	`"ordered" \| "active" \| "released"`	Ja

Avvisninger

HTTP 403:company_mismatch, destination_not_allowlisted, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:phone_number_not_found, solution_not_found
HTTP 422:company_required, routing_clip_invalid, routing_invalid, routing_number_blocked

DELETE

/v1/numbers/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`activeAt`	`string \| null`	Ja
`assignedTo`	`string \| null`	Ja
`carrier`	`"didww"`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`decideWithinSeconds`	`integer \| null`	Ja
`id`	`string`	Ja	UUID
`inboundMode`	`"routing" \| "api" \| "solution"`	Ja
`label`	`string`	Ja
`metadata`	`Record<string, string>`	Ja
`mode`	`"live" \| "test"`	Ja
`number`	`string`	Ja
`orderId`	`string`	Ja	UUID
`profileId`	`string`	Ja	UUID
`recording`	`boolean`	Ja
`releasedAt`	`string \| null`	Ja
`routing`	`{ forwardTo, kind: "forward" } \| { clipId, forwardTo, kind: "greeting_forward" } \| { kind: "webhook" } \| { clipId, kind: "message" } \| { kind: "browser" }`	Ja
`solutionId`	`string \| null`	Ja
`state`	`"ordered" \| "active" \| "released"`	Ja

Avvisninger

HTTP 403:company_mismatch, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:phone_number_not_found
HTTP 409:phone_number_in_use, phone_number_not_active
HTTP 422:company_required

Nummeroppslag

GET

/v1/lookup

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`number`	i spørringen	`string`	Ja	1–32 tegn

Felt i svaret (data)

Felt	Type	Påkrevd
`callPricePerMinuteOre`	`integer \| null`	Ja
`dialable`	`boolean`	Ja
`kind`	`"mobile" \| "landline" \| "m2m" \| "special" \| "blocked"`	Ja
`number`	`string`	Ja
`smsPossible`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required, recipient_invalid

Tale til tekst fra filer

GET

/v1/transcription/jobs

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`cursor`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`jobs`	`object[]`	Ja
`jobs[].billedMinutes`	`integer \| null`	Ja
`jobs[].createdAt`	`string`	Ja	tidspunkt i ISO 8601
`jobs[].detectedLanguage`	`string \| null`	Ja
`jobs[].diarize`	`boolean`	Ja
`jobs[].doneAt`	`string \| null`	Ja
`jobs[].errorCode`	`"source_refused" \| "source_redirected" \| "source_unreachable" \| "source_too_large" \| "source_status" \| "audio_unreadable" \| "audio_empty" \| "audio_too_long" \| "insufficient_credits" \| "profile_limit_reached" \| "service_paused" \| "transcription_refused" \| "cancelled" \| null`	Ja
`jobs[].externalRef`	`string \| null`	Ja
`jobs[].id`	`string`	Ja	UUID
`jobs[].language`	`"no" \| "en" \| null`	Ja
`jobs[].mode`	`"live" \| "test"`	Ja
`jobs[].name`	`string`	Ja
`jobs[].priceOre`	`integer`	Ja	beløp i øre
`jobs[].profileId`	`string`	Ja	UUID
`jobs[].seconds`	`integer \| null`	Ja
`jobs[].sizeBytes`	`integer \| null`	Ja
`jobs[].source`	`"upload" \| "url"`	Ja
`jobs[].state`	`"pending" \| "preparing" \| "queued" \| "in_flight" \| "uncertain" \| "done" \| "failed"`	Ja
`minuteOre`	`integer`	Ja	beløp i øre
`nextCursor`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/transcription/jobs

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`diarize`	`boolean`	Nei
`externalRef`	`string`	Nei	maks 200 tegn
`language`	`"no" \| "en" \| null`	Nei
`name`	`string`	Nei	1–200 tegn
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`source`	`{ fileName, kind: "upload", uploadId } \| { kind: "url", url }`	Ja
`summary`	`boolean`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`billedMinutes`	`integer \| null`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`detectedLanguage`	`string \| null`	Ja
`diarize`	`boolean`	Ja
`doneAt`	`string \| null`	Ja
`errorCode`	`"source_refused" \| "source_redirected" \| "source_unreachable" \| "source_too_large" \| "source_status" \| "audio_unreadable" \| "audio_empty" \| "audio_too_long" \| "insufficient_credits" \| "profile_limit_reached" \| "service_paused" \| "transcription_refused" \| "cancelled" \| null`	Ja
`externalRef`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`seconds`	`integer \| null`	Ja
`sizeBytes`	`integer \| null`	Ja
`source`	`"upload" \| "url"`	Ja
`state`	`"pending" \| "preparing" \| "queued" \| "in_flight" \| "uncertain" \| "done" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 409:upload_expired, upload_not_claimable
HTTP 422:audio_too_large, company_required, transcription_link_invalid
HTTP 503:service_unavailable, summary_unavailable

GET

/v1/transcription/jobs/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`billedMinutes`	`integer \| null`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`detectedLanguage`	`string \| null`	Ja
`diarize`	`boolean`	Ja
`doneAt`	`string \| null`	Ja
`errorCode`	`"source_refused" \| "source_redirected" \| "source_unreachable" \| "source_too_large" \| "source_status" \| "audio_unreadable" \| "audio_empty" \| "audio_too_long" \| "insufficient_credits" \| "profile_limit_reached" \| "service_paused" \| "transcription_refused" \| "cancelled" \| null`	Ja
`externalRef`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`seconds`	`integer \| null`	Ja
`sizeBytes`	`integer \| null`	Ja
`source`	`"upload" \| "url"`	Ja
`state`	`"pending" \| "preparing" \| "queued" \| "in_flight" \| "uncertain" \| "done" \| "failed"`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcription_job_not_found
HTTP 422:company_required

DELETE

/v1/transcription/jobs/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`deletedAt`	`string`	Ja	tidspunkt i ISO 8601
`id`	`string`	Ja	UUID

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcription_job_not_found
HTTP 409:transcription_job_busy
HTTP 422:company_required

GET

/v1/transcription/jobs/{id}/result

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID
`format`	i spørringen	`"json" \| "srt" \| "vtt" \| "txt"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`data`	`{ format: "json", jobId, language, segments, text } \| { content, contentType, format, jobId }`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcription_job_not_found
HTTP 409:transcription_not_ready
HTTP 422:company_required

Tale til tekst direkte

POST

/v1/transcription/sessions

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`encoding`	`"pcm_s16le" \| "mulaw"`	Nei
`externalRef`	`string`	Nei	maks 200 tegn
`language`	`"no" \| "en" \| null`	Nei
`maxMinutes`	`integer`	Nei	1–120
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audioSeconds`	`integer`	Ja
`billedMinutes`	`integer \| null`	Ja
`closedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`encoding`	`"pcm_s16le" \| "mulaw"`	Ja
`endReason`	`"closed" \| "funded_limit" \| "wall_clock_cap" \| "disconnected" \| "rate_limited" \| "protocol_error" \| "revoked" \| "server_closed" \| "speech_failed" \| "lost" \| "expired" \| null`	Ja
`expiresAt`	`string`	Ja	tidspunkt i ISO 8601
`externalRef`	`string \| null`	Ja
`fundedSeconds`	`integer`	Ja	minst 1
`id`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`minuteOre`	`integer`	Ja	beløp i øre
`mode`	`"live" \| "test"`	Ja
`openedAt`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`sampleRate`	`integer`	Ja	minst 1
`state`	`"funded" \| "streaming" \| "ended"`	Ja
`wallClockCapAt`	`string \| null`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required, live_options_unsupported
HTTP 503:service_unavailable

GET

/v1/transcription/sessions/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audioSeconds`	`integer`	Ja
`billedMinutes`	`integer \| null`	Ja
`closedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`encoding`	`"pcm_s16le" \| "mulaw"`	Ja
`endReason`	`"closed" \| "funded_limit" \| "wall_clock_cap" \| "disconnected" \| "rate_limited" \| "protocol_error" \| "revoked" \| "server_closed" \| "speech_failed" \| "lost" \| "expired" \| null`	Ja
`expiresAt`	`string`	Ja	tidspunkt i ISO 8601
`externalRef`	`string \| null`	Ja
`fundedSeconds`	`integer`	Ja	minst 1
`id`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`minuteOre`	`integer`	Ja	beløp i øre
`mode`	`"live" \| "test"`	Ja
`openedAt`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`sampleRate`	`integer`	Ja	minst 1
`state`	`"funded" \| "streaming" \| "ended"`	Ja
`wallClockCapAt`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcription_session_not_found
HTTP 422:company_required

POST

/v1/transcription/sessions/{id}/close

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`audioSeconds`	`integer`	Ja
`billedMinutes`	`integer \| null`	Ja
`closedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`encoding`	`"pcm_s16le" \| "mulaw"`	Ja
`endReason`	`"closed" \| "funded_limit" \| "wall_clock_cap" \| "disconnected" \| "rate_limited" \| "protocol_error" \| "revoked" \| "server_closed" \| "speech_failed" \| "lost" \| "expired" \| null`	Ja
`expiresAt`	`string`	Ja	tidspunkt i ISO 8601
`externalRef`	`string \| null`	Ja
`fundedSeconds`	`integer`	Ja	minst 1
`id`	`string`	Ja	UUID
`language`	`"no" \| "en" \| null`	Ja
`minuteOre`	`integer`	Ja	beløp i øre
`mode`	`"live" \| "test"`	Ja
`openedAt`	`string \| null`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`profileId`	`string`	Ja	UUID
`sampleRate`	`integer`	Ja	minst 1
`state`	`"funded" \| "streaming" \| "ended"`	Ja
`wallClockCapAt`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcription_session_not_found
HTTP 422:company_required

POST

/v1/transcription/sessions/{id}/ticket

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`expiresAt`	`string`	Ja	tidspunkt i ISO 8601
`path`	`string`	Ja
`sessionId`	`string`	Ja	UUID
`ticket`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:transcription_session_not_found
HTTP 409:transcription_session_not_open
HTTP 422:company_required
HTTP 429:transcription_ticket_rate_limited
HTTP 503:service_unavailable

Sammendrag av lydfiler

GET

/v1/transcription/jobs/{id}/summary

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`state`	`"waiting" \| "dispatched" \| "done" \| "failed" \| "uncertain"`	Ja
`subjectId`	`string`	Ja	UUID
`subjectKind`	`"call" \| "transcription_job"`	Ja
`text`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:summary_not_found, transcription_job_not_found
HTTP 422:company_required

POST

/v1/transcription/jobs/{id}/summary

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`language`	`"no" \| "en"`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`completedAt`	`string \| null`	Ja
`createdAt`	`string`	Ja
`errorCode`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`language`	`"no" \| "en"`	Ja
`priceOre`	`integer`	Ja	beløp i øre
`state`	`"waiting" \| "dispatched" \| "done" \| "failed" \| "uncertain"`	Ja
`subjectId`	`string`	Ja	UUID
`subjectKind`	`"call" \| "transcription_job"`	Ja
`text`	`string \| null`	Ja

Avvisninger

HTTP 402:insufficient_credits, profile_limit_reached
HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, service_paused, staff_view_read_only
HTTP 404:transcription_job_not_found
HTTP 422:company_required
HTTP 503:summary_unavailable

Kontakter

GET

/v1/contacts

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`after`	i spørringen	`string \| null`	Nei
`companyId`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	1–100
`profileId`	i spørringen	`string`	Ja	UUID
`search`	i spørringen	`string \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`contacts`	`object[]`	Ja
`contacts[].country`	`string \| null`	Ja
`contacts[].email`	`string \| null`	Ja
`contacts[].id`	`string`	Ja	UUID
`contacts[].name`	`string`	Ja
`contacts[].note`	`string \| null`	Ja
`contacts[].phone`	`string \| null`	Ja
`contacts[].postalCode`	`string \| null`	Ja
`contacts[].postalName`	`string \| null`	Ja
`contacts[].profileId`	`string`	Ja	UUID
`contacts[].street`	`string \| null`	Ja
`contacts[].updatedAt`	`string`	Ja	tidspunkt i ISO 8601
`next`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/contacts

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`country`	`string \| null`	Ja
`email`	`string \| null`	Ja
`name`	`string`	Ja	1–200 tegn
`note`	`string \| null`	Ja
`phone`	`string \| null`	Ja
`postalCode`	`string \| null`	Ja
`postalName`	`string \| null`	Ja
`profileId`	`string`	Ja	UUID
`street`	`string \| null`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`country`	`string \| null`	Ja
`email`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`name`	`string`	Ja
`note`	`string \| null`	Ja
`phone`	`string \| null`	Ja
`postalCode`	`string \| null`	Ja
`postalName`	`string \| null`	Ja
`profileId`	`string`	Ja	UUID
`street`	`string \| null`	Ja
`updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_not_found, profile_not_found
HTTP 409:contact_phone_taken
HTTP 422:company_required, contact_phone_invalid

GET

/v1/contacts/{contactId}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`contactId`	i adressen	`string`	Ja	UUID
`companyId`	i spørringen	`string`	Nei	UUID
`profileId`	i spørringen	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`country`	`string \| null`	Ja
`email`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`name`	`string`	Ja
`note`	`string \| null`	Ja
`phone`	`string \| null`	Ja
`postalCode`	`string \| null`	Ja
`postalName`	`string \| null`	Ja
`profileId`	`string`	Ja	UUID
`street`	`string \| null`	Ja
`updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_not_found, profile_not_found
HTTP 422:company_required

PATCH

/v1/contacts/{contactId}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`contactId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`country`	`string \| null`	Nei
`email`	`string \| null`	Nei
`name`	`string`	Nei	1–200 tegn
`note`	`string \| null`	Nei
`phone`	`string \| null`	Nei
`postalCode`	`string \| null`	Nei
`postalName`	`string \| null`	Nei
`profileId`	`string`	Ja	UUID
`street`	`string \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`country`	`string \| null`	Ja
`email`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`name`	`string`	Ja
`note`	`string \| null`	Ja
`phone`	`string \| null`	Ja
`postalCode`	`string \| null`	Ja
`postalName`	`string \| null`	Ja
`profileId`	`string`	Ja	UUID
`street`	`string \| null`	Ja
`updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_not_found, profile_not_found
HTTP 409:contact_phone_taken
HTTP 422:company_required, contact_phone_invalid

DELETE

/v1/contacts/{contactId}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`contactId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`contactId`	`string`	Ja	UUID

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_not_found, profile_not_found
HTTP 422:company_required

Kontaktgrupper

GET

/v1/contact-groups

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`profileId`	i spørringen	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`groups`	`object[]`	Ja
`groups[].id`	`string`	Ja	UUID
`groups[].members`	`integer`	Ja
`groups[].name`	`string`	Ja
`groups[].profileId`	`string`	Ja	UUID
`groups[].updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/contact-groups

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`contactIds`	`string[]`	Nei	maks 1000 elementer
`name`	`string`	Ja	1–200 tegn
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`members`	`integer`	Ja
`name`	`string`	Ja
`profileId`	`string`	Ja	UUID
`updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_not_found, profile_not_found
HTTP 409:contact_group_name_taken
HTTP 422:company_required

DELETE

/v1/contact-groups/{groupId}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`groupId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`groupId`	`string`	Ja	UUID

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_group_not_found, profile_not_found
HTTP 422:company_required

POST

/v1/contact-groups/{groupId}/members

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`groupId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`contactIds`	`string[]`	Ja	1–1000 elementer
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`id`	`string`	Ja	UUID
`members`	`integer`	Ja
`name`	`string`	Ja
`profileId`	`string`	Ja	UUID
`updatedAt`	`string`	Ja	tidspunkt i ISO 8601

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:contact_group_not_found, contact_not_found, profile_not_found
HTTP 422:company_required

Import av kontakter

POST

/v1/contacts/import

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`columns`	`"name" \| "phone" \| "email" \| "street" \| "postalCode" \| "postalName" \| "country" \| "note" \| "skip"[]`	Nei	maks 50 elementer
`companyId`	`string`	Nei	UUID
`csv`	`string`	Ja	1–700000 tegn
`existing`	`"fill" \| "keep"`	Ja
`fileName`	`string`	Nei	maks 255 tegn
`group`	`string`	Nei	1–200 tegn
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`columns`	`object[]`	Ja
`columns[].field`	`"name" \| "phone" \| "email" \| "street" \| "postalCode" \| "postalName" \| "country" \| "note" \| "skip"`	Ja
`columns[].header`	`string`	Ja
`columns[].samples`	`string[]`	Ja
`created`	`integer`	Ja
`groupId`	`string \| null`	Ja
`groupName`	`string \| null`	Ja
`importId`	`string \| null`	Ja
`problems`	`object[]`	Ja
`problems[].problem`	`"name_missing" \| "phone_invalid" \| "email_invalid" \| "country_invalid" \| "cell_too_long" \| "phone_repeated"`	Ja
`problems[].row`	`integer`	Ja	minst 1
`rows`	`integer`	Ja
`skipped`	`integer`	Ja
`unchanged`	`integer`	Ja
`updated`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required, contact_import_invalid

POST

/v1/contacts/import/preview

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`columns`	`"name" \| "phone" \| "email" \| "street" \| "postalCode" \| "postalName" \| "country" \| "note" \| "skip"[]`	Nei	maks 50 elementer
`companyId`	`string`	Nei	UUID
`csv`	`string`	Ja	1–700000 tegn
`existing`	`"fill" \| "keep"`	Ja
`fileName`	`string`	Nei	maks 255 tegn
`group`	`string`	Nei	1–200 tegn
`profileId`	`string`	Ja	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`columns`	`object[]`	Ja
`columns[].field`	`"name" \| "phone" \| "email" \| "street" \| "postalCode" \| "postalName" \| "country" \| "note" \| "skip"`	Ja
`columns[].header`	`string`	Ja
`columns[].samples`	`string[]`	Ja
`created`	`integer`	Ja
`groupId`	`string \| null`	Ja
`groupName`	`string \| null`	Ja
`importId`	`string \| null`	Ja
`problems`	`object[]`	Ja
`problems[].problem`	`"name_missing" \| "phone_invalid" \| "email_invalid" \| "country_invalid" \| "cell_too_long" \| "phone_repeated"`	Ja
`problems[].row`	`integer`	Ja	minst 1
`rows`	`integer`	Ja
`skipped`	`integer`	Ja
`unchanged`	`integer`	Ja
`updated`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required, contact_import_invalid

Saldo

GET

/v1/balance

Viser saldoen: hva som er reservert, og hva du har tilgjengelig.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`availableOre`	`integer`	Ja	beløp i øre
`balanceOre`	`integer`	Ja	beløp i øre
`currency`	`"NOK"`	Ja
`paused`	`boolean`	Ja
`reservedOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

Forbruk

GET

/v1/usage

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`from`	i spørringen	`string`	Ja
`groupBy`	i spørringen	`"day" \| "service"`	Nei
`profile`	i spørringen	`string`	Nei	1–64 tegn
`to`	i spørringen	`string`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`from`	`string`	Ja
`groupBy`	`"day" \| "service"`	Ja
`lines`	`object[]`	Ja
`lines[].amountOre`	`integer`	Ja	beløp i øre
`lines[].day`	`string \| null`	Ja
`lines[].entries`	`integer`	Ja
`lines[].service`	`"sms" \| "email" \| "letters" \| "phone" \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`profileId`	`string \| null`	Ja
`to`	`string`	Ja
`totalOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required, period_invalid

Kontoutskrifter

GET

/v1/statements

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID
`month`	i spørringen	`string`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Ja	UUID
`csv`	`string`	Ja
`fileName`	`string`	Ja
`lines`	`object[]`	Ja
`lines[].amountOre`	`integer`	Ja	beløp i øre
`lines[].at`	`string`	Ja	tidspunkt i ISO 8601
`lines[].balanceAfterOre`	`integer`	Ja	beløp i øre
`lines[].day`	`string`	Ja	date
`lines[].description`	`string`	Ja
`lines[].kind`	`"top_up" \| "auto_top_up" \| "usage" \| "base_fee" \| "number_fee" \| "dedicated_setup" \| "dedicated_fee" \| "adjustment" \| "refund"`	Ja
`lines[].quantity`	`integer \| null`	Ja
`lines[].reference`	`string`	Ja
`totals`	`object`	Ja
`totals.adjustmentsOre`	`integer`	Ja	beløp i øre
`totals.closingOre`	`integer`	Ja	beløp i øre
`totals.entries`	`integer`	Ja
`totals.feesOre`	`integer`	Ja	beløp i øre
`totals.month`	`string`	Ja
`totals.open`	`boolean`	Ja
`totals.openingOre`	`integer`	Ja	beløp i øre
`totals.refundsOre`	`integer`	Ja	beløp i øre
`totals.topUpsOre`	`integer`	Ja	beløp i øre
`totals.usageOre`	`integer`	Ja	beløp i øre

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required, statement_month_invalid

Priser

POST

/v1/prices/preview

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`call`	`object`	Nei
`call.minutes`	`integer`	Nei	1–60
`call.recording`	`boolean`	Nei
`call.transcription`	`boolean`	Nei
`companyId`	`string`	Nei	UUID
`profile`	`string`	Nei	1–64 tegn
`profileId`	`string`	Nei	UUID
`sms`	`object`	Nei
`sms.sender`	`{ kind: "reply_number" } \| { kind: "text", name } \| { kind: "dedicated" }`	Nei
`sms.text`	`string`	Ja	1–2142 tegn
`tts`	`object`	Nei
`tts.text`	`string`	Ja	1–80000 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`call`	`{ lines, minutes, perMinuteOre, totalOre } \| null`	Ja
`sms`	`{ characters, priceOre, senderKind, unitPriceOre, units } \| null`	Ja
`totalOre`	`integer`	Ja	beløp i øre
`tts`	`{ characters, priceOre, unitPriceOre } \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:audio_text_too_long, company_required, sender_not_approved, sms_too_long

Grenser

GET

/v1/limits

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`callMinutesPerDay`	`object`	Ja
`callMinutesPerDay.isDefault`	`boolean`	Ja
`callMinutesPerDay.limit`	`integer`	Ja
`callMinutesPerDay.used`	`integer`	Ja
`companyId`	`string`	Ja	UUID
`day`	`string`	Ja	date
`legsAtOnce`	`object`	Ja
`legsAtOnce.isDefault`	`boolean`	Ja
`legsAtOnce.limit`	`integer`	Ja
`legsAtOnce.used`	`integer`	Ja
`outboundPaused`	`boolean`	Ja
`smsPerDay`	`object`	Ja
`smsPerDay.isDefault`	`boolean`	Ja
`smsPerDay.limit`	`integer`	Ja
`smsPerDay.used`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

Profiler

GET

/v1/profiles

Lister profilene til bedriften.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`profiles`	`object[]`	Ja
`profiles[].description`	`string \| null`	Ja
`profiles[].id`	`string`	Ja	UUID
`profiles[].monthlyLimitOre`	`integer \| null`	Ja
`profiles[].name`	`string`	Ja	maks 200 tegn
`profiles[].services`	`object`	Ja
`profiles[].services.email`	`boolean`	Ja
`profiles[].services.letters`	`boolean`	Ja
`profiles[].services.phone`	`boolean`	Ja
`profiles[].services.sms`	`boolean`	Ja
`profiles[].slug`	`string`	Ja	maks 64 tegn

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/profiles

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`description`	`string \| null`	Nei
`name`	`string`	Ja	1–200 tegn
`services`	`object`	Ja
`services.email`	`boolean`	Ja
`services.letters`	`boolean`	Ja
`services.phone`	`boolean`	Ja
`services.sms`	`boolean`	Ja
`slug`	`string`	Ja	1–64 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`description`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`monthlyLimitOre`	`integer \| null`	Ja
`name`	`string`	Ja	maks 200 tegn
`services`	`object`	Ja
`services.email`	`boolean`	Ja
`services.letters`	`boolean`	Ja
`services.phone`	`boolean`	Ja
`services.sms`	`boolean`	Ja
`slug`	`string`	Ja	maks 64 tegn

Avvisninger

HTTP 403:company_mismatch, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, service_not_open, staff_view_read_only
HTTP 409:slug_taken
HTTP 422:company_required, slug_invalid

GET

/v1/profiles/{slug}

Henter én profil.

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`slug`	i adressen	`string`	Ja	1–64 tegn
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`description`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`monthlyLimitOre`	`integer \| null`	Ja
`name`	`string`	Ja	maks 200 tegn
`services`	`object`	Ja
`services.email`	`boolean`	Ja
`services.letters`	`boolean`	Ja
`services.phone`	`boolean`	Ja
`services.sms`	`boolean`	Ja
`slug`	`string`	Ja	maks 64 tegn

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

PATCH

/v1/profiles/{slug}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`slug`	i adressen	`string`	Ja	1–64 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`description`	`string \| null`	Nei
`name`	`string`	Nei	1–200 tegn
`services`	`object`	Nei
`services.email`	`boolean`	Nei
`services.letters`	`boolean`	Nei
`services.phone`	`boolean`	Nei
`services.sms`	`boolean`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`description`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`monthlyLimitOre`	`integer \| null`	Ja
`name`	`string`	Ja	maks 200 tegn
`services`	`object`	Ja
`services.email`	`boolean`	Ja
`services.letters`	`boolean`	Ja
`services.phone`	`boolean`	Ja
`services.sms`	`boolean`	Ja
`slug`	`string`	Ja	maks 64 tegn

Avvisninger

HTTP 403:company_mismatch, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, service_not_open, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

POST

/v1/profiles/{slug}/archive

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`slug`	i adressen	`string`	Ja	1–64 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`profileId`	`string`	Ja	UUID
`revokedKeys`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 409:last_profile
HTTP 422:company_required

PUT

/v1/profiles/{slug}/limit

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`slug`	i adressen	`string`	Ja	1–64 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`limitOre`	`integer \| null`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`description`	`string \| null`	Ja
`id`	`string`	Ja	UUID
`monthlyLimitOre`	`integer \| null`	Ja
`name`	`string`	Ja	maks 200 tegn
`services`	`object`	Ja
`services.email`	`boolean`	Ja
`services.letters`	`boolean`	Ja
`services.phone`	`boolean`	Ja
`services.sms`	`boolean`	Ja
`slug`	`string`	Ja	maks 64 tegn

Avvisninger

HTTP 403:company_mismatch, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found
HTTP 422:company_required

API-nøkler

GET

/v1/api-keys

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`keys`	`object[]`	Ja
`keys[].createdAt`	`string`	Ja	tidspunkt i ISO 8601
`keys[].createdBy`	`string`	Ja	1–128 tegn
`keys[].id`	`string`	Ja	UUID
`keys[].keyId`	`string`	Ja
`keys[].last4`	`string`	Ja
`keys[].lastUsedAt`	`string \| null`	Ja
`keys[].mode`	`"live" \| "test"`	Ja
`keys[].name`	`string`	Ja
`keys[].profileId`	`string \| null`	Ja
`keys[].revokedAt`	`string \| null`	Ja
`keys[].scopes`	`"sms:send" \| "sms:read" \| "email:send" \| "email:read" \| "letters:send" \| "letters:read" \| "calls:write" \| "calls:read" \| "numbers:manage" \| "numbers:read" \| "agents:manage" \| "solutions:manage" \| "transcription:write" \| "transcription:read" \| "webhooks:manage" \| "events:read" \| "profiles:manage" \| "keys:manage" \| "contacts:manage" \| "usage:read"[] \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 422:company_required

POST

/v1/api-keys

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja	1–200 tegn
`profileId`	`string \| null`	Ja
`scopes`	`"sms:send" \| "sms:read" \| "email:send" \| "email:read" \| "letters:send" \| "letters:read" \| "calls:write" \| "calls:read" \| "numbers:manage" \| "numbers:read" \| "agents:manage" \| "solutions:manage" \| "transcription:write" \| "transcription:read" \| "webhooks:manage" \| "events:read" \| "profiles:manage" \| "keys:manage" \| "contacts:manage" \| "usage:read"[] \| null`	Nei

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`key`	`object`	Ja
`key.createdAt`	`string`	Ja	tidspunkt i ISO 8601
`key.createdBy`	`string`	Ja	1–128 tegn
`key.id`	`string`	Ja	UUID
`key.keyId`	`string`	Ja
`key.last4`	`string`	Ja
`key.lastUsedAt`	`string \| null`	Ja
`key.mode`	`"live" \| "test"`	Ja
`key.name`	`string`	Ja
`key.profileId`	`string \| null`	Ja
`key.revokedAt`	`string \| null`	Ja
`key.scopes`	`"sms:send" \| "sms:read" \| "email:send" \| "email:read" \| "letters:send" \| "letters:read" \| "calls:write" \| "calls:read" \| "numbers:manage" \| "numbers:read" \| "agents:manage" \| "solutions:manage" \| "transcription:write" \| "transcription:read" \| "webhooks:manage" \| "events:read" \| "profiles:manage" \| "keys:manage" \| "contacts:manage" \| "usage:read"[] \| null`	Ja
`secret`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, key_mode_exceeded, key_profile_required, key_scopes_exceeded, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:key_profile_not_found
HTTP 422:company_required

POST

/v1/api-keys/{apiKeyId}/revoke

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`apiKeyId`	i adressen	`string`	Ja	UUID

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`createdAt`	`string`	Ja	tidspunkt i ISO 8601
`createdBy`	`string`	Ja	1–128 tegn
`id`	`string`	Ja	UUID
`keyId`	`string`	Ja
`last4`	`string`	Ja
`lastUsedAt`	`string \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`name`	`string`	Ja
`profileId`	`string \| null`	Ja
`revokedAt`	`string \| null`	Ja
`scopes`	`"sms:send" \| "sms:read" \| "email:send" \| "email:read" \| "letters:send" \| "letters:read" \| "calls:write" \| "calls:read" \| "numbers:manage" \| "numbers:read" \| "agents:manage" \| "solutions:manage" \| "transcription:write" \| "transcription:read" \| "webhooks:manage" \| "events:read" \| "profiles:manage" \| "keys:manage" \| "contacts:manage" \| "usage:read"[] \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, key_mode_exceeded, key_profile_required, key_scopes_exceeded, live_key_required, manager_role_required, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:api_key_not_found
HTTP 422:company_required

Webhooks

GET

/v1/webhook-endpoints

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`endpoints`	`object[]`	Ja
`endpoints[].createdAtMs`	`integer`	Ja
`endpoints[].description`	`string \| null`	Ja
`endpoints[].disabled`	`boolean`	Ja
`endpoints[].ed25519PublicKey`	`string \| null`	Ja
`endpoints[].events`	`string[]`	Ja
`endpoints[].failing`	`boolean`	Ja
`endpoints[].id`	`string`	Ja	1–128 tegn
`endpoints[].lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`endpoints[].mode`	`"live" \| "test"`	Ja
`endpoints[].profileId`	`string \| null`	Ja
`endpoints[].revision`	`integer`	Ja
`endpoints[].url`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

POST

/v1/webhook-endpoints

Idempotency-Key

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`description`	`string \| null`	Nei
`ed25519`	`boolean`	Nei
`events`	"sms.status" \| "sms.received" \| "sms.optedOut" \| "sms.optedIn" \| "email.status" \| "email.received" \| "letter.status" \| "call.incoming" \| "call.answered" \| "call.ended" \| "call.participant.joined" \| "call.participant.left" \| "call.participant.updated" \| "call.command.completed" \| "call.command.failed" \| "call.command.uncertain" \| "call.offer.accepted" \| "call.offer.expired" \| "call.moved" \| "call.transferred" \| "call.recording.ready" \| "call.recording.failed" \| "call.transcript.ready" \| "call.dtmf.received" \| "call.gather.completed" \| "call.playback.ended" \| "call.machineDetected" \| "call.agent.ended" \| "call.summary.ready" \| "number.activated" \| "number.released" \| "number.order.failed" \| "transcription.job.completed" \| "transcription.job.failed" \| "transcription.session.ended" \| "balance.low" \| "limit.reached" \| "voicemail.received" \| "campaign.completed"[]	Ja	minst 1 elementer
`mode`	`"live" \| "test"`	Nei
`profileId`	`string \| null`	Nei
`url`	`string`	Ja	1–2048 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`endpoint`	`object`	Ja
`endpoint.createdAtMs`	`integer`	Ja
`endpoint.description`	`string \| null`	Ja
`endpoint.disabled`	`boolean`	Ja
`endpoint.ed25519PublicKey`	`string \| null`	Ja
`endpoint.events`	`string[]`	Ja
`endpoint.failing`	`boolean`	Ja
`endpoint.id`	`string`	Ja	1–128 tegn
`endpoint.lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`endpoint.mode`	`"live" \| "test"`	Ja
`endpoint.profileId`	`string \| null`	Ja
`endpoint.revision`	`integer`	Ja
`endpoint.url`	`string`	Ja
`publicKey`	`string \| null`	Ja
`secret`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

GET

/v1/webhook-endpoints/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`createdAtMs`	`integer`	Ja
`description`	`string \| null`	Ja
`disabled`	`boolean`	Ja
`ed25519PublicKey`	`string \| null`	Ja
`events`	`string[]`	Ja
`failing`	`boolean`	Ja
`id`	`string`	Ja	1–128 tegn
`lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`profileId`	`string \| null`	Ja
`revision`	`integer`	Ja
`url`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

PATCH

/v1/webhook-endpoints/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`description`	`string \| null`	Nei
`events`	"sms.status" \| "sms.received" \| "sms.optedOut" \| "sms.optedIn" \| "email.status" \| "email.received" \| "letter.status" \| "call.incoming" \| "call.answered" \| "call.ended" \| "call.participant.joined" \| "call.participant.left" \| "call.participant.updated" \| "call.command.completed" \| "call.command.failed" \| "call.command.uncertain" \| "call.offer.accepted" \| "call.offer.expired" \| "call.moved" \| "call.transferred" \| "call.recording.ready" \| "call.recording.failed" \| "call.transcript.ready" \| "call.dtmf.received" \| "call.gather.completed" \| "call.playback.ended" \| "call.machineDetected" \| "call.agent.ended" \| "call.summary.ready" \| "number.activated" \| "number.released" \| "number.order.failed" \| "transcription.job.completed" \| "transcription.job.failed" \| "transcription.session.ended" \| "balance.low" \| "limit.reached" \| "voicemail.received" \| "campaign.completed"[]	Nei	minst 1 elementer
`revision`	`integer`	Ja
`url`	`string`	Nei	1–2048 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`createdAtMs`	`integer`	Ja
`description`	`string \| null`	Ja
`disabled`	`boolean`	Ja
`ed25519PublicKey`	`string \| null`	Ja
`events`	`string[]`	Ja
`failing`	`boolean`	Ja
`id`	`string`	Ja	1–128 tegn
`lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`profileId`	`string \| null`	Ja
`revision`	`integer`	Ja
`url`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

DELETE

/v1/webhook-endpoints/{id}

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`removed`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

GET

/v1/webhook-endpoints/{id}/attempts

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`attempts`	`object[]`	Ja
`attempts[].attempt`	`integer`	Ja	minst 1
`attempts[].attemptedAtMs`	`integer`	Ja
`attempts[].delivered`	`boolean`	Ja
`attempts[].durationMs`	`integer \| null`	Ja
`attempts[].error`	`string \| null`	Ja
`attempts[].event`	`string`	Ja
`attempts[].eventId`	`string`	Ja
`attempts[].id`	`string`	Ja
`attempts[].status`	`integer \| null`	Ja
`attempts[].test`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

PUT

/v1/webhook-endpoints/{id}/ed25519

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`enabled`	`boolean`	Ja

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`endpoint`	`object`	Ja
`endpoint.createdAtMs`	`integer`	Ja
`endpoint.description`	`string \| null`	Ja
`endpoint.disabled`	`boolean`	Ja
`endpoint.ed25519PublicKey`	`string \| null`	Ja
`endpoint.events`	`string[]`	Ja
`endpoint.failing`	`boolean`	Ja
`endpoint.id`	`string`	Ja	1–128 tegn
`endpoint.lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`endpoint.mode`	`"live" \| "test"`	Ja
`endpoint.profileId`	`string \| null`	Ja
`endpoint.revision`	`integer`	Ja
`endpoint.url`	`string`	Ja
`publicKey`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

GET

/v1/webhook-endpoints/{id}/failed-deliveries

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn
`after`	i spørringen	`string`	Nei	maks 512 tegn
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`deliveries`	`object[]`	Ja
`deliveries[].attempts`	`integer`	Ja
`deliveries[].endpointId`	`string`	Ja	1–128 tegn
`deliveries[].event`	`string`	Ja
`deliveries[].eventId`	`string \| null`	Ja
`deliveries[].jobId`	`string`	Ja
`deliveries[].webhookId`	`string`	Ja
`next`	`string \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

POST

/v1/webhook-endpoints/{id}/failed-deliveries/{jobId}/replay

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn
`jobId`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`replayed`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

POST

/v1/webhook-endpoints/{id}/recover-failed

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`after`	`string`	Nei	maks 512 tegn
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`next`	`string \| null`	Ja
`replayed`	`integer`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

POST

/v1/webhook-endpoints/{id}/revive

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`createdAtMs`	`integer`	Ja
`description`	`string \| null`	Ja
`disabled`	`boolean`	Ja
`ed25519PublicKey`	`string \| null`	Ja
`events`	`string[]`	Ja
`failing`	`boolean`	Ja
`id`	`string`	Ja	1–128 tegn
`lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`mode`	`"live" \| "test"`	Ja
`profileId`	`string \| null`	Ja
`revision`	`integer`	Ja
`url`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

POST

/v1/webhook-endpoints/{id}/rotate-secret

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`endpoint`	`object`	Ja
`endpoint.createdAtMs`	`integer`	Ja
`endpoint.description`	`string \| null`	Ja
`endpoint.disabled`	`boolean`	Ja
`endpoint.ed25519PublicKey`	`string \| null`	Ja
`endpoint.events`	`string[]`	Ja
`endpoint.failing`	`boolean`	Ja
`endpoint.id`	`string`	Ja	1–128 tegn
`endpoint.lastAttempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`endpoint.mode`	`"live" \| "test"`	Ja
`endpoint.profileId`	`string \| null`	Ja
`endpoint.revision`	`integer`	Ja
`endpoint.url`	`string`	Ja
`secret`	`string`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

POST

/v1/webhook-endpoints/{id}/test

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	1–128 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`attempt`	`{ attempt, attemptedAtMs, delivered, durationMs, error, event, eventId, id, status, test } \| null`	Ja
`delivered`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused

Hendelser

GET

/v1/events

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`after`	i spørringen	`integer`	Nei
`companyId`	i spørringen	`string`	Nei	UUID
`limit`	i spørringen	`integer`	Nei	maks 200
`mode`	i spørringen	`"live" \| "test"`	Nei
`profile`	i spørringen	`string`	Nei	UUID
`types`	i spørringen	"sms.status" \| "sms.received" \| "sms.optedOut" \| "sms.optedIn" \| "email.status" \| "email.received" \| "letter.status" \| "call.incoming" \| "call.answered" \| "call.ended" \| "call.participant.joined" \| "call.participant.left" \| "call.participant.updated" \| "call.command.completed" \| "call.command.failed" \| "call.command.uncertain" \| "call.offer.accepted" \| "call.offer.expired" \| "call.moved" \| "call.transferred" \| "call.recording.ready" \| "call.recording.failed" \| "call.transcript.ready" \| "call.dtmf.received" \| "call.gather.completed" \| "call.playback.ended" \| "call.machineDetected" \| "call.agent.ended" \| "call.summary.ready" \| "number.activated" \| "number.released" \| "number.order.failed" \| "transcription.job.completed" \| "transcription.job.failed" \| "transcription.session.ended" \| "balance.low" \| "limit.reached" \| "voicemail.received" \| "campaign.completed"[]	Nei	maks 50 elementer

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`events`	`object[]`	Ja
`events[].data`	`Record<string, any>`	Ja
`events[].id`	`string`	Ja	starts_with, 36–36 tegn
`events[].mode`	`"live" \| "test"`	Ja
`events[].occurredAt`	`string`	Ja	tidspunkt i ISO 8601
`events[].position`	`integer`	Ja	minst 1
`events[].profileId`	`string \| null`	Ja
`events[].type`	`string`	Ja
`events[].version`	`integer`	Ja	minst 1
`floor`	`integer`	Ja
`head`	`integer`	Ja
`next`	`integer \| null`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:event_not_found, profile_not_found
HTTP 409:resume_too_old
HTTP 422:company_required

GET

/v1/events/{id}

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	starts_with, 36–36 tegn
`companyId`	i spørringen	`string`	Nei	UUID

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`data`	`Record<string, any>`	Ja
`id`	`string`	Ja	starts_with, 36–36 tegn
`mode`	`"live" \| "test"`	Ja
`occurredAt`	`string`	Ja	tidspunkt i ISO 8601
`position`	`integer`	Ja	minst 1
`profileId`	`string \| null`	Ja
`type`	`string`	Ja
`version`	`integer`	Ja	minst 1

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:event_not_found
HTTP 422:company_required

POST

/v1/events/{id}/redeliver

Idempotency-Key

Parametre

Parameter	Hvor	Type	Påkrevd	Merknad
`id`	i adressen	`string`	Ja	starts_with, 36–36 tegn

Felt i forespørselen (JSON)

Felt	Type	Påkrevd	Merknad
`companyId`	`string`	Nei	UUID
`endpointId`	`string`	Ja	1–128 tegn

Felt i svaret (data)

Felt	Type	Påkrevd	Merknad
`jobId`	`string`	Ja
`redelivered`	`boolean`	Ja

Avvisninger

HTTP 403:company_mismatch, membership_required, role_insufficient, scope_missing, staff_view_read_only
HTTP 404:event_not_found, profile_not_found, webhook_delivery_not_found, webhook_endpoint_not_found
HTTP 409:webhook_endpoint_conflict, webhook_endpoint_disabled
HTTP 422:company_required, webhook_endpoint_invalid, webhook_endpoint_url_refused, webhook_event_refused