Skip to main content
POST
Create handoff link

Authorizations

Authorization
string
header
required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string<uuid>
required

The tenant the handoff link is issued for.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
destinationPluginConnectionID
string
required

Plugin connection of the channel the contact should move to.

Minimum string length: 1
sourceSessionID
string
required

Session the contact is currently talking on.

Minimum string length: 1
expiresInSeconds
integer

How long the link stays redeemable. Defaults to 24h.

Required range: 300 <= x <= 604800

Response

Response for status 201.