The Voice APIs enable you to create and update a voice application and fetch After Call Work (ACW) details for a specific case, user, and work type.
| Operation | Method | Endpoint |
|---|---|---|
| Create Voice Application | POST | /api/v3/voice/application |
| Update Voice Application | PUT | /api/v3/voice/application?appId={appId} |
| Fetch ACW Details | GET | /api/v3/voice/acw?caseNumber={caseNumber}&userId={userId}&workType={workType} |
https://api3.sprinklr.com/{env}/api/v3Voice application resource:
https://api3.sprinklr.com/{env}/api/v3/voice/applicationACW resource:
https://api3.sprinklr.com/{env}/api/v3/voice/acwReplace {env} with the environment identifier assigned to your Sprinklr workspace. Keep the base URL as a configuration value so that moving between environments does not require code changes.
| Key | Value | Description |
|---|---|---|
| Authorization | Bearer {token} | Credential used by the API to authenticate a user with the server. |
| Key | api-key | API key used to authenticate the application with the server. |
| Content-Type | application/json | Determines the media type of the request body. |
| Accept | application/json | Determines the acceptable response type from the server. |
POST /api/v3/voice/application
Use this API to create a voice application for inbound and outbound voice interactions.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| provider | Required | Voice provider associated with the application. | String |
| name | Required | Name of the voice application. | String |
| phoneNumber | Required | Phone number associated with the voice application. | String |
| voiceAccountId | Required | Unique identifier of the voice account. | String |
| description | Optional | Description of the voice application. | String |
| country | Optional | Country associated with the voice application. | String |
| dndCheckRequired | Optional | Indicates whether DND checks are required. | Boolean |
| dtmfTimeoutSeconds | Optional | Timeout in seconds for DTMF input collection. | Integer |
| speechTimeoutSeconds | Optional | Timeout in seconds for speech input collection. | Integer |
| externalCaseUrlTemplate | Optional | URL template used for external case creation or lookup. | String |
| ivrProcessId | Optional | Unique identifier of the associated IVR process. | String |
| supervisorEligibleForAcwOnBargeIn | Optional | Indicates whether supervisors are eligible for after-call work on barge-in. | Boolean |
| callerIds | Optional | List of caller IDs associated with the application. | String |
| callEventWorkflowIvrId | Optional | Unique identifier of the call-event workflow IVR process. | String |
| outboundWaitMessage | Optional | Message played while outbound calls wait to be connected. | String |
| providerDomain | Optional | Domain associated with the configured voice provider. | String |
curl -X POST \
'https://api3.sprinklr.com/{env}/api/v3/voice/application' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"provider": "SPRINKLR",
"name": "Customer Support Voice Application",
"phoneNumber": "+1234567890",
"voiceAccountId": "{voiceAccountId}",
"description": "Voice application for customer support operations",
"country": "US",
"dndCheckRequired": false,
"dtmfTimeoutSeconds": 5,
"speechTimeoutSeconds": 5,
"externalCaseUrlTemplate": "{externalCaseUrl}",
"ivrProcessId": "{ivrProcessId}",
"supervisorEligibleForAcwOnBargeIn": false,
"callerIds": "+123,+456,+789",
"callEventWorkflowIvrId": "{callEventWorkflowIvrId}",
"outboundWaitMessage": "Outbound wait message",
"providerDomain": "{providerDomain}"
}'{
"data": {
"provider": "SPRINKLR",
"name": "Customer Support Voice Application",
"phoneNumber": "+1234567890",
"voiceAccountId": "665d604053e7f3411f9b79e7",
"description": "Voice application for customer support operations",
"country": "US",
"dndCheckRequired": ["false"],
"dtmfTimeoutSeconds": 5,
"speechTimeoutSeconds": 5,
"externalCaseUrlTemplate": "{externalCaseUrl}",
"ivrProcessId": "{ivrProcessId}",
"supervisorEligibleForAcwOnBargeIn": false,
"callerIds": ["+123,+456,+789"],
"callEventWorkflowIvrId": "{callEventWorkflowIvrId}",
"providerDomain": "{providerDomain}"
},
"errors": []
}PUT /api/v3/voice/application?appId={appId}
Use this API to update an existing voice application.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| appId | Required | Unique identifier of the voice application to update. | String |
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| name | Optional | Updated name of the voice application. | String |
| phoneNumber | Optional | Updated phone number associated with the application. | String |
| voiceAccountId | Optional | Unique identifier of the associated voice account. | String |
| country | Optional | Country associated with the voice application. | String |
curl -X PUT \
'https://api3.sprinklr.com/{env}/api/v3/voice/application?appId={appId}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"name": "Updated Customer Support Voice Application",
"phoneNumber": "+1234567890",
"voiceAccountId": "{voiceAccountId}",
"country": "US"
}'HTTP/1.1 204 No ContentThe API does not return a response body following successful execution.
| Parameter | Description | Type |
|---|---|---|
| HTTP Status Code | Indicates the result of the update operation. | Integer |
| 204 No Content | The voice application was successfully updated. | Status Code |
GET /api/v3/voice/acw?caseNumber={caseNumber}&userId={userId}&workType={workType}
Use this API to fetch After Call Work details for a specific case, user, and work type.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| caseNumber | Required | Unique case number associated with the interaction. | String |
| userId | Required | Unique identifier of the user for whom ACW details are requested. | String |
| workType | Required | Type of work associated with the interaction. | String |
curl -X GET \
'https://api3.sprinklr.com/{env}/api/v3/voice/acw?caseNumber={caseNumber}&userId={userId}&workType={workType}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'{
"data": [
{
"id": "6a74cef9e64249b035bca4ae_SPR_TASK_66007863",
"acwId": "b6c9ef25-353d-4e98-a1bf-8c73df757a95",
"status": "IN_PROGRESS",
"timedOut": true,
"acwTriggeredAt": 1786040073945,
"type": "MANDATORY_TIME_BOUND",
"timeOutAfter": 10000,
"userId": "66007863",
"workType": "SPR_TASK",
"workId": "6a74cef9e64249b035bca4ae",
"conversationId": "6a74cef9e64249b035bca4ae",
"resolvedValues": {}
}
],
"errors": []
}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains ACW details associated with the request. | Array | |
| id | Unique identifier of the ACW record. | String | |
| acwId | Unique identifier of the ACW configuration. | String | |
| status | Current status of the ACW record. | String | |
| timedOut | Indicates whether the ACW record timed out. | Boolean | |
| acwTriggeredAt | Timestamp indicating when ACW was triggered. | Epoch | |
| type | Type of ACW configuration. | String | |
| timeOutAfter | Duration after which ACW times out. | Integer | |
| userId | Unique identifier of the assigned user. | String | |
| workType | Type of work associated with the ACW record. | String | |
| workId | Unique identifier of the work item. | String | |
| conversationId | Unique identifier of the conversation. | String | |
| resolvedValues | Contains resolved ACW configuration details. | Object | |
| resolvedValues | acw | Map containing ACW configuration details. | Object |
| acw | process | Process associated with the ACW configuration. | Object |
| acw | inputForm | Input form associated with the ACW configuration. | Object |
| acw | outputForm | Output form associated with the ACW configuration. | Object |
| acw | dynamicFields | Dynamic fields associated with the ACW configuration. | Array |
| acw | flavourDetails | Additional ACW configuration details. | Object |
| acw | shareConfigs | Sharing configurations associated with ACW. | Array<Object> |
| acw | grants | Access grants associated with the ACW configuration. | Array<String> |
| errors | Contains errors encountered during request processing, if any. | Array |
The Voice Application APIs can be used to create and maintain voice applications for inbound and outbound voice interactions and retrieve After Call Work (ACW) details associated with an interaction. The following are common use cases.
Use the Create Voice Application API to create a voice application and associate it with a voice provider, phone number, and voice account.
This is useful when:
- A new voice application needs to be provisioned for inbound or outbound voice interactions.
- A phone number needs to be associated with a specific voice application.
- A voice application needs to be associated with a specific voice account and provider.
- Voice applications need to be created programmatically as part of an automated configuration workflow.
API: POST /api/v3/voice/application
Use the Create Voice Application API to configure additional behavior for a voice application, including IVR processes and voice input settings.
This is useful when:
- A voice application needs to be associated with an IVR process using
ivrProcessId. - A call-event workflow needs to be associated with the application using
callEventWorkflowIvrId. - DTMF input collection needs to use a configured timeout.
- Speech input collection needs to use a configured timeout.
- An outbound wait message needs to be configured for calls waiting to be connected.
API: POST /api/v3/voice/application
Use the Create Voice Application API to configure DND behavior and caller IDs for a voice application.
This is useful when:
- DND checks need to be enabled or disabled for the voice application.
- One or more caller IDs need to be associated with the application.
- Voice application configuration needs to include provider-specific information such as the provider domain.
These settings can be supplied using fields such as dndCheckRequired, callerIds, and providerDomain.
API: POST /api/v3/voice/application
Use the Create Voice Application API to associate an external case URL template with a voice application.
This is useful when:
- Voice interactions need to be linked with an external case management workflow.
- An external case needs to be created or looked up using a configured URL template.
The external case integration can be configured using externalCaseUrlTemplate.
API: POST /api/v3/voice/application
Use the Update Voice Application API to modify an existing voice application's configuration.
This is useful when:
- The name of an existing voice application needs to be changed.
- The phone number associated with the application needs to be updated.
- The application needs to be associated with a different voice account.
- The country associated with the voice application needs to be updated.
The voice application is identified using its unique appId.
API: PUT /api/v3/voice/application?appId={appId}
Use the Fetch ACW Details API to retrieve After Call Work information associated with a specific case, user, and work type.
This is useful when:
- An integration needs to determine the current ACW status for an interaction.
- An application needs to determine whether ACW has timed out.
- The time at which ACW was triggered needs to be retrieved.
- The ACW type and configured timeout duration need to be determined.
- ACW information needs to be correlated with a user, work item, or conversation.
The request identifies the ACW context using caseNumber, userId, and workType.
API: GET /api/v3/voice/acw?caseNumber={caseNumber}&userId={userId}&workType={workType}
Use the Fetch ACW Details API to retrieve resolved configuration information associated with After Call Work.
This is useful when:
- An application needs to retrieve the ACW process configuration associated with an interaction.
- Input or output form configuration needs to be obtained.
- Dynamic fields associated with ACW need to be processed.
- Additional ACW configuration and sharing information needs to be retrieved.
The resolvedValues response can contain ACW configuration information such as process, inputForm, outputForm, dynamicFields, flavourDetails, shareConfigs, and grants.
API: GET /api/v3/voice/acw?caseNumber={caseNumber}&userId={userId}&workType={workType}
The Voice Application APIs can be incorporated into configuration and integration workflows to manage voice applications programmatically.
A typical workflow can include:
- Create the voice application using
POST /api/v3/voice/application. - Configure the required voice provider, phone number, voice account, IVR, and other supported settings.
- Retain the application's unique
appIdfor subsequent configuration changes. - Update the voice application using
PUT /api/v3/voice/application?appId={appId}when supported application details change. - Fetch ACW details using
GET /api/v3/voice/acwwhen an integration needs After Call Work information for a specific case, user, and work type.