Send a test offer to an app destination

Sends a sample transfer.offer webhook (fake caller, "test": true), signed like a real one, and reports how your server answered. Test offers cannot be accepted. The delivery is logged. At most 5 test sends per destination per minute and 30 per account per hour.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"

Destination ID

Response

Delivery result

deliveryIdstringformat: "uuid"

Unique id of the delivery (deliveryId in the body, Talkif-Delivery-Id header)

durationMslong

Time until the response, in milliseconds

errorstring or nullOptional

Why the delivery did not ring: No response within 3 s, Could not connect, Blocked address, TLS error, HTTP <status> or Delivery is unavailable; null after a 2xx answer

statusCodeinteger or nullOptional>=0

HTTP status your server answered with (null when no response arrived)

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error