Initiate a call

Use this API to initiate a call to a phone number for a particular Project ID. Do note that each project ID is linked to a single number from which the call is initiated.

POST https://api.rolkol.com/api/v1/voice/placeoutboundcall/{workspaceId}/{assistantId}

HEADERS

Parameter	Type	Description
x-api-key	String	API key associated with your project	required

Path Parameter

Parameter	Type	Description
workspaceId	String	The ID associated with a workspace.	required
assistantId	String	The ID associated with an assistant.	required

Request Body Parameters

Parameter	Type	Description		Properties
fromNumber	String	The number from which the call will be placed and it should be linked to the assistant.	required
toNumber	String	The number to which the call is to be placed	required
attributes	Object	Object containing custom values that the AI should refer to. For example first name, location etc	optional	"attributes": { "customField1": "<string>", "customField2": "<string>", "customField3": "<string>" }

Response Body

Parameter	Type	Description
msg	String	Confirmation message indicating the call was placed
status	String	The status of the call
callId	String	A newly created Id for the call