Skip to content
Last updated

Voice Application API V3 - Developer Guide

1. Overview

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.

OperationMethodEndpoint
Create Voice ApplicationPOST/api/v3/voice/application
Update Voice ApplicationPUT/api/v3/voice/application?appId={appId}
Fetch ACW DetailsGET/api/v3/voice/acw?caseNumber={caseNumber}&userId={userId}&workType={workType}

2. Base URL and environment

https://api3.sprinklr.com/{env}/api/v3

Voice application resource:

https://api3.sprinklr.com/{env}/api/v3/voice/application

ACW resource:

https://api3.sprinklr.com/{env}/api/v3/voice/acw

Replace {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.

3. Authentication and common headers

KeyValueDescription
AuthorizationBearer {token}Credential used by the API to authenticate a user with the server.
Keyapi-keyAPI key used to authenticate the application with the server.
Content-Typeapplication/jsonDetermines the media type of the request body.
Acceptapplication/jsonDetermines the acceptable response type from the server.

4. API operations

4.1 Create a voice application

POST /api/v3/voice/application

Use this API to create a voice application for inbound and outbound voice interactions.

Request parameters

ParameterRequired/OptionalDescriptionType
providerRequiredVoice provider associated with the application.String
nameRequiredName of the voice application.String
phoneNumberRequiredPhone number associated with the voice application.String
voiceAccountIdRequiredUnique identifier of the voice account.String
descriptionOptionalDescription of the voice application.String
countryOptionalCountry associated with the voice application.String
dndCheckRequiredOptionalIndicates whether DND checks are required.Boolean
dtmfTimeoutSecondsOptionalTimeout in seconds for DTMF input collection.Integer
speechTimeoutSecondsOptionalTimeout in seconds for speech input collection.Integer
externalCaseUrlTemplateOptionalURL template used for external case creation or lookup.String
ivrProcessIdOptionalUnique identifier of the associated IVR process.String
supervisorEligibleForAcwOnBargeInOptionalIndicates whether supervisors are eligible for after-call work on barge-in.Boolean
callerIdsOptionalList of caller IDs associated with the application.String
callEventWorkflowIvrIdOptionalUnique identifier of the call-event workflow IVR process.String
outboundWaitMessageOptionalMessage played while outbound calls wait to be connected.String
providerDomainOptionalDomain associated with the configured voice provider.String

Example request

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}"
  }'

Example response

{
  "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": []
}

4.2 Update a voice application

PUT /api/v3/voice/application?appId={appId}

Use this API to update an existing voice application.

Query parameters

ParameterRequired/OptionalDescriptionType
appIdRequiredUnique identifier of the voice application to update.String

Request parameters

ParameterRequired/OptionalDescriptionType
nameOptionalUpdated name of the voice application.String
phoneNumberOptionalUpdated phone number associated with the application.String
voiceAccountIdOptionalUnique identifier of the associated voice account.String
countryOptionalCountry associated with the voice application.String

Example request

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"
  }'

Example response

HTTP/1.1 204 No Content

The API does not return a response body following successful execution.

ParameterDescriptionType
HTTP Status CodeIndicates the result of the update operation.Integer
204 No ContentThe voice application was successfully updated.Status Code

4.3 Fetch ACW details

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.

Query parameters

ParameterRequired/OptionalDescriptionType
caseNumberRequiredUnique case number associated with the interaction.String
userIdRequiredUnique identifier of the user for whom ACW details are requested.String
workTypeRequiredType of work associated with the interaction.String

Example request

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'

Example response

{
  "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": []
}

Response parameters

ParameterSub-parameterDescriptionType
dataContains ACW details associated with the request.Array
idUnique identifier of the ACW record.String
acwIdUnique identifier of the ACW configuration.String
statusCurrent status of the ACW record.String
timedOutIndicates whether the ACW record timed out.Boolean
acwTriggeredAtTimestamp indicating when ACW was triggered.Epoch
typeType of ACW configuration.String
timeOutAfterDuration after which ACW times out.Integer
userIdUnique identifier of the assigned user.String
workTypeType of work associated with the ACW record.String
workIdUnique identifier of the work item.String
conversationIdUnique identifier of the conversation.String
resolvedValuesContains resolved ACW configuration details.Object
resolvedValuesacwMap containing ACW configuration details.Object
acwprocessProcess associated with the ACW configuration.Object
acwinputFormInput form associated with the ACW configuration.Object
acwoutputFormOutput form associated with the ACW configuration.Object
acwdynamicFieldsDynamic fields associated with the ACW configuration.Array
acwflavourDetailsAdditional ACW configuration details.Object
acwshareConfigsSharing configurations associated with ACW.Array<Object>
acwgrantsAccess grants associated with the ACW configuration.Array<String>
errorsContains errors encountered during request processing, if any.Array

5. Use cases

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.

5.1 Create a voice application for inbound and outbound interactions

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

5.2 Configure IVR and voice interaction settings

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

5.3 Configure DND and caller ID settings

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

5.4 Configure external case integration

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

5.5 Update an existing 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}

5.6 Fetch After Call Work details for an interaction

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}

5.7 Retrieve resolved ACW configuration details

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}

5.8 Automate the voice application configuration lifecycle

The Voice Application APIs can be incorporated into configuration and integration workflows to manage voice applications programmatically.

A typical workflow can include:

  1. Create the voice application using POST /api/v3/voice/application.
  2. Configure the required voice provider, phone number, voice account, IVR, and other supported settings.
  3. Retain the application's unique appId for subsequent configuration changes.
  4. Update the voice application using PUT /api/v3/voice/application?appId={appId} when supported application details change.
  5. Fetch ACW details using GET /api/v3/voice/acw when an integration needs After Call Work information for a specific case, user, and work type.