Ring a call
In order to initiate ringing on an inbound call you can use this request.
Send call ringing
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
callIdstring · uuidRequired
The ID for a call
channelIdstring · uuidRequired
The ID for a channel
Responses
202
Call Command Ringing was accepted for processing
application/json
400
The request did not pass validation
application/json
404
The request did not pass validation
application/json
422
The request did not pass validation
application/json
post
POST /workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/ringing HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"callId": "123e4567-e89b-12d3-a456-426614174000",
"callFlowId": "123e4567-e89b-12d3-a456-426614174000",
"status": "text",
"command": "text",
"conditions": [
{
"variable": "keys",
"operator": "eq",
"value": "text"
}
]
}
Example 1: Ringing an inbound call
curl -X POST "https://api.bird.com/workspaces/{workspaceId}/channels/{channelId}/calls/{callId}/ringing" \
-H "Authorization: AccessKey {your-access-key}"
Last updated
Was this helpful?