serviceStart
The serviceStart API is the primary API used to invoke your custom applications. Nimblevox receives the request, starts a phone line, and passes your request data to your application.
URL: https://api.nimblevox.com/serviceStart
Params:
| apiKey | Required | The apiKey associates the API call with your account. |
| serviceId | Required | The ID assigned to your application. |
| <args> | Optional | Any additional parameters required by your application can be passed through as a argument. These are accessed via the application using the variable reference @=args.{name}@. If sending in a phone number you would add phone=7208803421. This variable is accessed using @=args.phone@ |
Use this API key to start any nimblevox build service. Execute this HTTP POST request to:
https://api.nimblevox.com/serviceStart?apiKey=[your key]&serviceId=[nimblevox build service ID generated when you deployed your project]
If you need to pass variables to your service, add them to the request string.
Example CURL Command:
curl -v --request POST "https://api.nimblevox.com/serviceStart?apiKey=[your key]&serviceId=[service ID associated with your nimblevox build project]&[project variable name]=[project variable value]"
Example PHP Helper File: nimblevox.php
