3CX

PBX=https://pbx.example.com

TOKEN=$(curl -s -X POST "$PBX/connect/token" \
  -d client_id=aethex-setup \
  -d client_secret="$THREECX_API_KEY" \
  -d grant_type=client_credentials | jq -r .access_token)

# Check the token works
curl -s -G "$PBX/xapi/v1/Defs" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$select=Id'

# 1. Ask 3CX for the next free extension number
curl -s "$PBX/xapi/v1/Users/Pbx.GetFirstAvailableExtensionNumber()" \
  -H "Authorization: Bearer $TOKEN"
# { "Number": "120", ... }

# 2. Create the agent's user with that number
curl -s -X POST "$PBX/xapi/v1/Users" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Number": "120",
    "FirstName": "Aethex",
    "LastName": "Agent",
    "AuthID": "120",
    "PbxDeliversAudio": true,
    "SRTPMode": "SRTPEnabled"
  }'
# The response carries the new user's Id. Keep it as USER_ID.

# 3. Read the SIP login Aethex will use
curl -s -G "$PBX/xapi/v1/Users($USER_ID)" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$select=Number,AuthID,AuthPassword'

for ip in 13.63.135.167 51.21.123.34; do
  curl -s -X POST "$PBX/xapi/v1/Blocklist" \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d "{ \"IPAddrMask\": \"$ip\", \"BlockType\": \"Allow\", \"Description\": \"Aethex SIP edge\" }"
done

# Find the carrier trunk and the number as 3CX stores it
curl -s -G "$PBX/xapi/v1/Trunks" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$select=Id,Number,DidNumbers'

# Send calls for that number to the agent's user, at all hours
curl -s -X POST "$PBX/xapi/v1/InboundRules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "RuleName": "Aethex agent",
    "Condition": "BasedOnDID",
    "Data": "15555550100",
    "TrunkDN": { "Number": "10000" },
    "OfficeHoursDestination": { "To": "Extension", "Number": "120" },
    "OutOfOfficeHoursDestination": { "To": "Extension", "Number": "120" }
  }'

curl -s -X POST "$PBX/xapi/v1/OutboundRules" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "Aethex agent",
    "DNRanges": [{ "From": "120", "To": "120" }],
    "Routes": [{ "TrunkId": 1 }]
  }'

# Check the order: 3CX uses the first rule that matches the extension
curl -s -G "$PBX/xapi/v1/OutboundRules" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$select=Id,Name,Priority,DNRanges'

curl -X POST https://api.aethexai.com/api/v1/sip-trunks \
  -H "X-API-Key: $AETHEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "3CX agent line",
    "type": "inbound",
    "auth_mode": "register",
    "numbers": ["+15555550100"],
    "outbound_address": "pbx.example.com:5060",
    "realm": "3CXPhoneSystem",
    "auth_username": "120",
    "auth_password": "<AuthPassword from step 2>",
    "allowed_addresses": ["203.0.113.10"],
    "transport": "udp",
    "outbound_dial_format": "digits",
    "outbound_from_user": "username"
  }'

curl -X POST https://api.aethexai.com/api/v1/phone-numbers/sip/register \
  -H "X-API-Key: $AETHEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phone_number": "+15555550100",
    "trunk_id": "<id returned in step 6>",
    "agent_id": "<your-agent-id>",
    "outbound_enabled": true
  }'

# Aethex: the line logs in to 3CX within about a minute
curl -s https://api.aethexai.com/api/v1/sip-trunks/$TRUNK_ID \
  -H "X-API-Key: $AETHEX_API_KEY" | jq .registration_status
# "registered"

# 3CX: the agent's user shows as registered
curl -s -G "$PBX/xapi/v1/Users($USER_ID)" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode '$select=Number,IsRegistered'

# Outbound: the agent calls a phone through 3CX
curl -X POST https://api.aethexai.com/api/v1/calls/trigger \
  -H "X-API-Key: $AETHEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "<your-agent-id>",
    "to_number": "+15555550199",
    "from_number": "+15555550100"
  }'