API Reference
Dialer

Keep the session alive

POST
/v1/dialer/campaigns/{id}/sessions/{sid}/heartbeat

Tells the platform the client behind the session is still there. Call it every 30 seconds while the softphone or console is open. A session with no heartbeat (and no ready or pause) for five minutes leaves on its own and the extension returns to inbound ringing, except while it is on a call; a ready session silent for 90 seconds is not offered a customer. A session that has already left answers 409 dialer.invalid_state: join again.

Authorization

bearerAuth
AuthorizationBearer <token>

Long-lived ES256 JWT minted from the dashboard (https://app.sautikit.com/developers/api-keys). Signed by the platform keyring. Carries workspace_id and scopes claims; revoked via the platform deny-list.

In: header

Path Parameters

id*string
Formatuuid
sid*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/dialer/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/sessions/497f6eca-6276-4993-bfeb-53cbbbba6f08/heartbeat"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",  "extension_id": "string",  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",  "state": "ready",  "reserved_contact_id": "2acb98b6-7d4a-4834-97d1-92a6097fa7cd",  "reserved_until": "2019-08-24T14:15:22Z",  "last_ready_at": "2019-08-24T14:15:22Z",  "joined_at": "2019-08-24T14:15:22Z",  "left_at": "2019-08-24T14:15:22Z",  "last_seen_at": "2019-08-24T14:15:22Z",  "pause_requested": true}
{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ],    "resolution": "string",    "reason": "invalid_characters",    "suggested_e164": "+254727524723"  }}
{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ],    "resolution": "string",    "reason": "invalid_characters",    "suggested_e164": "+254727524723"  }}
{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ],    "resolution": "string",    "reason": "invalid_characters",    "suggested_e164": "+254727524723"  }}
{  "error": {    "code": "validation.bad_request",    "message": "string",    "request_id": "string",    "details": [      "string"    ],    "resolution": "string",    "reason": "invalid_characters",    "suggested_e164": "+254727524723"  }}

Stop taking calls POST

Stops new contacts coming to the session; the extension stays in the campaign. While a contact is reserved or on a call the pause is recorded and applied when the call ends: the response is `200` with the session unchanged and `pause_requested: true`. `.../ready` cancels a pending pause.

Leave the campaign POST

Closes the session from any state and returns the extension to inbound ringing. Repeating it returns the closed session.