The IVR Action Start Web Service is called when the caller enters the IVR to validate the customer account-id A Call-Flow is returned by the Web Service. This interface could only be accessed by the IVR host. All other access will be blocked. IP whitelisting will ensure only traffic from the merchant backend could access this endpoint. The interface provided is an HTTP POST request containing XML content and XML response. The access\_token obtained via the Authentication API will need to be supplied in the header as an Authorization key value, preceded by the word Bearer. **HTTP Request**\ POST https://[ivr-host-env]/ivr/v1/actionStart ### Request body

Name	Type	Mandatory	Description	Comment
traceId	string(100)	yes	This will be the ZCC PABX Reference number associated with the call. The Trace id must be globally unique across all transactions contain only alphanumeric characters, hyphens and underscores, and have a length less than 100 characters
mobileNumber	numeric(11)	yes	This is the 11-digit CLID of the caller. The format will be country code + mobile number	Example: 61412777555
DDI	string(20)	yes	The incoming DDI of the caller.	Example: 444
IVRHost	string(64)	yes	The IVR host that the script is running from

### Request headers | Parameter | Mandatory | Description | | :------------ | :-------- | :-------------------------------------------------------------------------------------------------------------------------------- | | Content-Type | yes | application/xml | | Authorization | yes | Bearer Access-web-ivr-oauth-token (Refer [Authentication](https://developers.health.afterpay.com/reference/authentication-token)) | ***Sample Example*** ```shell curl curl -v -X POST 'https:///ivr/v1/actionStart' \ -H "Content-Type: application/xml" \ -H "Authorization: Bearer lkgheflkjjdafkjfkjfkhgdddjhdljgkjlfljkkjasdlkjdffkj" \ -d ' Testflexplus12 61465376450 444 abc ' ``` ### Response body

Name	Type	Mandatory	Description	Comment
traceId	string(100)	yes	This will be the ZCC PABX Reference number associated with the call. The Trace id must be globally unique across all transactions contain only alphanumeric characters, and have a length less than 100 characters
errorGroup	Numeric	yes	This number indicates occurrence of an error and the type of error that has occurred. 0 = Success\ 1 = Transient gateway error - Try again later 5 = Transaction breached velocity rules\ 99 = Other unspecified error
callflow	xml	yes	the callflow for the call	will contain empty on error

***Sample Example*** ```shell Status: 200 OK ``` ```json Testflexplus12 0 Welcome_Optus ```

200200

400400