Request Response Example

The following JSON provides an example request to make a call to 1234@sipphone.example.com and run a specific application

  
        {
          "action": "makeCall",
          "to": "sip:1234@sipphone.example.com",
          "apiKey": "de7db776-b14d-4784-a1d4-624925bad3fe"
        }
    

Assuming the above is saved as /opt/blueworx/makeCall.json, then as an example the following curl command can be used to request the BRM to process the request:

  
        curl --header  "Content-Type: application/json" --request POST --data '@/opt/blueworx/makeCall.json' http://mybrm.example.com:9698/api/v1/bvr/outbound 
    

If the call is answered then a typical example response would be

  
        {
          "result": "Call connected",
          "applicationUUID": "77989df0-fe66-4a29-a79e-909efd9721d5",
          "headers": {
            "Call-ID": "0.0.48CF9C6E70210BC0@mybvr.example.com",
            "CSeq": "1 INVITE",
            "User-Agent": "XXXXXXX",
            "From": "<sip:bvr@mybvr.example.com>;tag=1.1.3241D27D4DBEF235",
            "To": "<sip:1234@sipphone.example.com>;tag=bd65e453",
              "Content-Length": "187",
              "Contact": "1234 <sip:1234@sipphone.example.com:5060;transport=udp>",
              "Content-Type": "application/sdp",
              "Via": "SIP/2.0/UDP 1.2.3.4:5060;branch=z9hG4bK-441-1.0"
             }
         }