UVC Multimodal API

Multimodality API for UVC

When multimodality API is invoked, end user can submit information through a chat bot on a mobile browser while simultaneously conversing on a voice call. The following actions can be performed for a given call:

Guide user on the chat by playing the prompts over the voice.
Allows to disconnect calls.
Allows to send or stop the user's voice input to the ASR or VAD.
Override speech/dtmf no input timeout.

This API can be called multiple times. The API is added in the Integration Point in X-Platform and used through an Integration Point element in X-Designer.

Endpoint

Method: POST

URL:

Multimodal Call without Message

curl --location --request POST '
http://k8s-uniphore-uss-120f997eb0-60fdc3b24f602bf0.elb.us-east-2.amazonaws.com:9929/playMessage/callSid/9EEC91E56EBB45AEADD147E5E216FB96?speechNoInputTimeout=5&dtmfNoInputTimeout=45&discardUserInput=false&disconnectAfterPlaying=true'
\
--data ''

Multimodal Call without Message

curl --location '
http://k8s-uniphore-uss-120f997eb0-60fdc3b24f602bf0.elb.us-east-2.amazonaws.com:9929/playMessage/callSid/9EEC91E56EBB45AEADD147E5E216FB96?speechNoInputTimeout=5&dtmfNoInputTimeout=45&discardUserInput=false&disconnectAfterPlaying=true'
\
--header 'Content-Type: text/plain' \
--data 'message to play'

Header Parameter

Authorization - Bearer <Token>

Path Parameter

Parameter Name	Data Type	Description	Required/Optional
callSid	String	Call Id of the ongoing voice call.	Required

Query Parameter

Parameter Name	Data Type	Description	Required / Optional
`Request Body`	Data	The message to be played. Example: Thanks for filling the form. We will get back to you shortly.	Optional
`speechNoInputTimeout`	Integer	The amount of time (measured in seconds) that the system will wait for the user to speak during a call. For a given call, the flow admin can override the no input time out provided in the UI by entering the speechNoInputTimeout value in the API. Example: If the no input time out is set to 3 in the UI and speechNoInputTimeout is set to 8, then the bot wait for 8 seconds.	Optional
`dtmfNoInputTimeout`	Integer	The amount of time (measured in seconds) that the system will wait for the user to enter the DTMF input during a call. For a given call, the flow admin can override the no input time out provided in the UI by entering the dtmfNoInputTimeout value in the API. Example: If the no input time out is set to 3 in the UI and dtmfNoInputTimeout is set to 8, then the bot wait for 8 seconds.	Optional
`discardUserInput`	Boolean	If `discardUserInput` is set to True then the user input are not sent to ASR and VAD. The user input are not processed, even if the call continues and no input messages will not be prompted. If `discardUserInput` is set to False then the connector allows the receive voice input from user which is sent to ASR and VAD for processing.	Optional
`disconnectAfterPlaying`	Boolean	If set to True then disconnects the call after the playing the message entered in the Request Body. If there is no message in the Request Body then the multimodal call gets disconnected whenever the API is invoked. If set to False then there will be no impact to the call.	Optional

Response and Error Codes

Response Code	Condition
200	Ok
400	Bad request
401	Unauthorized

In this section:

Uniphore Customer Portal