Overview
| ENDPOINT | /admin/api/nexbro/v1/call/originate |
| Methods Supported | POST |
| Description | This endpoint is used to originate a new outbound call in the Nexbro. It allows external applications to programmatically initiate calls by providing the required source, destination, and call configuration parameters. The API responds with the call status and a unique call identifier for tracking and further actions. |
Parameters
The following parameter’s required to originate a call.
| Parameter Name | Parameter Requirement | Parameter Data Type | Example | Description |
| extension | required | Integer | 234 | The internal extension from which the call will be originated. |
| destination_number | required | String | 8556900900 | The external phone number to be dialed. |
| gateway_uuid | required | String | a8e0a4e5-16f8-421a-80d7-f147f74f8c01 | The unique identifier of the gateway through which the call will be routed. |
| caller_id_number | optional | String | 7087033114 | The caller ID number displayed to the destination party. |
Response Codes
The following response codes are returned by the API.
| HTTP CODE | Summary | Description |
| 404 | HTTP_NOT_FOUND | Returned when the specified extension is not registered or cannot be found. |
| 422 | HTTP_UNPROCESSABLE_ENTITY | Returned when the call origination request is valid but cannot be processed due to a call setup failure. |
| 200 | HTTP_OK | Returned when the call origination request is processed successfully. |
| 500 | INTERNAL_SERVER_ERROR | Returned when an unexpected error occurs on the server while processing the request. |
Example
cURL
curl -k --request POST 'https://your-nexbro-domain.com/admin/api/nexbro/v1/call/originate' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: sk_live_tTD9RQfK2q2pdsqIEIca53y3gkGll1brp0mWLMeG6vnmrDHYZ1ThOupslBHg' \
--data '{
"extension": 234,
"destination_number": "9876543210",
"gateway_uuid": "a8e0a4e5-16f8-421a-80d7-f147f74f8c01",
"caller_id_number": "8556900900"
}'
Response
{
"message": "Success.",
"data": {
"call_uuid": "3bee1179-d846-4e69-9463-11ad8b335037"
}
}