v1

latestOpenAPI 3.1.02026-07-14330101.9 KB

Request Link - OTP Link

GLOBAL means system will randomize the channel to send or receive the message from or to the user. This approach will need the Global Token instead of Channel Token. The Request OTP Link endpoint enables users to obtain an authentication link for initiating a chat with a specified channel. When the user interacts with the link, the channel responds with a message, which may include another link or additional instructions. This endpoint also triggers a callback to a provided URL to verify whether the user's prompt or phone number is correct, returning a success or failure status based on the validation.

post/otp/link/global

Request body

contact_idstring required
expiresinteger required

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": {
    "id": "9cf60657-4aba-45f5-ba6c-b638dd57e38c",
    "code": "FTzKeD",
    "contact_id": "6281357541789@c.us",
    "link": "https://wa.me/14064793566?text=Give+me+link+to+login+at+TARGET+App+%2AFTzKeD%2A",
    "expired_at": "2024-09-08T14:43:42.718680Z",
    "timestamp": "2024-09-08T14:13:42.000000Z"
  }
}