Calls Resources

Call Collection

/comms/v1/calls{format}?QueryParams

POST: YES - Create a new call in the collection. So you establish a new outbound call.

Request
Response

Query Parameters

None
Body (JSON or XML)

callerId

MANDATORY

It has to be one of your BlueVia Voice numbers

destination

MANDATORY

Any telephone number that can accept a voice call.

callbackUrl

This is optional and can be used to provide a call specific callback URL different from the one configured against your BlueVia Number. If specified BlueVia will make a POST request to this URL, for this call only, for the Answered in call event notification

fallbackUrl

This is optional and can be used to provide a different fallback URL, for this call only, compared to the one configured against your BlueVia number. In the event that the callbackUrl used on this call is not reachable, BlueVia will make a POST request to this URL, for this call only, for the CallbackUnavailable in call event notification
- JSON (example):
```
      
{
  "callerId": "tel:+34666666666",
  "destination": "tel:+34677777777",
  "callbackUrl": "http://developer.app.com",
  "fallbackUrl": "http://developer.app.com/fail"
}
      
```
- XML example:
```
      
@todo
      
```
- CURL example:
```
      
curl -k -H "Accept: application/json" -H "Content-type: application/json" --user <your API key>:<your API secret> -X POST -d '{"callerId":"tel:+<country code><your BlueVia Voice Number>","destination":"tel:+<country code><the number you wish to call>"}' https://live-api-nv.bluevia.com:10443/comms/v1/calls  
      
```

Successful response:

HTTP Response: 201 Created
Headers
- Location (mandatory): Includes the URI pointing to the created resource (an Outbound Call)
- https://{host}/comms/v1/calls/{callId}
Body:
- The response includes a JSON or an XML body:
- JSON example:
```
      
{
  "callId": "23481-apdifjap-dpifje-18403"
}
```
- XML example
```
      
@todo get one
```
- CURL example:
```
      
@todo get one
      
```
Error response:

Consists of an HTTP Error response together with a code and an explanatory text. Possible errors are those applicable among the errors described in BlueVia Voice Error Codes.

GET: YES; NOTE: not available during the alpha period

PUT: NOT ALLOWED

DELETE: NOT ALLOWED