Authenticated browser API operations
Understand the logged-in state, directory, live, session, initiate, action, history, missed-read and presence operations and their method/permission rules.
xConnect
Open guide →GuideUnderstand authenticated API context
Resolve either an authenticated administrator or client-contact context before returning phone data.
Open guide →GuideUnderstand administrator calling permission
Require Use internal calling for administrator API operations.
Open guide →GuideRead current phone state
Use the GET state operation to load settings, extension, active incoming call and API URLs.
Open guide →GuideSearch the directory API
Use GET with q and optional limit; default limit is 20.
Open guide →GuideRead the Live now API
Use GET with optional limit; default limit is 100.
Open guide →GuideCreate a browser SIP session
Use POST to receive the current authorised browser session credentials.
Open guide →GuideInitiate an internal call
Use POST with extension to request an authorised call.
Open guide →GuideRecord a call action
Use POST with call UUID, supported action and optional reason.
Open guide →GuideRead call history
Use GET with optional limit; default limit is 25.
Open guide →GuideMark missed calls read
Use POST with an array or JSON-encoded list of call UUIDs.
Open guide →GuideUpdate authenticated presence
Use POST with online true/false values.
Open guide →GuideRespect HTTP method restrictions
Use only the required GET or POST method; invalid methods return method-not-allowed.
Open guide →GuideInclude current CSRF evidence
Use the returned/current CRM CSRF token for state-changing authenticated requests.
Open guide →GuideHandle authentication-required responses
Prompt the user to sign in when the API returns 401.
Open guide →GuideHandle permission or tenant-isolation responses
Do not retry around a 403; correct permission or ownership.
Open guide →GuideHandle validation responses
Correct extension, call action or request values after a 422 response.
Open guide →GuideHandle rate-limit responses
Wait and reduce request frequency after a 429 response.
Open guide →GuideHandle voice-engine unavailable responses
Restore gateway readiness before retrying a 503 response.
Open guide →