Jump to content

TuCloudAPI resendadminuseremail

From Wiki 7Kas

TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.

ℹ Requires the pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.

Description

Mail again the link of the user's open email change (the invitation of an invited user, or a change), pending or expired, with a fresh 24 hours; the previous link is then ignored. Refused with reason none (not_found) when nothing is open, and rate_limited as addadminuser. When magiclogin cannot send, nothing changes (auth_unavailable). Requires a non-readonly ukey.

Call

https://tucloudapi.7kas.com:9087/tucloud?func=resendadminuseremail&ukey=YOUR_KEY&pbx=PBX_NAME

GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.

Parameters

Parameter Type Required Default Meaning
pbx string Yes — FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX and scopes every admin user to it.
login string Yes — The user's _id (login). A new user's is generated by the server and never shown.

Example

https://tucloudapi.7kas.com:9087/tucloud?func=resendadminuseremail&ukey=KEY&pbx=tucall&login=u0123456789abcdef

Response

{ok:true, status:"pending", email, expires_in} | {ok:false, code, field:"email", reason, message}.

Errors

Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.


Back to TuCloudAPI