Skip to content

REST methods object fields

The basic fields and their descriptions are listed here

To get the precise list of fields use:

  1. The /usr/local/FlashphonerWebCallServer/logs/server_logs/flashphoner.log file. This log file displays all REST queries sent to the backend server and all received answers

    13:39:39,893 INFO            RestClient - API-ASYNC-pool-13-thread-3 SEND REST OBJECT ==>
    URL:http://localhost:8081/apps/EchoApp/StreamStatusEvent
    OBJECT:
    {
      "nodeId" : "d2hxbqNPE04vGeZ51NPhDuId6k3hUrBB@95.191.130.39",
      "appKey" : "defaultApp",
      "sessionId" : "04cfeb85-cf9c-49aa-8144-022dfc0cdd0b",
      "mediaSessionId" : "c43a28b7-9a4d-45f8-a010-57b959a22755",
      "name" : "e6dcaedd-f084-49df-8262-7ce906e42eb2",
      "published" : true,
      "hasVideo" : true,
      "hasAudio" : true,
      "status" : "PUBLISHING",
      "audioCodec" : "PCMA",
      "videoCodec" : "VP8",
      "record" : false,
      "width" : 0,
      "height" : 0,
      "bitrate" : 0,
      "minBitrate" : 0,
      "maxBitrate" : 0,
      "quality" : 0,
      "history" : false,
      "gop" : 0,
      "fps" : 0,
      "audioBitrate" : 0,
      "codecImpl" : "",
      "transport" : "UDP",
      "cvoExtension" : false,
      "createDate" : 1664260776957,
      "mediaType" : "publish",
      "audioState" : {
        "muted" : false
      },
      "videoState" : {
        "muted" : false
      },
      "mediaProvider" : "WebRTC"
    }
    ...
    13:39:39,902 INFO            RestClient - API-ASYNC-pool-13-thread-3 RECEIVED REST OBJECT <==
    URL:http://localhost:8081/apps/EchoApp/StreamStatusEvent
    OBJECT:
    {
      "nodeId" : "d2hxbqNPE04vGeZ51NPhDuId6k3hUrBB@95.191.130.39",
      "appKey" : "defaultApp",
      "sessionId" : "04cfeb85-cf9c-49aa-8144-022dfc0cdd0b",
      "mediaSessionId" : "c43a28b7-9a4d-45f8-a010-57b959a22755",
      "name" : "e6dcaedd-f084-49df-8262-7ce906e42eb2",
      "published" : true,
      "hasVideo" : true,
      "hasAudio" : true,
      "status" : "PUBLISHING",
      "audioCodec" : "PCMA",
      "videoCodec" : "VP8",
      "record" : false,
      "width" : 0,
      "height" : 0,
      "bitrate" : 0,
      "minBitrate" : 0,
      "maxBitrate" : 0,
      "quality" : 0,
      "history" : false,
      "gop" : 0,
      "fps" : 0,
      "audioBitrate" : 0,
      "codecImpl" : "",
      "transport" : "UDP",
      "cvoExtension" : false,
      "createDate" : 1664260776957,
      "mediaType" : "publish",
      "audioState" : {
        "muted" : false
      },
      "videoState" : {
        "muted" : false
      },
      "mediaProvider" : "WebRTC"
    }
    

  2. The tcpdump utility to collect traffic dump and the Wireshark app to view it

    tcpdump tcp port 8081 -i lo -s 4096 -w log.pcap
    
    The above command records traffic that is sent to and received on the HTTP port 8081. Then, you can view results in Wireshark and see how the queries are sent exactly.