Legacy Dev Forum Posts

 View Only

Sign Up

Determine WebRTC Phone Operational Status using Telephony Edge Providers API

  • 1.  Determine WebRTC Phone Operational Status using Telephony Edge Providers API

    Posted 06-05-2025 18:22

    Carson_Draper | 2022-06-28 20:32:39 UTC | #1

    Hello,

    I am trying to determine the operational status of each phone instance configured in Genesys cloud programmatically for a certain customer. (Similar to what is shown on the Admin>Telephony>Phone Management Page)

    Currently I am sending a GET to /api/v2/telephony/providers/edges/phones using the same query params as the cloud frontend does. While I am able to determine what state a hard phone is in, I am unable to determine which value in the response body indicates that the phone instance is "operational" for a webrtc phone instance.

    For the hard phone I can see that the indication of an operational phone instance is the status.operationalStatus, but this same value for a webrtc phone instance will be "OFFLINE" even though the cloud frontend states that it is "operational".

    Would the operational status of a webrtc phone be the status of the primary / secondary edge?

    If not then which value in the json response can I look at for each webrtc phone instance to know the operational status?

    Thank you for your time, Carson Draper


    John_Carnell | 2022-06-29 20:05:31 UTC | #2

    Hi Carson,

    I talked with the developers who owned the APIs. The API for phones covers both physical phones and WebRTC phones. The OperationalStatus flag on the API is only relevant to physical phones and not WEBRTC Phones. The API automatically sets all WebRTC phones to an offline status in the API and the UI always shows WEBRTC phones as online.

    Its odd and probably could have been implemented differently but here is why. A physical phone has to know the IP address of both its primary and secondary edges. Physical phones have to be able to "heartbeat" with the primary edge server and when a physical phone no longer is able to heartbeat with an edge the edge will mark the phone as being offline.

    WebRTC phones are just configuration. They dont have a physical presence tied to a specific edge. Every edge in the cluster essentially knows about the phone. Thus there is no reason for an operational status because the WebRTC phones will never heartbeat to an edge server.

    I hope that helps.

    Thanks, John Carnell Manager, Developer Engagement


    Carson_Draper | 2022-06-29 20:05:26 UTC | #3

    Hi John,

    Thank you for your detailed answer. I'll mark your response as the solution.

    Have a nice day, Carson Draper


    system | 2022-07-30 20:05:41 UTC | #4

    This topic was automatically closed 31 days after the last reply. New replies are no longer allowed.


    This post was migrated from the old Developer Forum.

    ref: 15330