Skip to main content

Uniphore Customer Portal

Start API

The Start API end point is used to initiate the audio streaming of a specified call to a secured server. Start API is applicable for the calls that are processed through UVC.

Method

POST

URL
{uvc-service-url}:9929/streamAudio/start/callSid/{callSid}
Path Parameters

Path Parameter Name

Data Type

Description

Required/ Optional

uvc-service-url

String

The UVC service URL.

Note

Reach out to U-Self Serve engineering team to obtain the url.

Required

callSid

Number

callSid is the unique Id of the call for which voice streaming need to be initiated.

callSid is the SourceTelephonyID available in SIP Headers of UVC.

Required

Response and Error Codes

Response Code

Condition

200

Ok

The response message returns True if UVC starts streaming the audio of the call.

The response message returns False if the UVC fails to stream the audio of the call.