Skip to main content
POST

Authorizations

Authorization
string
header
required

your rumik api key, e.g. rk_live_.... create one in the rumik dashboard.

Body

application/json

the body of POST /v1/calls.

agentId
string
required

the agent to run — its UUID or its ua_… handle. it must be deployed and use a voice that can take calls.

Required string length: 1 - 64
toNumber
string
required

the number to dial, in E.164 (+ and 7–15 digits; spaces tolerated).

fromNumber
string | null

the caller id, as one of your numbers: a SIP trunk's number, or a rented number that is active and connected to this agent. omit to use the agent's connected rented number, or the platform's number.

fromTrunkId
string<uuid> | null

dial from this SIP trunk (its id). wins over fromNumber.

callSettings
AgentCallSettings · object | null

call behaviour for this one call. omit to use the agent's stored settings.

Response

accepted — the call is being placed.

Ack that the call is being placed. callId is the run id — the row GET /v1/calls/{id} and the dashboard's conversations show.

callId
string<uuid>
required

the call's id. what GET /v1/calls/{call_id} and the dashboard's conversations show; store it to correlate the call with your own records.

status
string
required

always calling: the dial was accepted. follow the call by id.

agentId
string<uuid>
required

the agent's UUID.

toNumber
string
required

the number dialed, normalised to E.164.

fromNumber
string | null

the caller id the callee sees; null when the platform's shared number was used.