Skip to navigation
API ReferenceTransfers

Create a destination group

A destination group is a named set of destinations that ring together as one transfer target. With the simultaneous strategy every member rings at once and the first to answer is connected.

Authentication

AuthorizationBearer

Pass a JWT access token or an API key (prefixed with tif_live_) as a Bearer token.

Request

This endpoint expects an object.
memberslist of objectsRequired

1–10 destinations of this account, in ring order.

namestringRequired

Display name, unique per account (1–100 characters).

strategystring or nullOptional

simultaneous (default): ring every member at once, first to answer wins.

totalTimeoutSecsinteger or nullOptional>=0

Upper bound for the whole attempt, 5–60 seconds. Default 30.

Response

Destination group created
createdAtdatetime
idstringformat: "uuid"
memberslist of objects
namestring
strategystring
totalTimeoutSecsinteger
updatedAtdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error