Calls

Sections

Theme switcher

Simulate inbound call

Header Parameters

Authorizationstring

Bearer token used to authenticate the API request; required unless api_key is provided

Query Parameters

api_keystring

API key used as an alternative authentication method to Bearer tokens, primarily for FreeSWITCH mod_curl integration

Body Parameters

call_uuidstring | null

Unique identifier for the call session; if omitted, a UUID is auto-generated for tracking purposes

to_numberstring Required

Destination phone number in E.164 format representing the called DID

from_numberstring

Caller ID phone number in E.164 format used to simulate the inbound caller

Default value
+15550001234
endpoint_idstring | null

UUID of the specific endpoint involved in the simulated inbound call

organization_idstring | null

UUID of the organization initiating the call; inferred from the authenticated user's token for customer callers

Response

201
Object

Successful Response

Response Attributes

statusstring

Current status of the simulated call request, such as success or failure indicators

Default value
accepted
bridge_uuidstring | null

Unique identifier for the call bridge connecting participants during the simulation

sip_call_idstring | null

SIP call identifier associated with the inbound call session for traceability

messagestring

Detailed message or description elaborating on the simulation response or error information

Default value
Test inbound call initiated
422
Object

Validation Error

Response Attributes

detailarray

Detailed information or metadata related to the call simulation response

Show child attributes

Was this section helpful?

POST

/

Select
1

Response

Was this section helpful?