Simulate inbound call
Header Parameters
Bearer token used to authenticate the API request; required unless api_key is provided
Query Parameters
API key used as an alternative authentication method to Bearer tokens, primarily for FreeSWITCH mod_curl integration
Body Parameters
Unique identifier for the call session; if omitted, a UUID is auto-generated for tracking purposes
Destination phone number in E.164 format representing the called DID
Caller ID phone number in E.164 format used to simulate the inbound caller
UUID of the specific endpoint involved in the simulated inbound call
UUID of the organization initiating the call; inferred from the authenticated user's token for customer callers
Response
Successful Response
Response Attributes
Current status of the simulated call request, such as success or failure indicators
Unique identifier for the call bridge connecting participants during the simulation
SIP call identifier associated with the inbound call session for traceability
Detailed message or description elaborating on the simulation response or error information
Validation Error
Response Attributes
Detailed information or metadata related to the call simulation response