A1ROUTES Blog
A1PBX REST API Documentation
REST API documentation for A1PBX
Click to Call
Endpoint
https://yourpbxdomain.com/app/api/7/originate
Method
HTTP GET
Parameter
Type
Required
Description
key
string
Yes
API key assigned to you
origination_uuid
string
Optional
You can include uuid and of your choice , useful for matching it with the webhook event related to this call
src_cid_name
string
optional
Caller ID name to be displayed for the source (originating) call.
dst_cid_name
string
optional
Caller ID name to be displayed for the destination (receiving) call.
src_cid_number
String
Yes
Caller ID number to be displayed for the source (originating) call.
des_cid_number
String
Yes
Caller ID number to be displayed for the destination (receiving) call.
src
String
Yes
Source extension number from which the call will originate.
dest
String
Yes
Destination phone number to which the call will be made.
auto_answer
Boolean
No
If set to true, the destination call will be dialed with out waiting for source to answer the call. Defaults to false.
rec
Boolean
No
If set to true, the call will be recorded. Defaults to false.
ringback
String
No
Custom ringback tone to be played while the call is being connected. Defaults to us-ring. Other options are
fr-ring
pt-ring
uk-ring
rs-ring
ru-ring
it-ring
de-ring
Example Request
https://youpbxdomain.com//app/api/7/originate?key=sdfslkjAsdf23424sdf&origination_uuid=763e7026-6c6f-472c-a520-770fb1bfa551,src_cid_name=Alice&src_cid_number=12089068227&dest_cid_name=Bod&dest_cid_number=12085551234&source=1007&destination=12085551234
Recordings
Retrieve call recordings
Endpoint
https://yourpbxdomain.com/app/api/7/call_recording
Method
HTTP GET
Parameter
Type
Required
Description
key
string
Yes
API key assigned to you
uuid
string
Yes
UUID of the call
Example Request
https://youpbxdomain.com/app/api/7/call_recording?uuid=2a2791ed-39d6-e811-9629-00e067071690&key=2342sdkjfslkXBCV