Account Management Resources

Account Number

URI /comms/v1/me/numbers/{number}{format}
POST
YES - supported in alpha 
  • You can invoke a POST request to update the detail associated with the specified number on your account. This will allow you to update the configuration associated with your BlueVia Voice Number. This information can also be managed on your BlueVia Dashboard. This allows you to specify the set of URL’s that will handle Voice callback and fallback functionality. You can also specify the format you wish to receive in call notification - either JSON or XML
  • HTTP Method
    POST
  • Query Parameters
    None
  • Body (JSON or XML)
    callbackUrl
    this is the callback URL you wish to assign to your number. This can also be set in the BlueVia Dashboard
    fallbackUrl
    this is the fallback URL you wish to assign to the your number. Again this can also be done in the BlueVia Dashboard
  • Example
    JSON 
    {
	"notificationFormat": "JSON"
	"callbackUrl": "http://newurl1.com",
	"fallbackUrl": "http://newurl2.com",
}

    XML

    @TODO
    CURL 
    curl -k -H "Accept: application/json" -H "Content-type: application/json" --user <your API Key>:<your API Secret> -X POST -d '{"notificationFormat": "<JSON|XML>", "voiceCallbackUrl": "<your callback URL>","voiceFallbackUrl":"<your fallback URL>"}' https://live-api-nv.bluevia.com:10443/comms/v1/me/numbers/tel:%2B<country code><BlueVia Voice Number>
  • Successful response
    HTTP Response
    200 OK.
    Body
    The response does not include a body
  • 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
  • You can invoke a GET to this resource to request the configuration detail for the specified {number} on your account
  • NOTE: Further detail of this method will be provided when delivered.
PUT
YES
NOTE - not available during the alpha period
  • You can invoke a PUT to this resource which in effect purchases a BlueVia Voice Number and adds this to your account. Using this method also allows you to specify the configuration or the number you are purchasing. Available numbers can be retrieved using the GET operation for the Available Numbers Collections
  • NOTE: Further detail of this method will be provided when delivered.
DELETE
YES
NOTE - not available during the alpha period
  • Using DELETE on this resource releases the specified BlueVia Voice Number ({number}) from your account.
  • NOTE: Further detail of this method will be provided when delivered.